SoVRMLMaterial(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 `SoVRMLMaterial` — NAME 🎀

hii bestie 💖 okay so this is the SoVRMLMaterial(3) page, and yeah it lives in the Library Functions Manual. no cap, it's lowkey a baddie.

SoVRMLMaterial — the SoVRMLMaterial class is used to assign a material to geometry. that's the whole assignment. it's giving "dress up the geometry" energy ✨

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLMaterial.h>

Inherits SoNode. so she's a node, she's got node lineage, we respect the family tree 🫶

💅 Public Member Functions 💅

these are hers, the ones she brings to the group chat:

virtual SoType getTypeId (void) const — the virtual type-id getter, const, iconic.
SoVRMLMaterial (void) — the constructor. does constructor things.
virtual void doAction (SoAction *action) — her action-dispatch override.
virtual void GLRender (SoGLRenderAction *action) — the GL render hook, virtual.
virtual void callback (SoCallbackAction *action) — the callback-action hook, virtual.

🦋 Public Member Functions inherited from `SoNode` 🦋

all of these come down from SoNode, unchanged, listed here so you know they exist:

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 search (SoSearchAction *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)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
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 🔥

the static girlies:

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 🍓

the actual data fields, the main character energy of this whole class:

SoSFColor diffuseColor
SoSFFloat ambientIntensity
SoSFColor specularColor
SoSFColor emissiveColor
SoSFFloat shininess
SoSFFloat transparency

👑 Protected Member Functions 👑

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLMaterial () — the destructor, virtual, protected, leave her alone.

🎀 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` ⭐

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

okay so that's the whole SYNOPSIS dump, and no cap it's a LOT of inherited members — they just keep coming, it's giving family reunion 😭 but bestie we are not done, because this page is long and this is only part 1. the DESCRIPTION and everything after it is still coming, so don't go anywhere 💖

✨ Detailed Description ✨

okay so bestie, the SoVRMLMaterial class is literally the one that assigns a material to geometry. it's giving surface vibes, no cap. 💅

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

Material {
  exposedField SFFloat ambientIntensity  0.2         # [0,1]
  exposedField SFColor diffuseColor      0.8 0.8 0.8 # [0,1]
  exposedField SFColor emissiveColor     0 0 0       # [0,1]
  exposedField SFFloat shininess         0.2         # [0,1]
  exposedField SFColor specularColor     0 0 0       # [0,1]
  exposedField SFFloat transparency      0           # [0,1]
}

The Material node specifies surface material properties for associated geometry nodes and is used by the VRML lighting equations during rendering. Subclause 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14), contains a detailed description of the VRML lighting model equations. All of the fields in the Material node range from 0.0 to 1.0. The fields in the Material node determine how light reflects off an object to create colour:

ambientIntensity — specifies how much ambient light from light sources this surface shall reflect. Ambient light is omnidirectional and depends only on the number of light sources, not their positions with respect to the surface. Ambient colour is calculated as ambientIntensity × diffuseColor. it's giving background glow energy. ✨
diffuseColor — reflects all VRML light sources depending on the angle of the surface with respect to the light source. The more directly the surface faces the light, the more diffuse light reflects. main character facing the spotlight, fr fr. 🔥
emissiveColor — models "glowing" objects. This can be useful for displaying pre-lit models (where the light energy of the room is computed explicitly), or for displaying scientific data. glow up, literally. 🌟
specularColor and shininess — determine the specular highlights (e.g., the shiny spots on an apple). When the angle from the light to the surface is close to the angle from the surface to the viewer, the specularColor is added to the diffuse and ambient colour calculations. Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights. shiny apple moment, obsessed. 🍎
transparency — specifies how "clear" an object is, with 1.0 being completely transparent, and 0.0 completely opaque. ghost mode vs solid mode, pick your vibe. 👻

🎀 Constructor & Destructor Documentation 🎀

`SoVRMLMaterial::SoVRMLMaterial (void )`

Constructor. the birth of a material node, bestie. ✨

References: ambientIntensity, diffuseColor, emissiveColor, shininess, SoVRMLMaterial(), specularColor, and transparency.

Referenced by: getFieldData(), and SoVRMLMaterial().

`SoVRMLMaterial::~SoVRMLMaterial () [protected], [virtual]`

Destructor. the goodbye era. 💀

💖 Member Function Documentation 💖

`SoType SoVRMLMaterial::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.

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.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

`const SoFieldData * SoVRMLMaterial::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 SoFieldContainer.

References: SoVRMLMaterial().

`void SoVRMLMaterial::doAction (SoAction * action) [virtual]`

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References: ambientIntensity, diffuseColor, emissiveColor, SoAction::getState(), SoNode::isOverride(), SoDebugError::postWarning(), SoOverrideElement::setAmbientColorOverride(), SoOverrideElement::setDiffuseColorOverride(), SoOverrideElement::setEmissiveColorOverride(), SoOverrideElement::setShininessOverride(), SoOverrideElement::setSpecularColorOverride(), SoOverrideElement::setTransparencyOverride(), shininess, specularColor, and transparency.

Referenced by: callback(), and GLRender().

`void SoVRMLMaterial::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: doAction().

`void SoVRMLMaterial::callback (SoCallbackAction * action) [virtual]`

Action method for SoCallbackAction.

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().