Package com.openinventor.inventor.nodekits

Class SoSeparatorKit

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.nodekits.SoBaseKit
com.openinventor.inventor.nodekits.SoSeparatorKit
All Implemented Interfaces:
SafeDisposable
Direct Known Subclasses:
SoShapeKit, SoWrapperKit
public class SoSeparatorKit extends SoBaseKit
Separator nodekit class. A nodekit that is used for creating nodekit hierarchies. SoSeparatorKit contains a transform part, a childList part, and a few others in its catalog. The transform part (an SoTransform node) affects all of the children in the childList. Each of these children must be an SoSeparatorKit or from a class that is derived from SoSeparatorKit (e.g., SoShapeKit and SoWrapperKit). Since all members of the childList are in turn SoSeparatorKits, and each contains a transform , these nested lists allow you to create a hierarchy of motion, in which each transform affects an entire subgraph of nodekits.

The other parts added to the catalog for the SoSeparatorKit are pickStyle , appearance , units and texture2Transform . Furthermore, since SoSeparator is derived from SoBaseKit, it inherits the callbackList part. This is a list of SoCallback and/or SoEventCallback nodes which enable the SoSeparatorKit to perform special callbacks whenever an action is applied to it.

By creating the pickStyle part, a user can alter the pick style for the entire nodekit hierarchy. The appearance part is an SoAppearanceKit nodekit. Note that all parts contained in the SoAppearanceKit catalog can be accessed as if they were part of the SoSeparatorKit.

See SoBaseKit for further explanation.

PARTS

(SoPickStyle) pickStyle
An SoPickStyle property node that can be used to set the picking style of its children. This part is NULL by default, but is created automatically if necessary.

(SoAppearanceKit) appearance
An SoAppearanceKit nodekit which can be used to set the appearance properties of its children. This part is NULL by default, but is created automatically if necessary.

(SoUnits) units
An SoUnits node which can be used to set the types of units, (e.g., feet), of its children. This part is NULL by default, but is created automatically if necessary.

(SoTransform) transform
An SoTransform node which can be used to set the overall position, orientation, and scale of its children. This part is NULL by default, but is created automatically if necessary.

(SoTexture2Transform) texture2Transform
An SoTexture2Transform node which can be used to apply a transformation to any textures used by its children. This part is NULL by default, but is created automatically if necessary.

(SoNodeKitListPart) childList
This part contains the children nodekits of this SoSeparatorKit. This part is a list part and can have multiple children. This part is NULL by default, but is created automatically when the first child is added to the childList. Also, when asked to build a member of the childList, the separatorKit will build an SoShapeKit by default. So if the childList part is NULL, and you call: getPart("childList[0]", true), the separator kit will create the childList and add an SoShapeKit as the new element in the list.

File format/default:

SeparatorKit {

    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    callbackList NULL
    pickStyle NULL
    appearance NULL
    units NULL
    transform NULL
    texture2Transform NULL
    childList NULL
}

CATALOG PARTS

All Parts

    Part NamePart TypeDefault TypeNULL Default
    callbackList NodeKitListPart yes
    pickStyle PickStyle yes
    appearance AppearanceKit yes
    units Units yes
    transform Transform yes
    texture2Transform Texture2Transform yes
    childList NodeKitListPart yes

Extra Information for List Parts from Above Table

    Part NameContainer TypePossible Types
    callbackList Separator Callback, EventCallback

See Also:

  • Field Details

    • renderCaching

      @Deprecated(since="10.3.0.0") public final SoSFEnum<SoSeparatorKit.Cachings> renderCaching
      Deprecated.
      As of Open Inventor 10.3.0.0. This field is ignored. Render caching is set internally to ensure best performance.
      Set render caching mode. . Default is AUTO.

      Warning Deprecated since Open Inventor 10300. This field is ignored. Render caching is set internally to ensure best performance.

    • boundingBoxCaching

      public final SoSFEnum<SoSeparatorKit.Cachings> boundingBoxCaching
      Set bounding box caching mode. . Default is ON. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.

    • renderCulling

      public final SoSFEnum<SoSeparatorKit.Cachings> renderCulling
      Set render culling mode. . Default is OFF. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.

    • pickCulling

      public final SoSFEnum<SoSeparatorKit.Cachings> pickCulling
      Set pick culling mode. . Default is AUTO.

  • Constructor Details

    • SoSeparatorKit

      public SoSeparatorKit()
      Constructor.

  • Method Details