| SoInteractiveSwitch Class |
Group node that traverses one chosen child depending on scene interaction.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.Inventor.NodesSoSwitch
OIV.Inventor.NodesSoInteractiveSwitch
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoInteractiveSwitch type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoInteractiveSwitch | Creates an interactive-switch node with default settings. |
| SoInteractiveSwitch(Int32) | Constructor that takes approximate number of children. |
Methods| Name | Description | |
|---|---|---|
| AddChild | Adds a child as last one in group. |
| AffectsState | Overrides method in OIV.Inventor.Nodes.SoSwitch to return false if there is no selected child or the selected child does not affect the state. |
| Callback | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetPrimitiveCount | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
| 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 | (Inherited from SoSwitch.) |
Properties| 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. |
| whichInteractiveChild | Index of the child to traverse during interaction, (or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL). |
RemarksThis group node has the same base behavior as the OIV.Inventor.Nodes.SoSwitch node for its inherited whichChild field.
It has the additional feature of (optionally) traversing a different (or no) child during an "interaction". This allows the application to provide higher performance during an interaction by switching to a less complex version of a geomtry or not rendering the geometry at all. Interaction includes moving the camera (navigating around the scene) and interacting with a dragger (see OIV.Inventor.Draggers.SoDragger), for example dragging a slice through a volume data set.
The OIV.Inventor.Nodes.SoInteractiveSwitch.whichInteractiveChild field specifies the index of the child to traverse (where the first child has index 0), when a user interaction, for example moving the camera, is in progress. This means that while the camera is moving, the traversed children will be the children defined by the OIV.Inventor.Nodes.SoInteractiveSwitch.whichInteractiveChild field, and when interaction is stopped, the standard OIV.Inventor.Nodes.SoSwitchwhichChild field value will again be used as the index to traverse.
NOTES:
Remember that the default value for both whichChild and whichInteractiveChild is SO_SWITCH_NONE, meaning that nothing is displayed by default.
Remember that 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.
FILE FORMAT/DEFAULT
InteractiveSwitch {
| whichChild | -1 |
| whichInteractiveChild | -1 |
ACTION BEHAVIOR
inherited from OIV.Inventor.Nodes.SoSwitch. While interacting, traverses the chosen (from OIV.Inventor.Nodes.SoInteractiveSwitch.whichInteractiveChild) child or children. Sets: OIV.Inventor.Elements.SoInteractiveSwitchElement. While not interacting, traverses the chosen (from whichChild) child or children. Sets: OIV.Inventor.Elements.SoSwitchElement.
See Also