SoSeparatorKit(3)

📦 version 2.5.0, in fedora 43, fedora 44

🌸 `SoSeparatorKit(3)` — Library Functions Manual 🌸

okay so bestie, welcome to the SoSeparatorKit glow-up page 💖 this one lives in the Library Functions Manual, and jsyk it's a whole saga — we're doing part 1 of 2 rn, so buckle in and don't scroll away on me.

💅 NAME 💅

SoSeparatorKit — the SoSeparatorKit class provides a typical set of nodes to influence a shape subgraph.

like, it's giving "starter pack for making a shape behave" 🎀 no cap, that's literally what the class description says.

✨ SYNOPSIS ✨

First, the include, because obviously:

#include <Inventor/nodekits/SoSeparatorKit.h>

Inherits SoBaseKit.

Inherited by SoShapeKit, and SoWrapperKit.

family tree check 👑 SoSeparatorKit got its whole look from SoBaseKit, and then SoShapeKit and SoWrapperKit came through and inherited from it. generational talent fr fr.

🌈 Public Types 🌈

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
    }

look at all those hex values bestie, the bitmask is bitmasking ✨ keep every single one of them exactly as written, I'm not touching a digit.

🦋 Public Member Functions 🦋

Your actual homegrown methods, fresh off the SoSeparatorKit vine:

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoSeparatorKit (void)

🫶 Public Member Functions inherited from `SoBaseKit`

The freebies that came with the inheritance 💝 all of them, verbatim:

SoBaseKit (void)
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 *from)
SbBool set (const char *namevaluepairliststring)
SbBool set (const char *partnamestring, const char *parameterstring)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SoChildList * getChildren (void) const
void printDiagram (void)
void printSubDiagram (const SbName &rootname, int level)
void printTable (void)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

⭐ Public Member Functions inherited from `SoNode`

More inherited slay, straight from SoNode:

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoFieldContainer * copyThroughConnection (void) const

💜 Public Member Functions inherited from `SoFieldContainer`

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

🎀 Public Member Functions inherited from `SoBase`

The OG ancestors of the whole bloodline 🧬

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

🌟 Static Public Member Functions 🌟

These ones you call on the class itself, main character energy only:

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)

Static Public Member Functions inherited from SoBaseKit:

static SoType getClassTypeId (void)
static void initClass (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static SbBool isSearchingChildren (void)
static void setSearchingChildren (const SbBool newval)
static SoNode * typeCheck (const SbName &partname, const SoType
    &parttype, SoNode *node)

Static Public Member Functions inherited from SoNode:

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

Static Public Member Functions inherited from SoFieldContainer:

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

Static Public Member Functions inherited from SoBase:

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *in)

🍓 Public Attributes 🍓

These are public, meaning they're out here living their truth in the open:

SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling

four SoSFEnums bestie, all public, all just sitting there 💅

🔥 Protected Member Functions 🔥

For the family only, no outsiders:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoSeparatorKit ()
virtual void setDefaultOnNonWritingFields (void)
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)

Protected Member Functions inherited from SoBaseKit:

virtual ~SoBaseKit ()
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *fromfc, SbBool
    copyconnections)
SoGroup * getContainerNode (const SbName &listname, SbBool
    makeifneeded=1)
virtual SoNode * getAnyPart (const SbName &partname, SbBool
    makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname,
    SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const
    SoPath *pathtoextend=NULL)
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool
    anypart=1)
void createNodekitPartsList (void)
void createFieldList (void)
virtual void createDefaultParts (void)
const SoNodekitParts * getNodekitPartsList (void) const
const SbList< SoSFNode * > & getCatalogInstances (void) const
void catalogError (void)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
void countMyFields (SoOutput *out)
virtual SbBool setPart (const int partNum, SoNode *node)

Protected Member Functions inherited from SoNode:

SoNode (void)
virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer:

SoFieldContainer (void)
~SoFieldContainer ()

Protected Member Functions inherited from SoBase:

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

🧚 Static Protected Member Functions 🧚

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

Static Protected Member Functions inherited from SoBaseKit:

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

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 👑

The behind-the-scenes besties, seven of them, all SoSFNode:

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

🌈 and that's the whole SYNOPSIS glow-up, every single signature preserved, not one dropped, not one renamed. we are so not done though — part 2 is literally right there, so don't close the tab 🦋💖

🫶 Protected Attributes inherited from SoBaseKit

SoSFNode callbackList — the callback list field, living its best life down here in protected territory 💅
SoChildList * children — a pointer to the children list, iconic as always
SbBool connectionsSetUp — the little flag that says "yep, connections are set up" ✨

🌸 Protected Attributes inherited from SoNode

uint32_t uniqueId — every node gets its own one-of-a-kind ID, no dupes allowed, periodt

🎀 Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn — tells you whether this field container is built-in or not

💜 Friends

class SoSeparatorKitP — bestie status granted, they get access to the private stuff 🫂

🌈 Additional Inherited Members

Protected Types inherited from SoBase:

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

Static Protected Attributes inherited from SoNode:

static uint32_t nextUniqueId = 0 — the counter that keeps handing out those unique IDs
static int nextActionMethodIndex = 0 — and the one tracking the next action method index

👑 Detailed Description

Okay so real talk: the SoSeparatorKit class hands you a typical set of nodes to influence a shape subgraph. That's the whole vibe. It's a kit, it's a separator, it's giving organized.

Here's the node kit structure, with the new entries versus the parent class marked with that little arrow prefix 💫:

CLASS SoSeparatorKit
-->"this"
      "callbackList"
-->   "topSeparator"
-->      "pickStyle"
-->      "appearance"
-->      "units"
-->      "transform"
-->      "texture2Transform"
-->      "childList"

(If you wanna know how that output formatting actually works, go check out SoBaseKit::printDiagram() — that's the source, bestie.)

And now the detailed information on catalog parts ✨:

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

(Same deal for this one's formatting — that's SoBaseKit::printTable()'s whole job 🫡)

🔥 Member Enumeration Documentation

🌟 enum `SoSeparatorKit::CacheEnabled`

So this enum literally contains the same values with the same semantics as the enum that shares its name over in SoSeparator. Like, identical energy. Go read the documentation of SoSeparator::CacheEnabled if you want the deets 💖

🦋 Constructor & Destructor Documentation

💫 `SoSeparatorKit::SoSeparatorKit(void)`

The constructor. It's the beginning of everything, the main character entrance 🌸

It references boundingBoxCaching, pickCulling, renderCaching, renderCulling, setUpConnections(), and SoSeparatorKit().

And it's referenced by getFieldData(), initClass(), and SoSeparatorKit().

🌙 `SoSeparatorKit::~SoSeparatorKit()` `[protected]`, `[virtual]`

The destructor. Gotta clean up after yourself, bestie 🧹

⭐ Member Function Documentation

🎀 `SoType SoSeparatorKit::getTypeId(void) const` `[virtual]`

This one returns the type identification of an object derived from a class inheriting SoBase. It's used for run-time type checking and "downward" casting, which is exactly as dramatic as it sounds 💅

Here's the usage example, verbatim, because we do NOT mess with code in this house:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

Now, for all you application programmers out there wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else your heart desires: this method needs to be overridden in all subclasses. No skips, no shortcuts. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on and so forth 🌀

For more info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups. That's where the lore lives 📚

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit. ✨

💜 `const SoFieldData * SoSeparatorKit::getFieldData(void) const` `[protected]`, `[virtual]`

Gives you a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. Simple as that 🫶

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

References SoSeparatorKit().

🌸 `const SoNodekitCatalog * SoSeparatorKit::getNodekitCatalog(void) const` `[virtual]`

Returns the nodekit catalog which defines the layout of this class' kit. It's basically the blueprint, the floor plan, the Pinterest board of this kit 🎀

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

⭐ `void SoSeparatorKit::initClass(void)` `[static]`

Does initialization common for all objects of the SoSeparatorKit class. This includes setting up the type system, among other things. Iconic group-project energy, honestly 💫

References SoSeparatorKit().

Referenced by SoNodeKit::init().

🔥 `void SoSeparatorKit::setDefaultOnNonWritingFields(void)` `[protected]`, `[virtual]`

Heads up, bestie: this method is unlikely to be of interest to the application programmer who doesn't want to extend the library with new custom nodekits or draggers. But if you ARE writing extensions, go read the info in the SoBaseKit class documentation. Do not skip. 🙈

So this is a virtual method, and the code inside it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

field value is NULL and part is NULL by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. And from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Respect the lineage, periodt 👑

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit.

References SoBaseKit::setDefaultOnNonWritingFields().

Referenced by SoShapeKit::setDefaultOnNonWritingFields().

🦋 `SbBool SoSeparatorKit::setUpConnections(SbBool onoff, SbBool doitalways = 0)` `[protected]`, `[virtual]`

Sets up all internal connections for instances of this class. Every single one. No connection left behind 💖

Okay so again: this method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If that's you, see the SoBaseKit class documentation. You've been warned (affectionately) 🫶

Reimplemented from SoBaseKit.

References SoBaseKit::connectionsSetUp, and SoBaseKit::setUpConnections().

Referenced by SoSeparatorKit().

🌈 Member Data Documentation

💫 `SoSFEnum SoSeparatorKit::renderCaching`

See documentation for SoSeparator::renderCaching. That's where the tea is ☕

Referenced by SoSeparatorKit().

🎀 `SoSFEnum SoSeparatorKit::boundingBoxCaching`

See documentation for SoSeparator::boundingBoxCaching. Go read it, bestie 📖

Referenced by SoSeparatorKit().

🌸 `SoSFEnum SoSeparatorKit::renderCulling`

See documentation for SoSeparator::renderCulling. All the deets live over there ✨

Referenced by SoSeparatorKit().

⭐ `SoSFEnum SoSeparatorKit::pickCulling`

See documentation for SoSeparator::pickCulling. Last one, promise 💅

Referenced by SoSeparatorKit().

💜 Author

Generated automatically by Doxygen for Coin from the source code. Not a human typing this out, just a robot doing its lil thing 🤖✨

And that's a wrap on this page, bestie! 🎉 This whole thing came to you courtesy of Coin, Version 2.5.0, and it's the SoSeparatorKit(3) page — so if you ever need to cite it, that's the version and the man page name right there. Slay, go build something cute 💖🦋🌸

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoSeparatorKit(3)