SoVRMLAppearance(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLAppearance 💖

okay so bestie, welcome to the manual page for SoVRMLAppearance 💅 — it's chillin' in the Library Functions Manual, and honestly? It's the glow-up artist of the VRML node world. It gives your shapes their whole look. ✨

🌸 NAME 🌸

SoVRMLAppearance — the class that specifies visual properties for shapes. That's it, that's the job. 🎀

🦋 SYNOPSIS 🦋

First thing's first, you gotta let it in:

#include <Inventor/VRMLnodes/SoVRMLAppearance.h>

And yes, it inherits SoNode — so it's a whole node, just for vibes. 💅

💜 Public Member Functions 💜

virtual SoType getTypeId (void) const
SoVRMLAppearance (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void search (SoSearchAction *action)
virtual SoChildList * getChildren (void) const
virtual void notify (SoNotList *list)
virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🫶 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 getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
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)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
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 void initClass (void)

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

🎀 Public Attributes 🎀

SoSFNode material
SoSFNode texture
SoSFNode textureTransform

These three are literally the whole personality of this node, no cap. 💖

🧚 Protected Member Functions 🧚

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLAppearance ()

🧚 Protected Member Functions inherited from SoNode 🧚

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

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

🍓 Additional Inherited Members 🍓

Public Types inherited from SoNode — the enum, bestie:

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 }

Protected Attributes inherited from SoNode:

uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer:

SbBool isBuiltIn

Static Protected Attributes inherited from SoNode:

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

👑 Detailed Description 👑

SoVRMLAppearance specifies visual properties for shapes. (Yeah, we said it in NAME, but it's true twice, slay. ✨)

⚠️ heads up: the detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium. Respect the source, bestie. 🫶

Here's the node shape in all its glory:

Appearance {
  exposedField SFNode material          NULL
  exposedField SFNode texture           NULL
  exposedField SFNode textureTransform  NULL
}

So like — the Appearance node specifies the visual properties of geometry. Every field in this node may be NULL. But however, if a field is non-NULL, it shall contain one node of the appropriate type. 🦋

The material field, if specified, shall contain a VRMLMaterial node. And if the material field is NULL or unspecified, lighting is off — like, all lights are ignored during rendering of the object that references this Appearance — and the unlit object colour is (1, 1, 1). If you want the details of the VRML lighting model, they're in 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14). iykyk. 🔥

The texture field, if specified, shall contain one of the various types of texture nodes (VRMLImageTexture, VRMLMovieTexture, or VRMLPixelTexture). If the texture node is NULL or the texture field is unspecified, the object that references this Appearance is not textured. And the textureTransform field, if specified, shall contain a VRMLTextureTransform node. If the textureTransform is NULL or unspecified, the textureTransform field has no effect. periodt. 💅

🌈 Constructor & Destructor Documentation 🌈

💖 SoVRMLAppearance::SoVRMLAppearance (void ) 💖

Constructor. ✨

References material, SoVRMLAppearance(), texture, and textureTransform. Referenced by getChildren(), getFieldData(), and SoVRMLAppearance().

💖 SoVRMLAppearance::~SoVRMLAppearance () [protected], [virtual] 💖

Destructor. 🥲 (a protected one, and virtual too — fancy.)

💫 Member Function Documentation 💫

  • SoType SoVRMLAppearance::getTypeId(void) const [virtual] — bestie, this one hands you back the type ID of any object that descends from a class inheriting SoBase. It's the whole reason run-time type checking and "downward" casting even work. ✨

Usage example, copy it exactly:

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

Okay so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. No skipping. 🙅‍♀️ 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.

Implements SoBase.

  • const SoFieldData * SoVRMLAppearance::getFieldData(void) const [protected], [virtual] — gives you a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. That's it, that's the vibe. 🎀

Reimplemented from SoFieldContainer.

References SoVRMLAppearance().

  • void SoVRMLAppearance::doAction(SoAction * action) [virtual] — this function performs the typical operation of a node for any action. Like, the default behavior pass. 🦋

Reimplemented from SoNode.

References getChildren(), SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

Referenced by callback(), and search().

  • void SoVRMLAppearance::callback(SoCallbackAction * action) [virtual] — action method for SoCallbackAction. It simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. 🧚

Reimplemented from SoNode.

References doAction().

  • void SoVRMLAppearance::GLRender(SoGLRenderAction * action) [virtual] — action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. 💅

Reimplemented from SoNode.

References SoGLRenderAction::abortNow(), SoNode::affectsState(), SbPList::getArrayPtr(), getChildren(), SoAction::getCurPathCode(), SbPList::getLength(), SoAction::getPathCode(), SoAction::getState(), SoNode::GLRender(), SoAction::hasTerminated(), material, SoAction::popCurPath(), SoAction::popPushCurPath(), SoAction::pushCurPath(), SoNode::SoNode(), texture, and SoVRMLMaterial::transparency.

  • void SoVRMLAppearance::search(SoSearchAction * action) [virtual] — action method for SoSearchAction. It compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. It's giving "all boxes checked or it's a no." 📋

See also SoSearchAction

Reimplemented from SoNode.

References doAction(), SoSearchAction::isFound(), and SoNode::search().

  • SoChildList * SoVRMLAppearance::getChildren(void) const [virtual] — returns list of children for this node. 🫶

Reimplemented from SoNode.

References SoVRMLAppearance(), and SoVRMLParent::updateChildList().

Referenced by doAction(), and GLRender().

  • void SoVRMLAppearance::notify(SoNotList * l) [virtual] — notifies all auditors for this instance when changes are made. The group chat gets pinged. 🔔

Reimplemented from SoNode.

References SoNotList::getLastField(), SoField::getTypeId(), and SoNode::notify().

  • void SoVRMLAppearance::copyContents(const SoFieldContainer * from, SbBool copyconnections) [virtual] — makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc etc)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}
Bestie, do NOT forget the call up to the parent superclass. That's the whole point. 😭

Reimplemented from SoNode.

References SoNode::copyContents(), and SoFieldContainer::SoFieldContainer().

🌸 Member Data Documentation 🌸

  • SoSFNode SoVRMLAppearance::material — can contain an SoVRMLMaterial node. Is NULL by default.

Referenced by GLRender(), and SoVRMLAppearance().

  • SoSFNode SoVRMLAppearance::texture — can contain a texture node. Is NULL by default.

Referenced by GLRender(), and SoVRMLAppearance().

  • SoSFNode SoVRMLAppearance::textureTransform — can contain an SoVRMLTextureTransform node. Is NULL by default.

Referenced by SoVRMLAppearance().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. The robot wrote it, not me. 🤖💖

And that's a wrap on SoVRMLAppearance(3), bestie — this page came straight out of Coin, Version 2.5.0, and the date on it is whatever the source code felt like that day. Go forth and render something iconic. 💅✨🦋

📦 where this page comes from