SoLightKit(3)

📦 version 3.1.3, in fedora 43, fedora 44

🦋 SoLightKit(3) — Library Functions Manual 🦋

Part 1 of 2, bestie — more is coming, don't touch that dial. 💖

✨ NAME ✨

SoLightKit — okay so picture this: a whole kit that hands you a transform, a light, and a shape or subgraph. It's giving one-stop glow-up station. ✨💡

🌸 SYNOPSIS 🌸

#include <Inventor/nodekits/SoLightKit.h>

Inherits SoBaseKit. Yes bestie, that's the parent — and it came with a lot of inherited slay. 💅

💖 Public Member Functions 💖

virtual SoType getTypeId (void) const — the type ID moment, iconic as always.
virtual const SoNodekitCatalog * getNodekitCatalog (void) const — grab the nodekit catalog, no cap.
SoLightKit (void) — constructor, the main character entrance. 🎀

🫶 Public Member Functions inherited from `SoBaseKit` 🫶

SoBaseKit (void) — inherited, still valid, still part of the family.
virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded) — inherited from SoBaseKit.
SbString getPartString (const SoBase *part) — inherited from SoBaseKit.
virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) — inherited from SoBaseKit.
virtual SbBool setPart (const SbName &partname, SoNode *from) — inherited from SoBaseKit.
SbBool set (const char *namevaluepairliststring) — inherited from SoBaseKit.
SbBool set (const char *partnamestring, const char *parameterstring) — inherited from SoBaseKit.
virtual void doAction (SoAction *action) — inherited from SoBaseKit.
virtual void callback (SoCallbackAction *action) — inherited from SoBaseKit.
virtual void GLRender (SoGLRenderAction *action) — inherited from SoBaseKit.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — inherited from SoBaseKit.
virtual void getMatrix (SoGetMatrixAction *action) — inherited from SoBaseKit.
virtual void handleEvent (SoHandleEventAction *action) — inherited from SoBaseKit.
virtual void rayPick (SoRayPickAction *action) — inherited from SoBaseKit.
virtual void search (SoSearchAction *action) — inherited from SoBaseKit.
virtual void write (SoWriteAction *action) — inherited from SoBaseKit.
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — inherited from SoBaseKit.
virtual SoChildList * getChildren (void) const — inherited from SoBaseKit.
void printDiagram (void) — inherited from SoBaseKit.
void printSubDiagram (const SbName &rootname, int level) — inherited from SoBaseKit.
void printTable (void) — inherited from SoBaseKit.
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — inherited from SoBaseKit.
SbBool forceChildDrivenWriteRefs (SoOutput *out) — inherited from SoBaseKit.

🌈 Public Member Functions inherited from `SoNode` 🌈

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

💜 Public Member Functions inherited from `SoFieldContainer` 💜

void setToDefaults (void) — inherited from SoFieldContainer.
SbBool hasDefaultValues (void) const — inherited from SoFieldContainer.
SbBool fieldsAreEqual (const SoFieldContainer *container) const — inherited from SoFieldContainer.
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — inherited from SoFieldContainer.
SbBool set (const char *const fielddata) — inherited from SoFieldContainer.
void get (SbString &fielddata) — inherited from SoFieldContainer.
virtual int getFields (SoFieldList &l) const — inherited from SoFieldContainer.
virtual int getAllFields (SoFieldList &l) const — inherited from SoFieldContainer.
virtual SoField * getField (const SbName &name) const — inherited from SoFieldContainer.
virtual SoField * getEventIn (const SbName &name) const — inherited from SoFieldContainer.
virtual SoField * getEventOut (const SbName &name) const — inherited from SoFieldContainer.
SbBool getFieldName (const SoField *const field, SbName &name) const — inherited from SoFieldContainer.
SbBool enableNotify (const SbBool flag) — inherited from SoFieldContainer.
SbBool isNotifyEnabled (void) const — inherited from SoFieldContainer.
SbBool set (const char *fielddata, SoInput *input) — inherited from SoFieldContainer.
void get (SbString &fielddata, SoOutput *out) — inherited from SoFieldContainer.
virtual SbBool validateNewFieldValue (SoField *field, void *newval) — inherited from SoFieldContainer.
SbBool getIsBuiltIn (void) const — inherited from SoFieldContainer.
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — inherited from SoFieldContainer.
void setUserData (void *userdata) const — inherited from SoFieldContainer.
void * getUserData (void) const — inherited from SoFieldContainer.

🎀 Public Member Functions inherited from `SoBase` 🎀

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

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void) — static public, still iconic.
static const SoNodekitCatalog * getClassNodekitCatalog (void) — static public.
static void initClass (void) — static public.

🌟 Static Public Member Functions inherited from `SoBaseKit` 🌟

static SoType getClassTypeId (void) — inherited from SoBaseKit.
static void initClass (void) — inherited from SoBaseKit.
static const SoNodekitCatalog * getClassNodekitCatalog (void) — inherited from SoBaseKit.
static SbBool isSearchingChildren (void) — inherited from SoBaseKit.
static void setSearchingChildren (const SbBool newval) — inherited from SoBaseKit.

🔥 Static Public Member Functions inherited from `SoNode` 🔥

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

💖 Static Public Member Functions inherited from `SoFieldContainer` 💖

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

🦋 Static Public Member Functions inherited from `SoBase` 🦋

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

🔒 Protected Member Functions 🔒

virtual const SoFieldData * getFieldData (void) const — protected, so handle with care, bestie.
virtual ~SoLightKit () — destructor, protected.

💅 Protected Member Functions inherited from `SoBaseKit` 💅

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

🛡️ Protected Member Functions inherited from `SoNode` 🛡️

SoNode (void) — inherited from SoNode.
virtual ~SoNode () — inherited from SoNode.

🧚 Protected Member Functions inherited from `SoFieldContainer` 🧚

SoFieldContainer (void) — inherited from SoFieldContainer.
virtual ~SoFieldContainer () — inherited from SoFieldContainer.

🌸 Protected Member Functions inherited from `SoBase` 🌸

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

✨ Static Protected Member Functions ✨

static const SoFieldData ** getFieldDataPtr (void) — static protected.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — static protected.

💫 Static Protected Member Functions inherited from `SoBaseKit` 💫

static const SoFieldData ** getFieldDataPtr (void) — inherited from SoBaseKit.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — inherited from SoBaseKit.

🌈 Static Protected Member Functions inherited from `SoNode` 🌈

static const SoFieldData ** getFieldDataPtr (void) — inherited from SoNode.
static void setNextActionMethodIndex (int index) — inherited from SoNode.
static int getNextActionMethodIndex (void) — inherited from SoNode.
static void incNextActionMethodIndex (void) — inherited from SoNode.
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — inherited from SoNode.

💜 Static Protected Member Functions inherited from `SoBase` 💜

static uint32_t getCurrentWriteCounter (void) — inherited from SoBase.
static void staticDataLock (void) — inherited from SoBase.
static void staticDataUnlock (void) — inherited from SoBase.

🎀 Protected Attributes 🎀

SoSFNode icon — protected attribute, part of the inner circle.
SoSFNode iconSeparator — protected attribute.
SoSFNode light — protected attribute.
SoSFNode transform — protected attribute.
SoSFNode transformGroup — protected attribute.

💖 Protected Attributes inherited from `SoBaseKit` 💖

SoSFNode callbackList — inherited from SoBaseKit.
SoChildList * children — inherited from SoBaseKit.
SbBool connectionsSetUp — inherited from SoBaseKit.

🌟 Protected Attributes inherited from `SoNode` 🌟

uint32_t uniqueId — inherited from SoNode.

🌸 Protected Attributes inherited from `SoFieldContainer` 🌸

SbBool isBuiltIn — inherited from SoFieldContainer.

Additional Inherited Members 💖

okay so before we get into the main character energy of SoLightKit, let's give a shoutout to the stuff it inherited, because bestie, it's giving "I got it from my ancestors" and we love that for it. 💅

Public Types inherited from SoNode ✨

so SoNode passed down this enum called NodeType, and it's literally a whole mood board of versions. no cap, here's the exact list:

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 }

like, that's a lot of versions, but we respect the hustle. 🫶

Protected Types inherited from SoBase 🦋

and SoBase gave us BaseFlags, which is short but iconic:

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

lowkey just two flags, but they matter, iykyk. 💜

Static Protected Attributes inherited from SoNode 🌸

then SoNode also has these static protected attributes, and they're just sitting there being all static and protected:

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

periodt. ✨

Detailed Description 💅

okay so the SoLightKit class? it's literally a kit that provides a transform, a light and a shape or subgraph. it's giving "I contain multitudes" and honestly, same. 💖

here's the node kit structure, with new entries versus the parent class marked with an arrow prefix:

       CLASS SoLightKit
       -->"this"
             "callbackList"
       -->   "transformGroup"
       -->      "transform"
       -->      "light"
       -->      "iconSeparator"
       -->         "icon"

(if you wanna know more about the output formatting, check out SoBaseKit::printDiagram() — it's the plug. 🔌)

and here's the detailed info on catalog parts, no cap:

       CLASS SoLightKit
       PVT   "this",  SoLightKit  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "transformGroup",  SoTransformSeparator  ---
             "transform",  SoTransform  ---
             "light",  SoLight  --- , (default type = SoDirectionalLight)
       PVT   "iconSeparator",  SoSeparator  ---
             "icon",  SoNode  --- , (default type = SoCube)

(and again, for the formatting tea, see SoBaseKit::printTable() — it's giving organized. 📋)

Constructor & Destructor Documentation 🎀

`SoLightKit::SoLightKit (void )`

this is the constructor. it constructs. it's the birth of your kit. slay. 👑

`SoLightKit::~SoLightKit () [protected], [virtual]`

and this is the destructor. it's protected and virtual, so it's giving "I clean up after myself, but only in the right circles." 💅

Member Function Documentation 📚

`SoType SoLightKit::getTypeId (void ) const [virtual]`

so 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. basically it's the "who dis?" of the Coin world. 💁‍♀️

here's a usage example, exactly as it appears:

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

now, for all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. it's 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 (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

for more info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

reimplemented from SoBaseKit. 🔥

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

this one returns a pointer to the class-wide field data storage object for this instance. if no fields are present, it returns NULL. so basically it's the "do we have fields? maybe not" energy. 🙈

reimplemented from SoBaseKit. 💖

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

and this one returns the nodekit catalog which defines the layout of this class' kit. it's the blueprint, the map, the whole vibe. 🗺️

reimplemented from SoBaseKit. ✨

Author ✍️

generated automatically by Doxygen for Coin from the source code. so you know it's official. no ghostwriting here, just robots doing their thing. 🤖

and that's a wrap on this page, bestie! this was brought to you by Coin, version 3.1.3, and the page itself is SoLightKit(3). no date on the footer, but the vibes are timeless. mwah 💋

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.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

SoLightKit(3)

🦋 SoLightKit(3) — Library Functions Manual 🦋

✨ NAME ✨

🌸 SYNOPSIS 🌸

💖 Public Member Functions 💖

🫶 Public Member Functions inherited from SoBaseKit 🫶

🌈 Public Member Functions inherited from SoNode 🌈

💜 Public Member Functions inherited from SoFieldContainer 💜

🎀 Public Member Functions inherited from SoBase 🎀

⭐ Static Public Member Functions ⭐

🌟 Static Public Member Functions inherited from SoBaseKit 🌟

🔥 Static Public Member Functions inherited from SoNode 🔥

💖 Static Public Member Functions inherited from SoFieldContainer 💖

🦋 Static Public Member Functions inherited from SoBase 🦋

🔒 Protected Member Functions 🔒

💅 Protected Member Functions inherited from SoBaseKit 💅

🛡️ Protected Member Functions inherited from SoNode 🛡️

🧚 Protected Member Functions inherited from SoFieldContainer 🧚

🌸 Protected Member Functions inherited from SoBase 🌸