SoWrapperKit(3IV)NAMESoWrapperKit (SoWrapKit) - wrapper nodekit class
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit >
SoWrapperKitSYNOPSIS
#include <Inventor_c/nodekits/SoWrapperKit.h>
typedef SoWrapperKit SoWrapKit
Fields from class SoSeparatorKit:
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
Parts from class SoWrapperKit:
(SoTransform) localTransform
(SoSeparator) contents
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 SoWrapperKit:
SoWrapperKit * SoWrapKitCreate()
const SoNodekitCatalog * SoWrapKitGetClassNkitCat()
SoType SoWrapKitGetClassTypeId()
Functions from class SoBaseKit:
const SoNodekitCatalog * SoWrapKitGetCat(const SoWrapKit *this)
SoNode * SoWrapKitGetPart(SoWrapKit *this, const char
*partName, SbBool makeIfNeeded)
SbString SoWrapKitGetPartString(SoWrapKit *this, const
SoBase *part)
SoNodeKitPath * SoWrapKitCreatePathToPart(SoWrapKit *this,
const char *partName, SbBool makeIfNeeded,
Page 1SoWrapperKit(3IV)
const SoPath *pathToExtend = NULL)
SbBool SoWrapKitSetPart(SoWrapKit *this, const char
*partName, SoNode *newPart)
SbBool SoWrapKitSet(SoWrapKit *this, char *partName,
char *parameters)
SbBool SoWrapKitSet2(SoWrapKit *this, char
*nameValuePairs)
SbBool SoWrapKitIsSearchingChildren()
void SoWrapKitSetSearchingChildren(SbBool newVal)
Functions from class SoNode:
void SoWrapKitSetOverride(SoWrapKit *this, SbBool state)
SbBool SoWrapKitIsOverride(const SoWrapKit *this)
SoNode * SoWrapKitCopy(const SoWrapKit *this, SbBool
copyConnections = FALSE)
SbBool SoWrapKitAffectsState(const SoWrapKit *this)
SoNode * SoWrapKitGetByName(const char *name)
int SoWrapKitGetByNameList(const char *name, SoNodeList
*list)
Functions from class SoFieldContainer:
void SoWrapKitSetToDflts(SoWrapKit *this)
SbBool SoWrapKitHasDfltVals(const SoWrapKit *this)
SbBool SoWrapKitFldsAreEq(const SoWrapKit *this, const
SoFieldContainer *fc)
void SoWrapKitCopyFieldVals(SoWrapKit *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
void SoWrapKitGet(SoWrapKit *this, SbString
*fieldDataString)
int SoWrapKitGetFields(const SoWrapKit *this, SoFieldList
*resultList)
SoField * SoWrapKitGetField(const SoWrapKit *this, const char
*fieldName)
SbBool SoWrapKitGetFieldName(const SoWrapKit *this, const
SoField *field, SbName *fieldName)
SbBool SoWrapKitIsNotifyEnabled(const SoWrapKit *this)
SbBool SoWrapKitEnableNotify(SoWrapKit *this, SbBool flag)
Functions from class SoBase:
void SoWrapKitRef(SoWrapKit *this)
void SoWrapKitUnref(const SoWrapKit *this)
void SoWrapKitUnrefNoDelete(const SoWrapKit *this)
void SoWrapKitTouch(SoWrapKit *this)
SoType SoWrapKitGetTypeId(const SoWrapKit *this)
SbBool SoWrapKitIsOfType(const SoWrapKit *this, SoType type)
void SoWrapKitSetName(SoWrapKit *this, const char *name)
SbName SoWrapKitGetName(const SoWrapKit *this)
Page 2SoWrapperKit(3IV)DESCRIPTIONSoWrapperKit is derived from SoSeparatorKit. It adds the capability to
wrap an arbitrary scene graph, (non-nodekit), within an SoSeparatorKit,
so that it may be used along with other shape kits in a hierarchy. There
are two additional parts included in SoWrapperKit: localTransform and
contents.
The part contents is an SoSeparator node beneath which any arbitrary
scene graph can be added. This is especially useful for importing scene
graphs of unknown structure (non-nodekits) into nodekit format.
Since an SoWrapperKit is a class descended from SoSeparatorKit, it may be
put into another SoSeparatorKit's childList.
PARTS
(SoTransform) localTransform
This part is an SoTransform node that is used to affect the scene
graph defined in contents part. This part is NULL by default and is
automatically created if requested.
(SoSeparator) contents
This part is an SoSeparator node that contains a user-supplied scene
graph. This scene graph can contain any nodes. This part is NULL by
default and an SoSeparator is automatically created if the user asks
the nodekit to build the part.
FUNCTIONSSoWrapperKit * SoWrapKitCreate()
Constructor.
const SoNodekitCatalog * SoWrapKitGetClassNkitCat()
Returns an SoNodekitCatalog for the class SoWrapperKit.
SoType SoWrapKitGetClassTypeId()
Returns type identifier for this class.
CATALOG PARTSPage 3SoWrapperKit(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
localTransform Transform -- yes
contents Separator -- 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
WrapperKit {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
callbackList NULL
pickStyle NULL
appearance NULL
units NULL
transform NULL
texture2Transform NULL
childList NULL
localTransform NULL
contents NULL
}
SEE ALSO
SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit,
SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog,
SoSceneKit, SoSeparatorKit, SoShapeKit
Page 4
