SoVRMLMaterial(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

okay bestie, welcome to SoVRMLMaterial(3) from the Coin manual 💖 this one is a whole saga so it comes in two parts, and this is part 1. grab a snack 🍓 and let's go.

📛 NAME

SoVRMLMaterial — the class used to assign a material to geometry. yes fr, it's the glow-up department for your shapes. ✨

🫶 SYNOPSIS

#include <Inventor/VRMLnodes/SoVRMLMaterial.h>

Inherits SoNode. 👑

🎀 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you the SoType for this object 🦋
  • SoVRMLMaterial (void) — the constructor, makes you a brand new material node 💅
  • virtual void doAction (SoAction *action) — the action-dispatch override for this node 🔁
  • virtual void GLRender (SoGLRenderAction *action) — the GL render override 🎨
  • virtual void callback (SoCallbackAction *action) — the callback-action override 📞

🌸 Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — flip override mode on or off
  • SbBool isOverride (void) const — are we in override mode rn?
  • void setNodeType (const NodeType type) — set the node type
  • NodeType getNodeType (void) const — get the node type
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — make a copy, and you can choose whether connections come along
  • virtual SbBool affectsState (void) const — does this thing touch the state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — the below-path render traversal
  • virtual void GLRenderInPath (SoGLRenderAction *action) — the in-path render traversal
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — the off-path render traversal
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box action
  • virtual void getMatrix (SoGetMatrixAction *action) — matrix action
  • virtual void handleEvent (SoHandleEventAction *action) — event handling action
  • virtual void pick (SoPickAction *action) — pick action
  • virtual void rayPick (SoRayPickAction *action) — ray pick action
  • virtual void search (SoSearchAction *action) — search action
  • virtual void write (SoWriteAction *action) — write action
  • virtual void audioRender (SoAudioRenderAction *action) — audio render action
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — primitive count action
  • virtual void grabEventsSetup (void) — event grabbing setup
  • virtual void grabEventsCleanup (void) — event grabbing cleanup
  • virtual void startNotify (void) — kick off notification
  • virtual void notify (SoNotList *l) — do the notification
  • SbUniqueId getNodeId (void) const — the node's unique id 🆔
  • virtual SoChildList * getChildren (void) const — the child list
  • virtual void writeInstance (SoOutput *out) — write out this instance
  • virtual SoNode * addToCopyDict (void) const — register yourself in the copy dictionary
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy contents over from another field container
  • virtual SoFieldContainer * copyThroughConnection (void) const — copy through a connection

💜 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — reset everything to defaults
  • SbBool hasDefaultValues (void) const — are all the values still default?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — do our fields match theirs?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — steal their field values, optionally including connections
  • SbBool set (const char *const fielddata) — set from field data
  • void get (SbString &fielddata) — get the field data out
  • virtual int getFields (SoFieldList &l) const — collect the fields into a list
  • virtual int getAllFields (SoFieldList &l) const — collect all the fields into a list
  • virtual SoField * getField (const SbName &name) const — grab a field by name
  • virtual SoField * getEventIn (const SbName &name) const — grab an event-in by name
  • virtual SoField * getEventOut (const SbName &name) const — grab an event-out by name
  • SbBool getFieldName (const SoField *const field, SbName &name) const — look up a field's name
  • SbBool enableNotify (const SbBool flag) — turn notification on or off
  • SbBool isNotifyEnabled (void) const — is notification on?
  • SbBool set (const char *fielddata, SoInput *input) — the other set, this time with an SoInput
  • void get (SbString &fielddata, SoOutput *out) — the other get, this time with an SoOutput
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — check whether a new value is valid
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add a write reference
  • SbBool getIsBuiltIn (void) const — is this built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — report field memory sizes
  • void setUserData (void *userdata) const — stash some user data
  • void * getUserData (void) const — get that user data back

🦋 Public Member Functions inherited from SoBase

  • void ref (void) const — bump the ref count
  • void unref (void) const — drop the ref count
  • void unrefNoDelete (void) const — drop the ref count without deleting
  • int32_t getRefCount (void) const — what's the ref count rn?
  • void touch (void) — touch it, make it notify
  • SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type. 🫶
  • virtual SbName getName (void) const — get the name
  • virtual void setName (const SbName &newname) — set the name
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove an auditor
  • const SoAuditorList & getAuditors (void) const — get the auditor list
  • SbBool shouldWrite (void) — should this be written out?
  • void assertAlive (void) const — assert that it's still alive

✨ Static Public Member Functions

  • static SoType getClassTypeId (void) — the class-level SoType 🌟
  • static void initClass (void) — sets up class init 🎀

🌈 Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — compatibility types for a node type
  • static SoType getClassTypeId (void) — the class SoType
  • static SoNode * getByName (const SbName &name) — find a node by name
  • static int getByName (const SbName &name, SoNodeList &l) — find nodes by name into a list
  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💫
  • static void initClasses (void) — set up all the classes
  • static SbUniqueId getNextNodeId (void) — the next node id
  • static int getActionMethodIndex (const SoType type) — action method index for a type
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding box helper
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render helper
  • static void callbackS (SoAction *action, SoNode *node) — static callback helper
  • static void getMatrixS (SoAction *action, SoNode *node) — static matrix helper
  • static void handleEventS (SoAction *action, SoNode *node) — static event helper
  • static void pickS (SoAction *action, SoNode *node) — static pick helper
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick helper
  • static void searchS (SoAction *action, SoNode *node) — static search helper
  • static void writeS (SoAction *action, SoNode *node) — static write helper
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render helper
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count helper

🧚 Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💫
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class. 🔎
  • static void cleanupClass (void) — clean the class up
  • static void initCopyDict (void) — init the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — add a copy to the dictionary
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check the copy
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find a copy, with or without connections
  • static void copyDone (void) — copying is done

💖 Static Public Member Functions inherited from SoBase

  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💫
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class. 🔎
  • static void addName (SoBase *const base, const char *const name) — register a name
  • static void removeName (SoBase *const base, const char *const name) — unregister a name
  • static void incrementCurrentWriteCounter (void) — bump the write counter
  • static void decrementCurrentWriteCounter (void) — drop the write counter
  • static SoBase * getNamedBase (const SbName &name, SoType type) — find a named base
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — find named bases into a list
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read one in
  • static void setInstancePrefix (const SbString &c) — set the instance prefix
  • static void setTraceRefs (SbBool trace) — turn ref tracing on or off
  • static SbBool getTraceRefs (void) — is ref tracing on?
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect a route between two nodes and fields 🔗
  • static SbBool readRoute (SoInput *input) — read a route

🍓 Public Attributes

  • SoSFColor diffuseColor — the diffuse color 🎨
  • SoSFFloat ambientIntensity — the ambient intensity
  • SoSFColor specularColor — the specular color ✨
  • SoSFColor emissiveColor — the emissive color
  • SoSFFloat shininess — the shininess 💎
  • SoSFFloat transparency — the transparency 🫥

👑 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — get the field data
  • virtual ~SoVRMLMaterial () — the destructor 💀

🌸 Protected Member Functions inherited from SoNode

  • SoNode (void) — the node constructor
  • virtual ~SoNode () — the node destructor
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance

💜 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — the field container constructor
  • virtual ~SoFieldContainer () — the field container destructor

🦋 Protected Member Functions inherited from SoBase

  • SoBase (void) — the base constructor
  • virtual ~SoBase () — the base destructor
  • virtual void destroy (void) — destroy it
  • SbBool hasMultipleWriteRefs (void) const — got multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header
  • void writeFooter (SoOutput *out) const — write the footer
  • virtual const char * getFileFormatName (void) const — the file format name
  • virtual SoNotRec createNotRec (void) — create a notification record

💅 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer

🌈 Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer
  • static void setNextActionMethodIndex (int index) — set the next action method index
  • static int getNextActionMethodIndex (void) — get the next action method index
  • static void incNextActionMethodIndex (void) — increment the next action method index
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set compatibility types

🧚 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — get the current write counter
  • static void staticDataLock (void) — lock the static data
  • static void staticDataUnlock (void) — unlock the static data

✨ 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoNode

SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

and that's the whole inheritance tree laid out bestie, every single one of them accounted for 🫶 part 2 is right behind this one, don't go anywhere 👀

🌈 Detailed Description 🌈

Okay bestie, listen up 💖 The SoVRMLMaterial class is what you use to assign a material to geometry. That's the whole vibe. You want your shape to look like shiny plastic or matte clay or a glowing alien orb? This is the node that makes it happen. Periodt.

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:

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 it gets used by the VRML lighting equations during rendering. Like, when the renderer is figuring out what colour a pixel should be, it's lowkey consulting this node the whole time. ✨

Subclause 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14) contains a detailed description of the VRML lighting model equations — go read it if you want the actual math, iykyk.

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:

  • The ambientIntensity field 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. 🫶
  • The diffuseColor field 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. It's giving "the sun is literally in my face right now." ☀️
  • The emissiveColor field 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. Main character glow-up energy. 👑
  • The specularColor and shininess fields 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. Glossy vs. matte, your choice bestie 💅
  • The transparency field specifies how "clear" an object is, with 1.0 being completely transparent, and 0.0 completely opaque. Ghost mode: activated. 👻

🎀 Constructor & Destructor Documentation 🎀

SoVRMLMaterial::SoVRMLMaterial (void )

Constructor. Making a brand new one, no cap.

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

Destructor. It's protected and virtual, so it's doing its little cleanup thing behind the scenes. 🙈

⭐ Member Function Documentation ⭐

SoType SoVRMLMaterial::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

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

Implements SoBase.

const SoFieldData ** SoVRMLMaterial::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. So like... if you're an app dev, this one isn't for you, bestie. 🙈

Returns the SoFieldData class which holds information about fields in this node.

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.

void SoVRMLMaterial::initClass (void ) [static]

No description in the source — it's just out here existing, silent, iconic. 💅

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

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

Reimplemented from SoNode.

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 want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoNode.

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.

🦋 Member Data Documentation 🦋

  • SoSFColor SoVRMLMaterial::diffuseColor — the diffuse color component. Default value is (0.8, 0.8, 0.8).
  • SoSFFloat SoVRMLMaterial::ambientIntensity — the ambient intensity. Default value is 0.2.
  • SoSFColor SoVRMLMaterial::specularColor — the specular color component. Default value is (0, 0, 0).
  • SoSFColor SoVRMLMaterial::emissiveColor — the emissive color component. Default value is (0, 0, 0).
  • SoSFFloat SoVRMLMaterial::shininess — the shininess value. A number between 0 and 1. Default value is 0.2.
  • SoSFFloat SoVRMLMaterial::transparency — the material transparency. Valid range is from 0.0 (completely opaque) to 1.0 (completely transparent). Default value is 0.0.

💜 Author 💜

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

And that's the whole page, bestie!! 🌸 This was Version 4.0.10, dated Thu Jun 25 2026, and it lives at SoVRMLMaterial(3) in the manual pages. Go forth and make your geometry absolutely gorgeous 🎀✨🫶

📦 where this page comes from