SoAppearanceKit(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

SoAppearanceKit(3) πŸ’… Coin

okay bestie, so this is SoAppearanceKit(3), and it's giving ✨node kit catalog✨ energy. Let's get into it.


✨ NAME ✨

SoAppearanceKit β€” the SoAppearanceKit class is a node kit catalog that collects miscellaneous appearance node types. that's it, that's the whole vibe πŸŽ€


🌸 SYNOPSIS 🌸

#include <Inventor/nodekits/SoAppearanceKit.h>

Inherits SoBaseKit. yes queen, it's part of the family tree πŸ‘‘


πŸ’– Public Member Functions

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

πŸ’– 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 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 β€” spits out TRUE if this object's type is either literally the same type, or inherited from type. type check but make it ✨genealogy✨
  • 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) β€” sets up the initialization for data that's common to all instances of this class, like handing over the necessary info to the Coin type system. the group-chat setup, if you will πŸ“±
  • 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)

πŸ¦‹ Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) β€” sets up the initialization for data that's common to all instances of this class, like submitting the necessary information to the Coin type system. same ritual, different class πŸ’«
  • static SoType getClassTypeId (void) β€” this static method hands you back the SoType object that's associated with objects of this class. it's the class's little ID card πŸͺͺ
  • 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 the initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. yes, again. it's a whole family tradition 🫢
  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class. the ID card, but make it base-class core πŸ’…
  • 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 ~SoAppearanceKit ()

πŸŽ€ 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
  • virtual SoNotRec createNotRec (void)

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

and that's literally just the SYNOPSIS bestie, there's more coming in part 2, don't you dare close the tab πŸ’œ

πŸ›‘οΈ Protected Attributes πŸ›‘οΈ

okay so these are the lil protected members of the kit β€” each one's an SoSFNode, so it's a node slot you can fill:

  • complexity β€” an SoSFNode πŸ’«
  • drawStyle β€” an SoSFNode ✨
  • environment β€” an SoSFNode 🌸
  • font β€” an SoSFNode πŸŽ€
  • lightModel β€” an SoSFNode πŸ’‘
  • material β€” an SoSFNode πŸ’…
  • texture2 β€” an SoSFNode πŸ¦‹

Protected Attributes inherited from SoBaseKit 🫢

  • callbackList β€” an SoSFNode
  • children β€” an SoChildList *
  • connectionsSetUp β€” an SbBool

Protected Attributes inherited from SoNode πŸ’œ

  • uniqueId β€” an SbUniqueId

Protected Attributes inherited from SoFieldContainer πŸ“

  • isBuiltIn β€” an SbBool

πŸ‘‘ Additional Inherited Members πŸ‘‘

Public Types inherited from SoNode 🌈

this is the NodeType enum, and it's lowkey a whole vibe, every single value:

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 }

Protected Types inherited from SoBase 🧚

the BaseFlags enum, short and sweet fr:

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

Static Protected Attributes inherited from SoNode ⭐

  • static SbUniqueId nextUniqueId = 1 β€” yes bestie, it starts at 1 πŸ’–
  • static int nextActionMethodIndex = 0 β€” and this one starts at 0

🌟 Detailed Description 🌟

The SoAppearanceKit class is a node kit catalog that collects miscellaneous appearance node types. it's literally the lil shopping bag πŸ›οΈ for all your appearance-y nodes, no cap.

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

CLASS SoAppearanceKit
-->"this"
      "callbackList"
-->   "lightModel"
-->   "environment"
-->   "drawStyle"
-->   "material"
-->   "complexity"
-->   "texture2"
-->   "font"

(See SoBaseKit::printDiagram() for information about the output formatting.) iykyk, that's where the diagram tea is β˜•

Detailed information on catalog parts:

CLASS SoAppearanceKit
PVT   "this",  SoAppearanceKit  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
      "lightModel",  SoLightModel  ---
      "environment",  SoEnvironment  ---
      "drawStyle",  SoDrawStyle  ---
      "material",  SoMaterial  ---
      "complexity",  SoComplexity  ---
      "texture2",  SoTexture2  ---
      "font",  SoFont  ---

(See SoBaseKit::printTable() for information about the output formatting.) the way that table is giving organized πŸ’…


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoAppearanceKit::SoAppearanceKit (void )

Constructor. 🐣 the birth of your kit, slay.

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

Destructor. 🫧 protected and virtual, so it knows exactly how to clean up after itself.


✨ Member Function Documentation ✨

SoType SoAppearanceKit::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's the "who am I" of the whole class fr πŸ”

SoType SoAppearanceKit::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. lowkey the bouncer at the club checking IDs πŸͺͺ

Reimplemented from SoBaseKit.

const SoFieldData ** SoAppearanceKit::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.

πŸ™ˆ okay so this one's giving "staff only" β€” it's internal, not really for the app programmer, so don't stress about it.

const SoFieldData * SoAppearanceKit::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 SoBaseKit.

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

Returns the nodekit catalog which defines the layout of this class' kit. πŸ“‹ it's the class-level map of the whole kit.

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

Returns the nodekit catalog which defines the layout of this class' kit. same energy, but for this instance 🫢

Reimplemented from SoBaseKit.

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

Returns the pointer to the pointer of the nodekit catalog for this class. yes bestie, pointer to a pointer, we're going a level deeper πŸ˜­πŸ’€

void SoAppearanceKit::initClass (void ) [static]

(the page ends this one right here β€” that's all the text gives us!)


🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. not a human typing this out at 2am, it's the robot doing its thing πŸ€–βœ¨


okay bestie that's the whole page, we ate and left no crumbs πŸ½οΈπŸ’… this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoAppearanceKit(3) β€” go forth and slay your node kits, ily, bye πŸ«ΆπŸ’–πŸŒˆ

πŸ“¦ where this page comes from