SoPathSwitch(3iv)

1SoPathSwitch(3IV)()                                        SoPathSwitch(3IV)()
2
3
4

NAME

6       SoPathSwitch  —  group  node that traverses only when traversed along a
7       given path
8

INHERITS FROM

10       SoBase > SoFieldContainer > SoNode > SoGroup > SoPathSwitch
11

SYNOPSIS

13       #include <Inventor/nodes/SoPathSwitch.h>
14
15          Fields from class SoPathSwitch:
16
17     SoSFPath            path
18
19          Methods from class SoPathSwitch:
20
21                         SoPathSwitch()
22                         SoPathSwitch(int nChildren)
23     static SoType       getClassTypeId()
24
25          Methods from class SoGroup:
26
27     void                addChild(SoNode *child)
28     void                insertChild(SoNode *child, int newChildIndex)
29     SoNode *            getChild(int index) const
30     int                 findChild(const SoNode *child) const
31     int                 getNumChildren() const
32     void                removeChild(int index)
33     void                removeChild(SoNode *child)
34     void                removeAllChildren()
35     void                replaceChild(int index, SoNode *newChild)
36     void                replaceChild(SoNode *oldChild, SoNode *newChild)
37
38          Methods from class SoNode:
39
40     void                setOverride(SbBool state)
41     SbBool              isOverride() const
42     SoNode *            copy(SbBool copyConnections = FALSE) const
43     virtual SbBool      affectsState() const
44     static SoNode *     getByName(const SbName &name)
45     static int          getByName(const SbName &name, SoNodeList &list)
46
47          Methods from class SoFieldContainer:
48
49     void                setToDefaults()
50     SbBool              hasDefaultValues() const
51     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
52     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
53                              copyConnections = FALSE)
54     SbBool              set(const char *fieldDataString)
55     void                get(SbString &fieldDataString)
56     virtual int         getFields(SoFieldList &resultList) const
57     virtual SoField *   getField(const SbName &fieldName) const
58     SbBool              getFieldName(const SoField *field, SbName &fieldName)
59                              const
60     SbBool              isNotifyEnabled() const
61     SbBool              enableNotify(SbBool flag)
62
63          Methods from class SoBase:
64
65     void                ref()
66     void                unref() const
67     void                unrefNoDelete() const
68     void                touch()
69     virtual SoType      getTypeId() const
70     SbBool              isOfType(SoType type) const
71     virtual void        setName(const SbName &name)
72     virtual SbName      getName() const
73
74

DESCRIPTION

76       SoPathSwitch is a group node that traverses its children  only  if  the
77       current  traversal  path matches the SoPath in the path field. This can
78       be used, for example, to affect only one instance of  a  subgraph.  The
79       path  field  contains  the  path  up to (but not including) the SoPath‐
80       Switch. The path need not go all the way back to the root; if  it  does
81       not,  then  only  the number of ancestors that are in the path are com‐
82       pared to see if the children should be traversed.  A  NULL  path  means
83       that the children are never traversed.
84

FIELDS

86     SoSFPath            path
87          The path that must match the current traversal path.
88
89

METHODS

91                         SoPathSwitch()
92          Creates a path switch node with default settings.
93
94                         SoPathSwitch(int nChildren)
95          Constructor that takes approximate number of children.
96
97     static SoType       getClassTypeId()
98          Returns type identifier for this class.
99
100

ACTION BEHAVIOR

102       SoGLRenderAction,  SoCallbackAction, SoGetBoundingBoxAction, SoRayPick‐
103       Action, SoHandleEventAction
104          Traverses the children if the paths match.
105
106

FILE FORMAT/DEFAULTS

108       PathSwitch {
109          path  NULL
110     }
111