SoAppearanceKit(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoAppearanceKit(3) 💖

okay bestie, this is the SoAppearanceKit(3) manual page — manual name folded in, no boring header line. This is part 1, so we're only getting started. ✨

✨ NAME ✨

SoAppearanceKit — the SoAppearanceKit class is a node kit catalog that collects miscellaneous appearance node types. periodt. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodekits/SoAppearanceKit.h>

Inherits SoBaseKit.

bestie, this is the iconic lineup. no cap, every single one is here. ✨

💅 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=0)
  • 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=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 💜

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

🛡️ 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=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 setUpConnections (SbBool onoff, SbBool doitalways=0)
  • 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)
  • ~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 complexity
  • SoSFNode drawStyle
  • SoSFNode environment
  • SoSFNode font
  • SoSFNode lightModel
  • SoSFNode material
  • SoSFNode texture2

🧁 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 ✨

okay so these are the bits SoAppearanceKit inherits from its parent classes — freebies, no cap. 💅

  • 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
    }
  • Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
  • Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

🦋 Detailed Description 🦋

The SoAppearanceKit class is a node kit catalog that collects miscellaneous appearance node types. It's literally the backstage pass for all your appearance nodes. Obsessed. 💖

Node kit 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.

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.

🌸 Constructor & Destructor Documentation 🌸

🌸 SoAppearanceKit::SoAppearanceKit (void ) 🌸

Constructor. It's the origin story, the main character entrance. ✨

References SoAppearanceKit().

Referenced by getFieldData(), and SoAppearanceKit().

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

Destructor. It's giving cleanup era, goodbye bestie. 🧹💀

👑 Member Function Documentation 👑

👑 SoType SoAppearanceKit::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 the vibe check for your objects, no cap.

Usage example:

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
  }
}

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. Slay.

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 * 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. It's giving pointer energy, fr fr.

Reimplemented from SoBaseKit.

References SoAppearanceKit().

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

Returns the nodekit catalog which defines the layout of this class' kit. The blueprint, the map, the main character energy. 💅

Reimplemented from SoBaseKit.

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. Not a human, just Doxygen doing its thing. 🤖💅

That's the whole page, bestie. This one came from Coin, version 2.5.0, and it's SoAppearanceKit(3). No date on this footer, mysterious and iconic. Stay slaying. 💖✨

📦 where this page comes from