SOWRAPPERKIT(3iv)

💖 SoWrapperKit(3IV) 💖

okay bestie, sit down, hydrate, because today we're talking about SoWrapperKit from section 3IV of the manuals — the wrapper nodekit class, and honestly? she's giving ✨glow-up✨ energy. 🦋

---

🌸 NAME 🌸

SoWrapperKit — the wrapper nodekit class. that's it, that's the name, she's literally just a little kit that wraps stuff. iconic. 💅

---

🧬 INHERITS FROM 🧬

the family tree is long, bestie, buckle up:

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit > SoWrapperKit

so yeah, she comes from a whole dynasty. royalty, basically. 👑

---

📜 SYNOPSIS 📜

first things first, you gotta let the compiler know she exists:

#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 💫

so. SoWrapperKit is derived from SoSeparatorKit, right? and what she adds — her whole main character moment — is the capability to wrap an arbitrary scene graph (non-nodekit, so like, the messy kind) within an SoSeparatorKit, so that it may be used along with other shape kits in a hierarchy. no cap. 🫶

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. it's giving "let me translate your chaos into my aesthetic". 💅

and since an SoWrapperKit is a class descended from SoSeparatorKit, it may be put into another SoSeparatorKit's childList. she's social like that. she fits in. 🦋

---

🧩 PARTS 🧩

• (SoTransform) localTransform — this part is an SoTransform node that is used to affect the scene graph defined in the contents part. this part is NULL by default and is automatically created if requested. she's lowkey shy until you ask. 🙈
• (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. so she will show up, she's just waiting on you, bestie. ✨

---

🛠️ METHODS 🛠️

• SoWrapperKit() — Constructor. the birth. the origin story. ⭐
• static const SoNodekitCatalog * getClassNodekitCatalog() const — returns an SoNodekitCatalog for the class SoWrapperKit. it's the blueprint, the vibe check, the whole layout. 💖
• static SoType getClassTypeId() — returns the type identifier for this class. her ID card, fr fr. 🎀

---

📚 CATALOG PARTS 📚

👑 All parts 👑

every single one, and yes they're all NULL by default. all of them. periodt.

• callbackList — part type NodeKitListPart, default type --, NULL by default: yes
• pickStyle — part type PickStyle, default type --, NULL by default: yes
• appearance — part type AppearanceKit, default type --, NULL by default: yes
• units — part type Units, default type --, NULL by default: yes
• transform — part type Transform, default type --, NULL by default: yes
• texture2Transform — part type Texture2Transform, default type --, NULL by default: yes
• childList — part type NodeKitListPart, default type --, NULL by default: yes
• localTransform — part type Transform, default type --, NULL by default: yes
• contents — part type Separator, default type --, NULL by default: yes

🌈 Extra information for list parts from the table above 🌈

the tea on the list parts specifically:

• callbackList — container type: Separator, permissible types: Callback, EventCallback
• childList — container type: Separator, permissible types: ShapeKit, SeparatorKit

---

📄 FILE FORMAT/DEFAULTS 📄

here's exactly what she looks like on paper, don't change a single character:

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 👀

go read these too, they're all in the friend group:

SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit

---

💀 reminder bestie: localTransform and contents are both NULL by default, and localTransform only gets auto-created if requested. don't come for me when your scene graph does nothing because you never asked her to build the part. 😭

---

and that's the whole page, no notes, you ate that. 🫶✨

SoWrapperKit(3IV) — that's the manual name, section 3IV, and this is the page footer energy: source SoWrapperKit(3IV), version tag (3IV)(), and no date listed on the page itself. byeee, go wrap something 💅🎀🦋