Package com.openinventor.inventor.nodes

Class SoInteractiveSwitch

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.inventor.nodes.SoGroup
com.openinventor.inventor.nodes.SoSwitch
com.openinventor.inventor.nodes.SoInteractiveSwitch
All Implemented Interfaces:
SafeDisposable
public class SoInteractiveSwitch extends SoSwitch
Group node that traverses one chosen child depending on scene interaction. This group node has the same base behavior as the 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 SoDragger), for example dragging a slice through a volume data set.

The 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 whichInteractiveChild field, and when interaction is stopped, the standard 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 SoGroup, NOT an SoSeparator, and therefore does not provide render caching. Generally if the children contain geometry, it is good practice to make each child an SoSeparator to make render caching more effective.

File format/default:

InteractiveSwitch {

    whichChild -1
    whichInteractiveChild -1
}

Action behavior:

inherited from SoSwitch. While interacting, traverses the chosen (from whichInteractiveChild) child or children. Sets: SoInteractiveSwitchElement. While not interacting, traverses the chosen (from whichChild) child or children. Sets: SoSwitchElement.

See Also:

  • Field Details

    • whichInteractiveChild

      public final SoSFInt32 whichInteractiveChild
      Index of the child to traverse during interaction, (or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL).

  • Constructor Details

    • SoInteractiveSwitch

      public SoInteractiveSwitch(int nChildren)
      Constructor that takes approximate number of children.

    • SoInteractiveSwitch

      public SoInteractiveSwitch()
      Creates an interactive-switch node with default settings.