SoSwitch Class |
Group node that traverses one chosen child.
Namespace: OIV.Inventor.Nodes
The SoSwitch type exposes the following members.
Name | Description | |
---|---|---|
SoSwitch | Creates a switch node with default settings. | |
SoSwitch(Int32) | Constructor that takes approximate number of children. |
Name | Description | |
---|---|---|
AddChild | Adds a child as last one in group. | |
AffectsState | Overrides method in OIV.Inventor.Nodes.SoNode to return false if there is no selected child or the selected child does not affect the state. | |
Callback | (Overrides SoGroupCallback(SoCallbackAction).) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Overrides SoGroupDoAction(SoAction).) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
FindChild | Finds index of given child within group. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Overrides SoGroupGetBoundingBox(SoGetBoundingBoxAction).) | |
GetChild | Returns pointer the child node with the given index. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMatrix | (Overrides SoGroupGetMatrix(SoGetMatrixAction).) | |
GetName | Returns the name of an instance. | |
GetNumChildren | Returns number of children. | |
GetPrimitiveCount | (Overrides SoGroupGetPrimitiveCount(SoGetPrimitiveCountAction).) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GLRender | (Overrides SoGroupGLRender(SoGLRenderAction).) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Overrides SoGroupHandleEvent(SoHandleEventAction).) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
InsertChild | Adds a child so that it becomes the one with the given index. | |
IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Overrides SoGroupPick(SoPickAction).) | |
RayPick | (Inherited from SoNode.) | |
RemoveAllChildren | Removes all children from group. | |
RemoveChild(Int32) | Removes child with given index from group. | |
RemoveChild(SoNode) | Removes first instance of given child from group. | |
ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. | |
ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. | |
Search | (Overrides SoGroupSearch(SoSearchAction).) | |
Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
Write | (Overrides SoGroupWrite(SoWriteAction).) |
Name | Description | |
---|---|---|
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
whichChild | Index of the child to traverse, or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL. |
This group node traverses exactly one, none or all of its children. It implements an operation similar to the switch statement in C. One can use this node to switch on and off the effects of some properties, to switch between different properties, to switch between different geometry or to control the visibility of geometry.
The OIV.Inventor.Nodes.SoSwitch.whichChild field specifies the index of the child to traverse, where the first child has index 0. There are several special values that can be used:
SO_SWITCH_NONE (-1, the default) means do not traverse any children.
SO_SWITCH_INHERIT (-2) allows the index to be inherited from a previously-encountered OIV.Inventor.Nodes.SoSwitch node or from certain other nodes (such as OIV.Inventor.Nodes.SoArray or OIV.Inventor.Nodes.SoMultipleCopy) that set the switch value.
SO_SWITCH_ALL (-3) traverses all children, making the switch behave exactly like a regular OIV.Inventor.Nodes.SoGroup.
There are several extended versions of this node with additional/different behavior:
OIV.Inventor.Nodes.SoInteractiveSwitch: During a user interaction, for example moving the camera, traverses a different (or no) child specified by its whichInteractiveChild field.
OIV.Inventor.Nodes.SoMultiSwitch: Traverses any number of its children (specified in a list of indices).
OIV.Inventor.Nodes.SoPathSwitch: Only traverses its children if the current path (when it is traversed) matches or contains a path specified in its path field.
OIV.Inventor.Nodes.SoMultiPathSwitch: Only traverses its children if the current path matches or contains any of the paths specified in its paths field.
NOTES:
The default value for OIV.Inventor.Nodes.SoSwitch.whichChild is SO_SWITCH_NONE, meaning that nothing is displayed by default. In most cases you will want to set some other initial value in this field.
When the value of OIV.Inventor.Nodes.SoSwitch.whichChild is SO_SWITCH_INHERIT, if the inherited value is larger than the number of children in the current node, the actual value used is "modulo" the number of children.
Some actions have an option that allows them to ignore the value of OIV.Inventor.Nodes.SoSwitch.whichChild. For example, calling setSearchingAll(true) on an OIV.Inventor.Actions.SoSearchAction causes it to traverse all the children of OIV.Inventor.Nodes.SoSwitch nodes.
OIV.Inventor.Nodes.SoSwitch is commonly used to control the visibility of a geometry. For example an application might allow the user to create multiple slices through a volume (OIV.VolumeViz.Nodes.SoOrthoSlice) or mesh (MoLogicalSlice) data set, but also allow the user to control the visibility of each slice separately. Using OIV.Inventor.Nodes.SoSwitch with SO_SWITCH_NONE is much more efficient than removing geometry from the scene graph because previously built caches are preserved. Using OIV.Inventor.Nodes.SoSwitch is also much more efficient than using draw style INVISIBLE (OIV.Inventor.Nodes.SoDrawStyle) because the children are not traversed.
This node is an OIV.Inventor.Nodes.SoGroup, not an OIV.Inventor.Nodes.SoSeparator, and therefore does not provide render caching. Generally if the children contain geometry, it is good practice to make each child an OIV.Inventor.Nodes.SoSeparator to make render caching more effective.
Switch {
whichChild | -1 |
OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoGetMatrixAction, OIV.Inventor.Actions.SoHandleEventAction, OIV.Inventor.Actions.SoRayPickAction Traverses the chosen child or children. Sets: OIV.Inventor.Elements.SoSwitchElement
OIV.Inventor.Actions.SoSearchAction If the action's Searching-All flag is set, always traverses all children. Otherwise, traverses just the chosen child or children.