SoWrapperKit(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoWrapperKit 💖 (Coin manual, section 3)

okay bestie, settle in 🫶 this is the SoWrapperKit(3) page from the Coin docs, and it is long, so it's split across multiple parts — you're reading part 1 right now, and more parts are coming, so don't you dare scroll away 💅

✨ NAME ✨

SoWrapperKit — bestie, the SoWrapperKit class is a simple kit for wrapping a transform and a subgraph. that's the whole job. iconic, focused, no notes 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/nodekits/SoWrapperKit.h>

Inherits SoSeparatorKit. so yes, everything SoSeparatorKit can do, this one can do too — it's giving inheritance, it's giving nepo baby but make it C++ 🌸

🌟 Public Member Functions 🌟

  • virtual SoType getTypeId (void) const — the type-id getter, but for this instance's actual class ✨
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog for this instance 🎀
  • SoWrapperKit (void) — the constructor, the origin story, the birth 💖

🫶 Public Member Functions inherited from SoSeparatorKit 🫶

  • SoSeparatorKit (void) — yep, the parent constructor 💜

🦋 Public Member Functions inherited from SoBaseKit 🦋

  • SoBaseKit (void) — grandparent constructor energy 🌈
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded) — grab a part by name, and optionally make it if it isn't there yet ✨
  • SbString getPartString (const SoBase *part) — turn a part into a string, name-wise 🎀
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) — build a path that leads to a part 💅
  • virtual SbBool setPart (const SbName &partname, SoNode *from) — set a part by name 🫶
  • SbBool set (const char *namevaluepairliststring) — set stuff from a name/value pair string 🌸
  • SbBool set (const char *partnamestring, const char *parameterstring) — set a part using a part-name string and a parameter string 💖
  • virtual void doAction (SoAction *action) — run the action 👑
  • virtual void callback (SoCallbackAction *action) — the callback-action hook 🔥
  • virtual void GLRender (SoGLRenderAction *action) — render it, render it 💅
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box action hook 🦋
  • virtual void getMatrix (SoGetMatrixAction *action) — matrix action hook ⭐
  • virtual void handleEvent (SoHandleEventAction *action) — event handling hook 🎀
  • virtual void rayPick (SoRayPickAction *action) — ray pick hook ✨
  • virtual void search (SoSearchAction *action) — search action hook 🔍
  • virtual void write (SoWriteAction *action) — write action hook 📝
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — primitive count action hook 🔢
  • virtual SoChildList * getChildren (void) const — the children, as a child list 🫶
  • void printDiagram (void) — print the diagram, very artsy of it 🌸
  • void printSubDiagram (const SbName &rootname, int level) — print a sub-diagram starting at rootname, at level 💜
  • void printTable (void) — print the table 🎀
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add a write reference 🌈
  • SbBool forceChildDrivenWriteRefs (SoOutput *out) — force child-driven write refs 💖

💜 Public Member Functions inherited from SoNode 💜

  • void setOverride (const SbBool state) — flip the override state ✨
  • SbBool isOverride (void) const — is it overridden? asking for a friend 🎀
  • void setNodeType (const NodeType type) — set the node type 🌸
  • NodeType getNodeType (void) const — get the node type 💅
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — make a copy, optionally copying connections 🫶
  • virtual SbBool affectsState (void) const — does it affect state? 💖
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — render below the path 🔥
  • virtual void GLRenderInPath (SoGLRenderAction *action) — render in the path ⭐
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — render off the path 🌈
  • virtual void pick (SoPickAction *action) — pick hook 🎯
  • virtual void audioRender (SoAudioRenderAction *action) — audio render hook 🔊
  • virtual void grabEventsSetup (void) — set up event grabbing 🎀
  • virtual void grabEventsCleanup (void) — clean up event grabbing 🧹
  • virtual void startNotify (void) — kick off notification 📣
  • virtual void notify (SoNotList *l) — notify, with a SoNotList 💜
  • SbUniqueId getNodeId (void) const — grab the node id 🆔
  • virtual void writeInstance (SoOutput *out) — write out this instance 📝
  • virtual SoFieldContainer * copyThroughConnection (void) const — copy through a connection 🦋

🌸 Public Member Functions inherited from SoFieldContainer 🌸

  • void setToDefaults (void) — reset everything to defaults 🎀
  • SbBool hasDefaultValues (void) const — does it have all default values? ✨
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — are the fields equal to another container's? 🫶
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copy field values over, optionally with connections 💖
  • SbBool set (const char *const fielddata) — set from field data 💅
  • void get (SbString &fielddata) — get field data into a string 🌸
  • virtual int getFields (SoFieldList &l) const — collect the fields into a list 💜
  • virtual int getAllFields (SoFieldList &l) const — collect all the fields into a list 🌈
  • virtual SoField * getField (const SbName &name) const — get a field by name 🎀
  • virtual SoField * getEventIn (const SbName &name) const — get an event-in by name 📥
  • virtual SoField * getEventOut (const SbName &name) const — get an event-out by name 📤
  • SbBool getFieldName (const SoField *const field, SbName &name) const — look up a field's name ✨
  • SbBool enableNotify (const SbBool flag) — turn notification on or off 🔔
  • SbBool isNotifyEnabled (void) const — is notification enabled? 🎀
  • SbBool set (const char *fielddata, SoInput *input) — set from field data with a SoInput 📥
  • void get (SbString &fielddata, SoOutput *out) — get field data with a SoOutput 📤
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validate a new field value ✅
  • SbBool getIsBuiltIn (void) const — is it built in? 🏠
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — report field memory size, managed and unmanaged 🧮
  • void setUserData (void *userdata) const — stash some user data 📦
  • void * getUserData (void) const — get that user data back out 🎁

🌈 Public Member Functions inherited from SoBase 🌈

  • void ref (void) const — bump the reference count ⬆️
  • void unref (void) const — drop the reference count ⬇️
  • void unrefNoDelete (void) const — drop the reference count but don't delete 🚫
  • int32_t getRefCount (void) const — what's the ref count, bestie? 🔢
  • void touch (void) — touch it, let the world know 👆
  • SbBool isOfType (SoType type) const — returns TRUE if the type of this object is either of the same type or inherited from type 🧬
  • virtual SbName getName (void) const — get the name 🏷️
  • virtual void setName (const SbName &newname) — set a new name ✏️
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor 👀
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove an auditor 🙈
  • const SoAuditorList & getAuditors (void) const — hand over the auditor list 📋
  • SbBool shouldWrite (void) — should this be written? 🤔
  • void assertAlive (void) const — assert that it's alive, dramatic but necessary 💀

👑 Static Public Member Functions 👑

  • static SoType getClassTypeId (void) — the class type id, statically ✨
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class's nodekit catalog 🎀
  • static void initClass (void) — init the class 💖

🫶 Static Public Member Functions inherited from SoSeparatorKit 🫶

  • static SoType getClassTypeId (void) — class type id 🌸
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog 💜
  • static void initClass (void) — init the class 🌈

🦋 Static Public Member Functions inherited from SoBaseKit 🦋

  • static SoType getClassTypeId (void) — class type id ✨
  • static void initClass (void) — init the class 🎀
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog 💅
  • static SbBool isSearchingChildren (void) — is it searching children? 🔍
  • static void setSearchingChildren (const SbBool newval) — set the searching-children flag 🫶

⭐ Static Public Member Functions inherited from SoNode ⭐

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — compatibility types for a node type 🧩
  • static SoType getClassTypeId (void) — class type id 🎀
  • static SoNode * getByName (const SbName &name) — find a node by name 🔎
  • static int getByName (const SbName &name, SoNodeList &l) — find nodes by name into a list 📋
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system ✨
  • static void initClasses (void) — init all the classes 🌈
  • static SbUniqueId getNextNodeId (void) — the next node id, please 🆔
  • static int getActionMethodIndex (const SoType type) — the action method index 🎯
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding box hook 📦
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render hook 💅
  • static void callbackS (SoAction *action, SoNode *node) — static callback hook 🔔
  • static void getMatrixS (SoAction *action, SoNode *node) — static matrix hook 🧮
  • static void handleEventS (SoAction *action, SoNode *node) — static event handling hook 🎀
  • static void pickS (SoAction *action, SoNode *node) — static pick hook 🎯
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick hook ✨
  • static void searchS (SoAction *action, SoNode *node) — static search hook 🔍
  • static void writeS (SoAction *action, SoNode *node) — static write hook 📝
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render hook 🔊
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count hook 🔢

💜 Static Public Member Functions inherited from SoFieldContainer 💜

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system ✨
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class 🎀
  • static void cleanupClass (void) — clean up the class 🧹
  • static void initCopyDict (void) — init the copy dictionary 📖
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — register a copy 🫶
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check for a copy 🔍
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find a copy, connections and all 💅
  • static void copyDone (void) — copying's done, wrap it up 🎬

🌈 Static Public Member Functions inherited from SoBase 🌈

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system ✨
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class 🎀
  • static void addName (SoBase *const base, const char *const name) — add a name to a base 🏷️
  • static void removeName (SoBase *const base, const char *const name) — remove a name from a base 🚫
  • static void incrementCurrentWriteCounter (void) — bump the current write counter ⬆️
  • static void decrementCurrentWriteCounter (void) — drop the current write counter ⬇️
  • static SoBase * getNamedBase (const SbName &name, SoType type) — get a named base 🔎
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases into a base list 📋
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read from input 📥
  • static void setInstancePrefix (const SbString &c) — set the instance prefix 🔤
  • static void setTraceRefs (SbBool trace) — turn reference tracing on or off 🕵️
  • static SbBool getTraceRefs (void) — is reference tracing on? 👀
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect a route from one node+field to another 🔗
  • static SbBool readRoute (SoInput *input) — read a route 📥

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const — the field data ✨
  • virtual ~SoWrapperKit () — the destructor, protected 💅

💖 Protected Member Functions inherited from SoSeparatorKit 💖

  • virtual ~SoSeparatorKit () — destructor 🌸
  • virtual void setDefaultOnNonWritingFields (void) — set defaults on non-writing fields 🎀
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — set up connections, optionally always 🫶

🦋 Protected Member Functions inherited from SoBaseKit 🦋

  • virtual ~SoBaseKit () — destructor 💜
  • virtual SoNode * addToCopyDict (void) const — add to the copy dictionary 📖
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copy the contents, connections optional 💅
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — get a container node from a list name 🌈
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — get any part, with leaf and public checks 🍃
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — build a path to any part 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — set any part ✏️
  • void createNodekitPartsList (void) — create the nodekit parts list 📋
  • void createFieldList (void) — create the field list 📝
  • virtual void createDefaultParts (void) — create the default parts 🎀
  • const SoNodekitParts * getNodekitPartsList (void) const — get the nodekit parts list ✨
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — get the catalog instances 🗂️
  • void catalogError (void) — catalog error 🚨
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance 📥
  • void countMyFields (SoOutput *out) — count my fields 🔢
  • virtual SbBool setPart (const int partNum, SoNode *node) — set a part by number 💅

💜 Protected Member Functions inherited from SoNode 💜

  • SoNode (void) — constructor 🎀
  • virtual ~SoNode () — destructor 🌸

🌸 Protected Member Functions inherited from SoFieldContainer 🌸

  • SoFieldContainer (void) — constructor ✨
  • virtual ~SoFieldContainer () — destructor 💖

🌈 Protected Member Functions inherited from SoBase 🌈

  • SoBase (void) — constructor 🎀
  • virtual ~SoBase () — destructor 🫶
  • virtual void destroy (void) — destroy it 💥
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs? 🤔
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header 📝
  • void writeFooter (SoOutput *out) const — write the footer 🔚
  • virtual const char * getFileFormatName (void) const — get the file format name 🏷️
  • virtual SoNotRec createNotRec (void) — create a notification record 🗒️

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data 🎀
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog ✨

🫶 Static Protected Member Functions inherited from SoSeparatorKit 🫶

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data 💜
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog 🌈

💖 Static Protected Member Functions inherited from SoBaseKit 💖

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data 🎀
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog 💅
ok bestie that's the end of part 1 🌸 there is more of this page coming, so hold that thought and keep reading — we are not done yet 💅✨

🌸 Static Protected Member Functions inherited from SoNode 🌸

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

💜 Static Protected Member Functions inherited from SoBase 💜

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🎀 Protected Attributes 🎀

  • SoSFNode contents
  • SoSFNode localTransform

Protected Attributes inherited from SoSeparatorKit

  • SoSFNode appearance
  • SoSFNode childList
  • SoSFNode pickStyle
  • SoSFNode texture2Transform
  • SoSFNode topSeparator
  • SoSFNode transform
  • SoSFNode units

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

✨ Additional Inherited Members ✨

Public Types inherited from SoSeparatorKit

enum CacheEnabled { OFF, ON, AUTO }

Public Types inherited from SoNode

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

Public Attributes inherited from SoSeparatorKit

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

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

🦋 Detailed Description 🦋

okay bestie, listen — the SoWrapperKit class is a simple kit for wrapping a transform and a subgraph. that's the whole vibe. it wraps. it transforms. it holds a subgraph. iconic behavior, honestly.

Nodekit structure — new entries versus the parent class are marked with an arrow prefix, so keep an eye out for those little arrows 👀:

CLASS SoWrapperKit
-->"this"
      "callbackList"
      "topSeparator"
         "pickStyle"
         "appearance"
         "units"
         "transform"
         "texture2Transform"
         "childList"
-->      "localTransform"
-->      "contents"

(if you're wondering how the output formatting works, see SoBaseKit::printDiagram() — that's where the magic lives 💫)

Detailed information on catalog parts:

CLASS SoWrapperKit
PVT   "this",  SoWrapperKit  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
      "pickStyle",  SoPickStyle  ---
      "appearance",  SoAppearanceKit  ---
      "units",  SoUnits  ---
      "transform",  SoTransform  ---
      "texture2Transform",  SoTexture2Transform  ---
      "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ]
      "localTransform",  SoTransform  ---
      "contents",  SoSeparator  ---

(and for the output formatting on this one, see SoBaseKit::printTable() — same energy, different table 🌈)

🎀 Constructor & Destructor Documentation 🎀

SoWrapperKit::SoWrapperKit (void )

Constructor. it constructs. that's it, that's the job, and it does it beautifully 💅

SoWrapperKit::~SoWrapperKit () [protected], [virtual]

Destructor. protected, virtual, and lowkey dramatic about it.

🌟 Member Function Documentation 🌟

SoType SoWrapperKit::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. basically: "who am I, class edition" 🪞

SoType SoWrapperKit::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoSeparatorKit.

const SoFieldData ** SoWrapperKit::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: not your business bestie, but we're still telling you it exists 🫶)

Returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoWrapperKit::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoSeparatorKit.

const SoNodekitCatalog * SoWrapperKit::getClassNodekitCatalog (void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit. yes, the whole layout. the blueprint. the floor plan. 🏗️

const SoNodekitCatalog * SoWrapperKit::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoSeparatorKit.

const SoNodekitCatalog ** SoWrapperKit::getClassNodekitCatalogPtr (void ) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class. double pointer moment. very meta. we love a pointer-to-pointer 💀

void SoWrapperKit::initClass (void ) [static]

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap, bestie!! 💖 this page is from Coin, version 4.0.10, and it was dated Thu Jun 25 2026 00:00:00 — so go forth, wrap your transforms, hold your subgraphs, and slay ✨👑

📦 where this page comes from