SoShapeKit(3)

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

💖 SoShapeKit(3) 💖

okay bestie, sit down, hydrate, because this is the manual page for SoShapeKit — section 3 of the Coin manuals, and she is a whole entire vibe. Don't panic, I got you, we're reading it together 💅

✨ NAME ✨

SoShapeKit — the class that provides templates to insert what is usually needed for shape nodes. Short, sweet, does exactly what it says on the tin 💖

🦋 SYNOPSIS 🦋

#include <Inventor/nodekits/SoShapeKit.h>

and she inherits SoSeparatorKit — so everything that queen can do, she can do too. It's giving family tree ✨

👑 Public Member Functions 👑

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoShapeKit (void)

that's her own personal lineup, no cap 🫶

🌸 Public Member Functions inherited from SoSeparatorKit 🌸

  • SoSeparatorKit (void)

just the one, but she's iconic 💅

🧚 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)

look at that list. she ate and left no crumbs 😭

🌈 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 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)
  • SbUniqueId 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 — returns TRUE if the type of this object is either of the same type or inherited from type. periodt 💖
  • 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)

statics, bestie. you don't call these on an object, you call them on the class itself. iykyk 🧚

🌸 Static Public Member Functions inherited from SoSeparatorKit 🌸

  • 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) — 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)
  • static SbUniqueId 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)

yes there are two getByName overloads, no that's not a typo, that's just how she lives 💅

🍓 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)
  • 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) — 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)
  • 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 ~SoShapeKit ()
  • virtual void setDefaultOnNonWritingFields (void)

protected = the velvet rope section. these are for subclasses and internals, not for you to just vibe with at the party 🙈

🌸 Protected Member Functions inherited from SoSeparatorKit 🌸

  • virtual ~SoSeparatorKit ()
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)

🧚 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 readInstance (SoInput *in, unsigned short flags)
  • void countMyFields (SoOutput *out)
  • virtual SbBool setPart (const int partNum, SoNode *node)
heads up bestie — there are two different setPart things floating around. the public one takes (const SbName &partname, SoNode *from) and this protected one takes (const int partNum, SoNode *node). don't mix them up, fr fr 💀

🌈 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
  • virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

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

🌸 Static Protected Member Functions inherited from SoSeparatorKit 🌸

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

and that's the whole catalog of everything she's carrying around 💖

💅 Static Protected Member Functions inherited from SoNode 💅

Okay bestie, these are the internal static protected member functions that SoShapeKit inherits from SoNode. They're lowkey for library devs only, but here's the full list, no cap:

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

And from SoBase, we got these:

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

🌸 Protected Attributes 🌸

These are the protected attributes that SoShapeKit itself brings to the table. They're all SoSFNode type, which is giving "field container for nodes". 💅

  • SoSFNode coordinate3
  • SoSFNode coordinate4
  • SoSFNode localTransform
  • SoSFNode materialBinding
  • SoSFNode normal
  • SoSFNode normalBinding
  • SoSFNode profileCoordinate2
  • SoSFNode profileCoordinate3
  • SoSFNode profileList
  • SoSFNode shape
  • SoSFNode shapeHints
  • SoSFNode shapeSeparator
  • SoSFNode textureCoordinate2
  • SoSFNode textureCoordinateBinding
  • SoSFNode textureCoordinateFunction

🦋 Protected Attributes inherited from SoSeparatorKit 🦋

Inherited from SoSeparatorKit, we have:

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

🌈 Protected Attributes inherited from SoBaseKit 🌈

From SoBaseKit:

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

⭐ Protected Attributes inherited from SoNode ⭐

From SoNode:

  • SbUniqueId uniqueId

💜 Protected Attributes inherited from SoFieldContainer 💜

From SoFieldContainer:

  • SbBool isBuiltIn

✨ Additional Inherited Members ✨

Okay so there's a whole bunch of inherited types and attributes. Let's break it down.

💖 Public Types inherited from SoSeparatorKit 💖

  • enum CacheEnabled { OFF, ON, AUTO }

🦄 Public Types inherited from SoNode 🦄

Here's the big enum, bestie. Keep it exact:

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 📖

Bestie, listen up: the SoShapeKit class provides templates to insert what is usually needed for shape nodes. It's literally the blueprint for shape realness. 💅

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

CLASS SoShapeKit
-->"this"
      "callbackList"
      "topSeparator"
         "pickStyle"
         "appearance"
         "units"
         "transform"
         "texture2Transform"
-->      "materialBinding"
-->      "normalBinding"
-->      "textureCoordinateBinding"
-->      "shapeHints"
-->      "coordinate3"
-->      "coordinate4"
-->      "normal"
-->      "textureCoordinate2"
-->      "profileCoordinate2"
-->      "profileCoordinate3"
-->      "profileList"
         "childList"
-->      "textureCoordinateFunction"
-->      "localTransform"
-->      "shapeSeparator"
-->         "shape"

(See SoBaseKit::printDiagram() for information about the output formatting.)

If you wanna know how this diagram gets printed, check out SoBaseKit::printDiagram(). It's the formatting guru. ✨

Detailed information on catalog parts:

CLASS SoShapeKit
PVT   "this",  SoShapeKit  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
      "pickStyle",  SoPickStyle  ---
      "appearance",  SoAppearanceKit  ---
      "units",  SoUnits  ---
      "transform",  SoTransform  ---
      "texture2Transform",  SoTexture2Transform  ---
      "materialBinding",  SoMaterialBinding  ---
      "normalBinding",  SoNormalBinding  ---
      "textureCoordinateBinding",  SoTextureCoordinateBinding  ---
      "shapeHints",  SoShapeHints  ---
      "coordinate3",  SoCoordinate3  ---
      "coordinate4",  SoCoordinate4  ---
      "normal",  SoNormal  ---
      "textureCoordinate2",  SoTextureCoordinate2  ---
      "profileCoordinate2",  SoProfileCoordinate2  ---
      "profileCoordinate3",  SoProfileCoordinate3  ---
      "profileList",  SoNodeKitListPart [ SoProfile ]
      "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ]
      "textureCoordinateFunction",  SoTextureCoordinateFunction  --- , (default type = SoTextureCoordinateDefault)
      "localTransform",  SoTransform  ---
PVT   "shapeSeparator",  SoSeparator  ---
      "shape",  SoShape  --- , (default type = SoCube)

(See SoBaseKit::printTable() for information about the output formatting.)

And for the table formatting tea, see SoBaseKit::printTable(). It's all there, no cap. 🫶

👑 Constructor & Destructor Documentation 👑

  • SoShapeKit::SoShapeKit (void ) — Constructor. Like, it makes a new SoShapeKit. Duh.
  • SoShapeKit::~SoShapeKit () [protected], [virtual] — Destructor. It cleans up the vibe when you're done.

💖 Member Function Documentation 💖

  • SoType SoShapeKit::getClassTypeId (void ) [static] — This static method returns the SoType object associated with objects of this class. It's the class ID flex.
  • SoType SoShapeKit::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. It's giving RTTI realness. Reimplemented from SoSeparatorKit.
  • const SoFieldData ** SoShapeKit::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. Returns the SoFieldData class which holds information about fields in this node. Lowkey not for you unless you're hacking the library.
  • const SoFieldData * SoShapeKit::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 * SoShapeKit::getClassNodekitCatalog (void ) [static] — Returns the nodekit catalog which defines the layout of this class' kit. It's the blueprint, bestie.
  • const SoNodekitCatalog * SoShapeKit::getNodekitCatalog (void ) const [virtual] — Returns the nodekit catalog which defines the layout of this class' kit. Reimplemented from SoSeparatorKit.
  • const SoNodekitCatalog ** SoShapeKit::getClassNodekitCatalogPtr (void ) [static], [protected] — Returns the pointer to the pointer of the nodekit catalog for this class. Double pointer energy. 💅
  • void SoShapeKit::initClass (void ) [static] — (No description given in the original, just the signature. So here it is, raw.)
  • void SoShapeKit::setDefaultOnNonWritingFields (void ) [protected], [virtual] — (Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scene graph export operations.

This is typically done when:

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

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Reimplemented from SoSeparatorKit.

✍️ Author ✍️

This whole page was generated automatically by Doxygen for Coin from the source code. So like, blame the robots, not me. 💅

That's the tea, bestie! This was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoShapeKit(3) manpage. Stay iconic! 💖✨🦋

📦 where this page comes from