SoSeparatorKit Class Reference
[NodeKits]
Separator nodekit class. More...
#include <Inventor/nodekits/SoSeparatorKit.h>
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 SoNodekitCatalog * | getNodekitCatalog () const |
| SoSeparatorKit () | |
| virtual SbBool | affectsState () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
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
(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 {
| renderCaching | AUTO |
| 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 Name | Part Type | Default Type | NULL 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 Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
SEE ALSO
SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoShapeKit, SoWrapperKit
Member Enumeration Documentation
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:
- Inventor/nodekits/SoSeparatorKit.h