SoSceneKit(3)

📦 version 3.1.3, in fedora 43, fedora 44

SoSceneKit(3) 💖🦋

okay bestie, part 1 of 2, and this one is giving full function roster energy. no cap. let's get into it 💅

✨ NAME ✨

SoSceneKit — the class that collects node kits needed to set up a scene: camera, light and shapes. literally the whole setup squad 🎀

🌸 SYNOPSIS 🌸

#include <Inventor/nodekits/SoSceneKit.h>

Inherits SoBaseKit.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoSceneKit (void)
  • int getCameraNumber (void)
  • void setCameraNumber (int camNum)
  • virtual SbBool affectsState (void) const

💖 Public Member Functions inherited from SoBaseKit 💖

  • 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=FALSE)
  • SbBool forceChildDrivenWriteRefs (SoOutput *out)

💖 Public Member Functions inherited 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=FALSE) 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💖 Public Member Functions inherited from SoBase 💖

  • 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 💖

  • 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 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

💖 Protected Member Functions 💖

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoSceneKit ()

💖 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=TRUE)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
  • 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 setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void setDefaultOnNonWritingFields (void)
  • 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)
  • virtual ~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 💖

  • SoSFNode cameraList
  • SoSFNode childList
  • SoSFNode lightList
  • SoSFNode topSeparator

💖 Protected Attributes inherited from SoBaseKit 💖

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

💖 Protected Attributes inherited from SoNode 💖

  • uint32_t uniqueId

💖 Protected Attributes inherited from SoFieldContainer 💖

  • SbBool isBuiltIn

💖 Additional Inherited Members 💖

✨ Public Types inherited from SoNode

Okay bestie, so SoNode left you this enum:

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 }

🧚 Protected Types inherited from SoBase

And SoBase was like, here's a lil protected enum for you:

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

🌸 Static Protected Attributes inherited from SoNode

SoNode also handed down these static protected attributes:

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

🌈 Detailed Description 🌈

The SoSceneKit class is literally the friend who collects all the node kits you need to set up a scene: camera, light and shapes. It's giving backstage crew energy. 🎬

Node kit structure (new entries versus parent class marked with arrow prefix):

       CLASS SoSceneKit
       -->"this"
             "callbackList"
       -->   "topSeparator"
       -->      "cameraList"
       -->      "lightList"
       -->      "childList"

(If you're curious about the output formatting, check SoBaseKit::printDiagram(). It's lowkey iconic.)

Detailed information on catalog parts:

       CLASS SoSceneKit
       PVT   "this",  SoSceneKit  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
             "cameraList",  SoNodeKitListPart [ SoCameraKit ]
             "lightList",  SoNodeKitListPart [ SoLightKit ]
             "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ]

(Again, SoBaseKit::printTable() has the deets on output formatting. Slay.)

💖 Constructor & Destructor Documentation 💖

🌟 SoSceneKit::SoSceneKit (void )

Constructor. It's the birth of your scene kit, bestie. ✨

💀 SoSceneKit::~SoSceneKit () [protected], [virtual]

Destructor. It's the goodbye, but make it protected and virtual. 💅

🦋 Member Function Documentation 🦋

⭐ SoType SoSceneKit::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. It's basically the ID check at the club door. 🪪

Usage example:

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

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

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

Reimplemented from SoBaseKit.

💜 const SoFieldData * SoSceneKit::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. No fields? It's giving minimalist. 🫶

Reimplemented from SoBaseKit.

🎀 const SoNodekitCatalog * SoSceneKit::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. It's the blueprint, the map, the Pinterest board. 📌

Reimplemented from SoBaseKit.

🔥 int SoSceneKit::getCameraNumber (void )

Returns the index of the current active camera in cameraList. Who's the main character camera right now? This tells you. 📸

💅 void SoSceneKit::setCameraNumber (int camnum)

Sets the current active camera in cameraList. You're the director now, bestie. 🎬

🌈 SbBool SoSceneKit::affectsState (void ) const [virtual]

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a "better safe than sorry" philosophy.

Reimplemented from SoNode.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that's the tea. This page was served by Coin Version 3.1.3, SoSceneKit(3) — footer energy, but make it cute. 💖✨

📦 where this page comes from