SoMaterialBinding(3)

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

✨ NAME ✨

SoMaterialBinding — the node whose entire personality is setting up how materials get mapped onto shapes. that's it, that's the job 💅

🦋 SYNOPSIS 🦋

okay so first things first, bestie, you gotta pull in the header:

#include <Inventor/nodes/SoMaterialBinding.h>

It inherits SoNode — so it's got all that node energy running through it. 🌸

🎀 Public Types 🎀

the Binding enum, in full, no skips:

enum Binding { OVERALL = SoMaterialBindingElement::OVERALL, PER_PART = SoMaterialBindingElement::PER_PART, PER_PART_INDEXED = SoMaterialBindingElement::PER_PART_INDEXED, PER_FACE = SoMaterialBindingElement::PER_FACE, PER_FACE_INDEXED = SoMaterialBindingElement::PER_FACE_INDEXED, PER_VERTEX = SoMaterialBindingElement::PER_VERTEX, PER_VERTEX_INDEXED = SoMaterialBindingElement::PER_VERTEX_INDEXED, DEFAULT = OVERALL, NONE = OVERALL }

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

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • SoMaterialBinding (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🌈 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=FALSE) 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 rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId 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=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)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • 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

  • 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 — hands you back TRUE if this object's type is either the same as type or inherited from it. so basically "are you one of us" but in code 🫶
  • 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) — sets up the initialization for data that every single instance of this class shares, like handing the Coin type system all the info it needs. iconique ✨

🌸 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) — sets up initialization for the data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — 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)
  • 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) — 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)
  • 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)

👑 Public Attributes 👑

  • SoSFEnum value

💀 Protected Member Functions 💀

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoMaterialBinding ()

🙈 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)
  • virtual ~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
  • virtual SoNotRec createNotRec (void)

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

🌟 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

okay bestie, that's the whole class skeleton — every enum value, every function signature, every inherited attribute, all of it, no crumbs left behind 💖 but like… this is part 1, and there is so much more coming in part 2, so don't you dare scroll away, the good stuff is literally right there 🫶✨

💖 Detailed Description 💖

okay so bestie, SoMaterialBinding is a whole node whose entire job is deciding how materials get mapped onto shapes. that's it. that's the gig. ✨

the binding you set in a node like this one decides how the material values living in your SoMaterial nodes get mapped onto the built-in geometry shape nodes.

and the exact meaning of a binding? it depends on what particular shape type a material (or a whole set of materials) is being applied to. so like, same binding, different shape, different vibe check. 🌸

here's a very simple usage example, no cap:

#Inventor V2.1 ascii

Separator {
   Coordinate3 {
      point [ 0 0 0, 1 0 0, 1 1 0 ]
   }

   Material {
      diffuseColor [ 1 0 0, 1 1 0, 0 0 1 ]
   }

   MaterialBinding {
      value PER_VERTEX_INDEXED
   }

   IndexedFaceSet {
      coordIndex [ 0, 1, 2, -1 ]
      materialIndex [ 0, 1, 0 ]
   }
}

with SoMaterialBinding::value set to PER_VERTEX_INDEXED like up there ☝️, the material indices get pulled straight from the SoIndexedFaceSet::materialIndex field when rendering. slay. 💅

and if SoMaterialBinding::value was set to PER_VERTEX_INDEXED like that, but the SoIndexedFaceSet::materialIndex was undefined or empty? then the indices are implicitly taken from the SoIndexedFaceSet::coordIndex field instead. the fallback ate, fr fr. 🫶

and if SoMaterialBinding::value is set to PER_VERTEX, colors get fetched in a monotonically increasing manner from the SoMaterial::diffuseColor field, starting at index 0. one after another, no skips, main character energy. 👑

🎀 FILE FORMAT/DEFAULTS: 🎀

MaterialBinding {
    value OVERALL
}

🌈 See also 🌈

  • SoMaterial

✨ Member Enumeration Documentation ✨

💜 enum SoMaterialBinding::Binding 💜

enumeration of all the available types of material binding. the whole menu, bestie. 🍓

Enumerator

  • OVERALL — apply the same material to the complete shape. one material, whole shape, done. 💖
  • PER_PART — get a new material from the pool of material values for each part of the shape, where the definition of a "part" depends on the shape type.

materials are fetched from index 0 and onwards, incrementing the index into the material pool by 1 for each new part, in the order defined by the particular shape type.

⚠️ important portability note, bestie, listen up: it was previously allowed with the SGI Inventor library to supply too few colors versus the number of parts of the subsequent shapes in the scene graph. coloring would then cycle through the available colors. 🔁
since SGI Open Inventor v2.1, this was disallowed, though — enough colors for all parts must be supplied, or behavior will be unspecified (likely to cause a crash, in fact 😭💀). note that the Inventor Mentor book contains a description of the old, invalid behavior in Chapter 5, section "Binding Nodes" (middle of page 128 in the 10th printing).
  • PER_PART_INDEXED — get a new material from the pool of material values for each part of the shape, where the definition of a part depends on the shape type.

materials are fetched by the index value settings of the shape. ✨

  • PER_FACE — get a new material from the pool of material values for each polygon face of the shape.

materials are fetched from index 0 and onwards, incrementing the index into the material pool by 1 for each new face of the shape node.

note that individual faces after tessellation of complex shapes (like SoCylinder nodes) are not considered to be separate entities, and so this binding will be treated in the same manner as SoMaterialBinding::PER_PART for those. 🙈

  • PER_FACE_INDEXED — get a new material from the pool of material values for each polygon face of the shape.

materials are fetched by the index value settings of the shape.

note that individual faces after tessellation of complex shapes (like SoCylinder nodes) are not considered to be separate entities, and so this binding will be treated in the same manner as SoMaterialBinding::PER_PART_INDEXED for those. 🦋

  • PER_VERTEX — get a new material from the pool of material values for each polygon, line or point vertex of the shape.

materials are fetched from index 0 and onwards, incrementing the index into the material pool by 1 for each new vertex of the shape node.

  • PER_VERTEX_INDEXED — get a new material from the pool of material values for each polygon, line or point vertex of the shape.

materials are fetched by the index value settings of the shape. 🔥

  • DEFAULT — obsolete. don't use this value. 🚫
  • NONE — obsolete. don't use this value. 🚫

🌸 Constructor & Destructor Documentation 🌸

SoMaterialBinding::SoMaterialBinding (void )

constructor. hi bestie, welcome to the world. 🎀

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

destructor. bye bestie. 💜

⭐ Member Function Documentation ⭐

SoType SoMaterialBinding::getClassTypeId (void ) [static]

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

SoType SoMaterialBinding::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. iykyk. 💅

implements SoBase.

const SoFieldData ** SoMaterialBinding::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. 🙈

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

const SoFieldData * SoMaterialBinding::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 SoMaterialBinding::doAction (SoAction * action) [virtual]

this function performs the typical operation of a node for any action. the universal vibe. ✨

reimplemented from SoNode.

void SoMaterialBinding::GLRender (SoGLRenderAction * action) [virtual]

action method for the SoGLRenderAction.

this is called during rendering traversals. nodes influencing the rendering state in any way, or that want to throw geometry primitives at OpenGL, override this method. 🔥

reimplemented from SoNode.

void SoMaterialBinding::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.

void SoMaterialBinding::pick (SoPickAction * action) [virtual]

action method for SoPickAction.

does common processing for SoPickAction action instances.

reimplemented from SoNode.

void SoMaterialBinding::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

action method for the SoGetPrimitiveCountAction.

calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

reimplemented from SoNode.

💖 Member Data Documentation 💖

SoSFEnum SoMaterialBinding::value

the material binding to use for subsequent shape nodes in the scene graph. the default binding is SoMaterialBinding::OVERALL. periodt. 💅

🦋 Author 🦋

generated automatically by Doxygen for Coin from the source code. not a human, just a very diligent robot bestie. 🤖✨

and that's a wrap on this page, bestie! 🎀 this one's from Coin, Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoMaterialBinding(3) manual page. go forth and bind your materials, you absolute icon. 👑💖

📦 where this page comes from