Provided by: inventor-doc_2.1.5-10-18_all bug

NAME

       SoWrapperKit — wrapper nodekit class

INHERITS FROM

       SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit > SoWrapperKit

SYNOPSIS

       #include <Inventor/nodekits/SoWrapperKit.h>

          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

          Methods from class SoWrapperKit:

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

          Methods from class SoBaseKit:

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

          Methods from class SoNode:

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

          Methods from class SoFieldContainer:

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

          Methods from class SoBase:

     void                ref()
     void                unref() const
     void                unrefNoDelete() const
     void                touch()
     virtual SoType      getTypeId() const
     SbBool              isOfType(SoType type) const
     virtual void        setName(const SbName &name)
     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)       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.

METHODS

                         SoWrapperKit()
          Constructor.

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

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

CATALOG PARTS

       ┌───────────────────────────────────────────────────────────────┐
       │                          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              │
       │                                                               │
       │callbackList   Separator        Callback, EventCallback        │
       │childList      Separator        ShapeKit, 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

                                                                              SoWrapperKit(3IV)()