GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOWRAPPERKIT (3)

NAME

SoWrapperKit — wrapper nodekit class

CONTENTS

Inherits From
Synopsis
Description
Parts
Methods
Catalog Parts
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit > SoWrapperKit

SYNOPSIS

#include <Inventor/nodekits/SoWrapperKit.h>

Fields from class SoSeparatorKit:

    SoSFEnum    
                    
SoSFEnum             renderCaching    
SoSFEnum    
                    
SoSFEnum             boundingBoxCaching    
SoSFEnum    
                    
SoSFEnum             renderCulling    
SoSFEnum    
                    
SoSFEnum             pickCulling

Parts from class SoWrapperKit:

    (SoTransform)    
                    
(SoTransform)        localTransform    
(SoSeparator)    
                    
(SoSeparator)        contents

Parts from class SoSeparatorKit:

    (SoPickStyle)    
                       
(SoPickStyle)           pickStyle    
(SoAppearanceKit)    
                       
(SoAppearanceKit)       appearance    
(SoUnits)    
                       
(SoUnits)               units    
(SoTransform)    
                       
(SoTransform)           transform    
(SoTexture2Transform)    
                       
(SoTexture2Transform)   texture2Transform    
(SoNodeKitListPart)    
                       
(SoNodeKitListPart)     childList

Parts from class SoBaseKit:

    (SoNodeKitListPart)    
                     
(SoNodeKitListPart)   callbackList

Methods from class SoWrapperKit:

       
                    
                     SoWrapperKit()    
static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const    
static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoBaseKit:

    virtual const SoNodekitCatalog *    
                         
virtual const SoNodekitCatalog * getNodekitCatalog() const    
virtual SoNode *    
                         
virtual SoNode *          getPart(const SbName &partName, SbBool makeIfNeeded)    
SbString    
                         
SbString                  getPartString(const SoBase *part)    
virtual SoNodeKitPath *    
                         
virtual SoNodeKitPath *   createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)    
virtual SbBool    
                         
virtual SbBool            setPart(const SbName &partName, SoNode *newPart)    
SbBool    
                         
SbBool                    set(char *partName, char *parameters)    
SbBool    
                         
SbBool                    set(char *nameValuePairs)    
static SbBool    
                         
static SbBool             isSearchingChildren()    
static void    
                         
static void               setSearchingChildren(SbBool newVal)

Methods from class SoNode:

    void    
                    
void                 setOverride(SbBool state)    
SbBool    
                    
SbBool               isOverride() const    
SoNode *    
                    
SoNode *             copy(SbBool copyConnections = FALSE) const    
virtual SbBool    
                    
virtual SbBool       affectsState() const    
static SoNode *    
                    
static SoNode *      getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoNodeList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

Macros from class SoBaseKit:

SO_GET_PART(kit, partName, partClass)
                    
SO_CHECK_PART(kit, partName, partClass)
                    

DESCRIPTION

SoWrapperKit 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)    
                    
(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)    
                    
(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.

METHODS

       
                    
                     SoWrapperKit()
Constructor.

    static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const
Returns an SoNodekitCatalog for the class SoWrapperKit.

    static SoType    
                    
static SoType        getClassTypeId()
Returns type identifier for this class.

CATALOG PARTS

All parts
   NULL by
Part NamePart TypeDefault TypeDefault
callbackListNodeKitListPart--yes
pickStylePickStyle--yes
appearanceAppearanceKit--yes
unitsUnits--yes
transformTransform--yes
texture2TransformTexture2Transform--yes
childListNodeKitListPart--yes
localTransformTransform--yes
contentsSeparator--yes

Extra information for list parts from above table
Part NameContainer TypePermissible Types 
callbackListSeparatorCallback, EventCallback
childListSeparatorShapeKit, SeparatorKit

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

Search for    or go to Top of page |  Section 3 |  Main Index


SOWRAPPERKIT(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.