Inventor/VRMLnodes/SoVRMLSwitch.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
** Modified by : Nick Thompson (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/


#ifndef  _SO_VRMLSWITCH_
#define  _SO_VRMLSWITCH_

#include <Inventor/VRMLnodes/SoVRMLParent.h>
#include <Inventor/misc/SoChildList.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoMFNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/nodes/SoNode.h>


#if defined(OIV_IGNORE_VRML_DEPRECATED)
  #include <SoDeprecationRules.h>
  #pragma push_macro("SoDEPRECATED_CLASS")
  #pragma push_macro("SoDEPRECATED_TYPEDEF")
  #undef SoDEPRECATED_CLASS
  #undef SoDEPRECATED_TYPEDEF
  #define SoDEPRECATED_CLASS(x,y)
  #define SoDEPRECATED_TYPEDEF(x,y)
#endif

#define SO_SWITCH_NONE          (-1)

#define SO_SWITCH_INHERIT       (-2)

#define SO_SWITCH_ALL           (-3)
class SoDEPRECATED  SoVRMLSwitch : public SoVRMLParent {

  SO_NODE_HEADER(SoVRMLSwitch);

 public:
  // Fields
  SoMFNode            choice;
  SoSFInt32           whichChoice;
  SoVRMLSwitch();

  SoVRMLSwitch(int nChoices);

  virtual SbBool      affectsState() const;

  void                addChoice(SoNode *choice1);

  void                insertChoice(SoNode *choice1, int newLevelIndex);

  SoNode *            getChoice(int index) const;

  int                 findChoice(const SoNode *choice1) const;

  int                 getNumChoices() const;

  void                removeChoice(int index);

  void                removeChoice(SoNode *choice1)
    { removeChoice(findChoice(choice1)); }

  void                removeAllChoices();

  void                replaceChoice(int index, SoNode *newChoice);

  void                replaceChoice(SoNode *oldChoice, SoNode *newChoice)
    { replaceChoice(findChoice(oldChoice), newChoice); }

 private:
  // Implement actions
  virtual void        doAction(SoAction *action);
  virtual void        callback(SoCallbackAction *action);
  virtual void        GLRender(SoGLRenderAction *action);
  virtual void        pick(SoPickAction *action);
  virtual void        getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void        handleEvent(SoHandleEventAction *action);
  virtual void        getMatrix(SoGetMatrixAction *action);
  virtual void        search(SoSearchAction *action);
  virtual void        write(SoWriteAction *action);

 private:
  static void         initClass();
  static void         exitClass();

  // Adds a child as last one in group
  void                addChild(SoNode *child);

  // Adds a child so that it becomes the one with the given index
  void                insertChild(SoNode *child, int newChildIndex);

  // Returns pointer to nth child node
  SoNode *            getChild(int index) const;

  // Finds index of given child within group
  int                 findChild(const SoNode *child) const;

  // Returns number of children
  int                 getNumChildren() const;

  // Removes child with given index from group
  void                removeChild(int index);

  // Removes first instance of given child from group
  void                removeChild(SoNode *child)
    { removeChild(findChild(child)); }

  // Removes all children from group
  void                removeAllChildren();

  // Replaces child with given index with new child
  void                replaceChild(int index, SoNode *newChild);

  // Replaces first instance of given child with new child
  void                replaceChild(SoNode *oldChild, SoNode *newChild)
    { replaceChild(findChild(oldChild), newChild); }

  // Copies the contents of the given node into this instance
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);

  virtual bool affectsPath() const;

 private:
  SoMFNode  addChildren;     //eventIn
  SoMFNode  removeChildren;  //eventIn
  void      processAddChildren();
  void      processRemoveChildren();

  virtual ~SoVRMLSwitch();
  virtual void        notify(SoNotList *);
  virtual SbBool      readInstance(SoInput *in, unsigned short flags);
  int internalSetValue;

 private:

  // Traverses correct child. If matchIndex >=0, child index must match
  void                doChild(SoAction *action, int matchIndex = -1);
};



#if defined(OIV_IGNORE_VRML_DEPRECATED)
  #pragma pop_macro("SoDEPRECATED_TYPEDEF")
  #pragma pop_macro("SoDEPRECATED_CLASS")
#endif

#endif /* _SO_VRMLSWITCH_ */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/