SoSeparatorKit(3IV)NAMESoSeparatorKit (SoSepKit) - separator nodekit class
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKitSYNOPSIS
#include <Inventor_c/nodekits/SoSeparatorKit.h>
typedef SoSeparatorKit SoSepKit
enum SoSeparatorKitCacheEnabled {
SO_SEP_KIT_OFF Never build or use a cache
SO_SEP_KIT_ON Always try to build a cache
SO_SEP_KIT_AUTO Automatic caching
}
Fields from class SoSeparatorKit:
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
Parts from class SoSeparatorKit:
(SoPickStyle) pickStyle
(SoAppearanceKit) appearance
(SoUnits) units
(SoTransform) transform
(SoTexture2Transform) texture2Transform
(SoNodeKitListPart) childList
Parts from class SoBaseKit:
(SoNodeKitListPart) callbackList
Functions from class SoSeparatorKit:
SoSeparatorKit * SoSepKitCreate()
const SoNodekitCatalog * SoSepKitGetClassNkitCat()
SoType SoSepKitGetClassTypeId()
Functions from class SoBaseKit:
const SoNodekitCatalog * SoSepKitGetCat(const SoSepKit *this)
SoNode * SoSepKitGetPart(SoSepKit *this, const char
*partName, SbBool makeIfNeeded)
SbString SoSepKitGetPartString(SoSepKit *this, const
SoBase *part)
SoNodeKitPath * SoSepKitCreatePathToPart(SoSepKit *this, const
char *partName, SbBool makeIfNeeded, const
Page 1SoSeparatorKit(3IV)
SoPath *pathToExtend = NULL)
SbBool SoSepKitSetPart(SoSepKit *this, const char
*partName, SoNode *newPart)
SbBool SoSepKitSet(SoSepKit *this, char *partName,
char *parameters)
SbBool SoSepKitSet2(SoSepKit *this, char
*nameValuePairs)
SbBool SoSepKitIsSearchingChildren()
void SoSepKitSetSearchingChildren(SbBool newVal)
Functions from class SoNode:
void SoSepKitSetOverride(SoSepKit *this, SbBool state)
SbBool SoSepKitIsOverride(const SoSepKit *this)
SoNode * SoSepKitCopy(const SoSepKit *this, SbBool
copyConnections = FALSE)
SbBool SoSepKitAffectsState(const SoSepKit *this)
SoNode * SoSepKitGetByName(const char *name)
int SoSepKitGetByNameList(const char *name, SoNodeList
*list)
Functions from class SoFieldContainer:
void SoSepKitSetToDflts(SoSepKit *this)
SbBool SoSepKitHasDfltVals(const SoSepKit *this)
SbBool SoSepKitFldsAreEq(const SoSepKit *this, const
SoFieldContainer *fc)
void SoSepKitCopyFieldVals(SoSepKit *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
void SoSepKitGet(SoSepKit *this, SbString
*fieldDataString)
int SoSepKitGetFields(const SoSepKit *this, SoFieldList
*resultList)
SoField * SoSepKitGetField(const SoSepKit *this, const char
*fieldName)
SbBool SoSepKitGetFieldName(const SoSepKit *this, const
SoField *field, SbName *fieldName)
SbBool SoSepKitIsNotifyEnabled(const SoSepKit *this)
SbBool SoSepKitEnableNotify(SoSepKit *this, SbBool flag)
Functions from class SoBase:
void SoSepKitRef(SoSepKit *this)
void SoSepKitUnref(const SoSepKit *this)
void SoSepKitUnrefNoDelete(const SoSepKit *this)
void SoSepKitTouch(SoSepKit *this)
SoType SoSepKitGetTypeId(const SoSepKit *this)
SbBool SoSepKitIsOfType(const SoSepKit *this, SoType type)
void SoSepKitSetName(SoSepKit *this, const char *name)
SbName SoSepKitGetName(const SoSepKit *this)
Page 2SoSeparatorKit(3IV)DESCRIPTION
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 = SoSepKitGetPart(mySepKit,"material",TRUE)
and
SoSepKitSetPart(mySepKit,"material",myMtl)
See SoBaseKit for further explanation.
FIELDS
SoSFEnum renderCaching
Set render caching mode. Default is AUTO.
SoSFEnum boundingBoxCaching
Set bounding box caching mode. Default is ON. Setting this value to
AUTO is equivalent to ON - automatic culling is not implemented.
SoSFEnum renderCulling
Set render culling mode. Default is OFF. Setting this value to AUTO
is equivalent to ON - automatic culling is not implemented.
SoSFEnum pickCulling
Set pick culling mode. Default is AUTO.
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.
Page 3SoSeparatorKit(3IV)
(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:
SoSepKitGetPart(mySepKit, "childList[0]", TRUE), the separator kit
will create the childList and add an SoShapeKit as the new element
in the list.
FUNCTIONSSoSeparatorKit * SoSepKitCreate()
Constructor.
const SoNodekitCatalog * SoSepKitGetClassNkitCat()
Returns an SoNodekitCatalog for the class SoSeparatorKit.
SoType SoSepKitGetClassTypeId()
Returns type identifier for this class.
CATALOG PARTSPage 4SoSeparatorKit(3IV)
________________________________________________________________
All parts
NULL by
Part Name Part Type Default Type 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 Permissible Types
Callback, EventCallback
callbackList Separator
ShapeKit, SeparatorKit
childList Separator
________________________________________________________________
|
|
FILE FORMAT/DEFAULTS
SeparatorKit {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
callbackList NULL
pickStyle NULL
appearance NULL
units NULL
transform NULL
texture2Transform NULL
childList NULL
}
SEE ALSO
SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit,
SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog,
SoSceneKit, SoShapeKit, SoWrapperKit
Page 5
