SoAppearanceKit(3)
okay so bestie, welcome to the SoAppearanceKit(3) manual page! 💖 This is part 1 of 2, so don't go anywhere, because the rest is coming. ✨
✨ NAME ✨
SoAppearanceKit — this class is a node kit catalog that collects miscellaneous appearance node types. It's literally the "grab bag of glow-up nodes" energy, fr fr. 💅
✨ SYNOPSIS ✨
#include <Inventor/nodekits/SoAppearanceKit.h>
Inherits SoBaseKit.💖 Public Member Functions
These are the main character functions that SoAppearanceKit brings to the table. No cap. 👑
virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoAppearanceKit (void)💖 Public Member Functions inherited from SoBaseKit
And here's the inheritance tea — these are all the public member functions it gets from SoBaseKit. They're iconic, they're useful, they're exactly as follows:
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
Next up, the SoNode glow-up. These are the public member functions inherited from SoNode, and they're giving "base class realness". 💅
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)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoFieldContainer * copyThroughConnection (void) const💖 Public Member Functions inherited from SoFieldContainer
Now the SoFieldContainer inheritance. It's a whole vibe of field management, and here are all the public member functions:
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
And finally, the SoBase public member functions. The foundation, the roots, the OG. 🌱
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 public member functions? Yes bestie, we have those too. Here they are:
static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)💖 Static Public Member Functions inherited from SoBaseKit
Static functions from SoBaseKit, coming right up:
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
And the static ones from SoNode. So many functions, but we're keeping up. 💪
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 public member functions from SoFieldContainer — here's the list:
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
And the static public member functions from SoBase. The ancestors really came through. ✨
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
Now we're getting into the protected section. These are for the class's inner circle, but we're showing you anyway. 😌
virtual const SoFieldData * getFieldData (void) const
virtual ~SoAppearanceKit ()💖 Protected Member Functions inherited from SoBaseKit
Protected member functions from SoBaseKit. It's a lot, but it's all here:
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
Protected member functions from SoNode — short and sweet:
SoNode (void)
virtual ~SoNode ()💖 Protected Member Functions inherited from SoFieldContainer
Protected member functions from SoFieldContainer:
SoFieldContainer (void)
virtual ~SoFieldContainer ()💖 Protected Member Functions inherited from SoBase
Protected member functions from SoBase. The deep magic. 🔮
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 protected member functions for SoAppearanceKit itself:
static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)💖 Static Protected Member Functions inherited from SoBaseKit
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 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 protected member functions inherited from SoBase:
static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)💖 Protected Attributes
Protected attributes! These are the fields that make SoAppearanceKit so appearance-y. 💅
SoSFNode complexity
SoSFNode drawStyle
SoSFNode environment
SoSFNode font
SoSFNode lightModel
SoSFNode material
SoSFNode texture2💖 Protected Attributes inherited from SoBaseKit
Protected attributes inherited from SoBaseKit:
SoSFNode callbackList
SoChildList * children
SbBool connectionsSetUp💖 Protected Attributes inherited from SoNode
Protected attributes inherited from SoNode:
uint32_t uniqueId💖 Protected Attributes inherited from SoFieldContainer
Protected attributes inherited from SoFieldContainer:
SbBool isBuiltIn✨ Additional Inherited Members ✨
Before we get into the main character stuff, here's all the inherited lore you're lowkey getting for free. 💖
👑 Public Types inherited from SoNode
SoNode said "here, take these vibes" and handed over this enum. Not me memorizing all these hex values, but slay.
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
Another enum, this one protected, so it's giving "for your eyes only" energy. 🙈
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }🌸 Static Protected Attributes inherited from SoNode
Static protected attributes? More like static slay attributes, periodt. ✨
static uint32_t nextUniqueId = 1— yes bestie, it starts at1.static int nextActionMethodIndex = 0— and this one starts at0.
💅 Detailed Description 💅
The SoAppearanceKit class is a node kit catalog that collects miscellaneous appearance node types. It's literally the closet where all your appearance-related nodes hang out together. 👑
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.) That's the function to call if you want to see this diagram in your terminal, bestie.
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.) Another iconic print function, no cap.
🎀 Constructor & Destructor Documentation 🎀
SoAppearanceKit::SoAppearanceKit (void )
Constructor. It constructs. It's giving new-beginning energy. ✨
SoAppearanceKit::~SoAppearanceKit () [protected], [virtual]
Destructor. It destructs. Protected and virtual, so it's lowkey exclusive. 💅
🔥 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. Basically, it's the "who dis?" of the Coin type system. 👑
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. So yeah, if you're building your own extension, bestie, you will be overriding this. No skipping. 😤
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. So if you get NULL, that's not a glitch, it's just no fields. 💀
Reimplemented from SoBaseKit.
const SoNodekitCatalog * SoAppearanceKit::getNodekitCatalog (void ) const [virtual]
Returns the nodekit catalog which defines the layout of this class' kit. It's literally the blueprint of the kit. Iconic. 📐
Reimplemented from SoBaseKit.
🦋 Author 🦋
Generated automatically by Doxygen for Coin from the source code. Not a human author, just Doxygen doing its little automation thing. 🤖💖
And that's the whole page, bestie! This was Coin Version 3.1.3, for SoAppearanceKit(3). Thanks for reading, 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 : a language model's rewrite of the original, under its terms