SoSeparatorKit Class Reference
[NodeKits]

Separator nodekit class. More...

#include <Inventor/nodekits/SoSeparatorKit.h>

Inheritance diagram for SoSeparatorKit:
SoBaseKit SoNode SoGetView SoFieldContainer SoBase SoRefCounter SoTypedObject SoShapeKit SoWrapperKit

List of all members.

Public Types

enum  CacheEnabled {
  OFF = SO_RENDERCACHING_OFF,
  ON = SO_RENDERCACHING_ON,
  AUTO = SO_RENDERCACHING_AUTO
}

Public Member Functions

virtual SoType getTypeId () const
virtual const SoNodekitCataloggetNodekitCatalog () const
 SoSeparatorKit ()
virtual SbBool affectsState () const

Static Public Member Functions

static SoType getClassTypeId ()
static const SoNodekitCataloggetClassNodekitCatalog ()

Public Attributes

SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling

Detailed Description

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.

For example:

    myMtl = mySepKit->getPart("material",TRUE)

and

    mySepKit->setPart("material",myMtl)

See SoBaseKit for further explanation.

PARTS

FILE FORMAT/DEFAULT

CATALOG PARTS

SEE ALSO

SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoShapeKit, SoWrapperKit


Member Enumeration Documentation

Possible values for caching.

Enumerator:
OFF 

Never build or use a cache.

ON 

Always try to build a cache.

AUTO 

Automatic caching.


Constructor & Destructor Documentation

SoSeparatorKit::SoSeparatorKit (  ) 

Constructor.


Member Function Documentation

virtual SbBool SoSeparatorKit::affectsState (  )  const [virtual]

Returns TRUE if a node has an effect on the state during traversal.

The default method returns TRUE. Node classes (such as SoSeparator) that isolate their effects from the rest of the graph override this method to return FALSE.

Reimplemented from SoNode.

static const SoNodekitCatalog* SoSeparatorKit::getClassNodekitCatalog (  )  [static]

Returns the SoNodekitCatalog for this class.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

static SoType SoSeparatorKit::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

virtual const SoNodekitCatalog* SoSeparatorKit::getNodekitCatalog (  )  const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

virtual SoType SoSeparatorKit::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.


Member Data Documentation

Set bounding box caching mode.

Use enum CacheEnabled. Default is ON. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.

Set pick culling mode.

Use enum CacheEnabled. Default is AUTO.

Set render caching mode.

Use enum CacheEnabled. Default is AUTO.

Set render culling mode.

Use enum CacheEnabled. Default is OFF. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 10 Dec 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/