SOVERTEXATTRIBUTEBINDING(3coin3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVertexAttributeBinding(3) 💖

okay bestie, welcome to the Library Functions Manual — this one's the whole tea on SoVertexAttributeBinding, no gatekeeping. 🫶

✨ NAME ✨

SoVertexAttributeBinding — the node that sets up how vertex attributes are mapped onto shapes. that's it, that's the job. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoVertexAttributeBinding.h>

Inherits SoNode.

🌸 Public Types 🌸

  • enum Binding — the mapping mood board:
    • OVERALL = SoVertexAttributeBindingElement::OVERALL
    • PER_VERTEX = SoVertexAttributeBindingElement::PER_VERTEX
    • PER_VERTEX_INDEXED = SoVertexAttributeBindingElement::PER_VERTEX_INDEXED
    • DEFAULT = PER_VERTEX_INDEXED

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

💫 Public Member Functions 💫

  • virtual SoType getTypeId (void) const — tells you what type this cutie is.
  • SoVertexAttributeBinding (void) — the constructor, the birth, the origin story. ✨
  • virtual void doAction (SoAction *action) — the action-doing one.
  • virtual void GLRender (SoGLRenderAction *action) — renders the goods.
  • virtual void callback (SoCallbackAction *action) — the callback era.
  • virtual void pick (SoPickAction *action) — picking behavior.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts them primitives, fr fr.

🌈 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)
  • 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=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
  • 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) — the class type id, static style.
  • static void initClass (void) — sets the class up. do not skip, bestie.

🌟 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 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)
  • 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)

🍓 Public Attributes 🍓

  • SoSFEnum value — the one field, the main character. 💅

🌸 Protected Member Functions 🌸

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVertexAttributeBinding () — the destructor, bye bestie. 👋

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

🌈 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: uint32_t uniqueId
  • Protected Attributes inherited from SoFieldContainer: SbBool isBuiltIn
  • Static Protected Attributes inherited from SoNode: static uint32_t nextUniqueId = 1, static int nextActionMethodIndex = 0

👑 Detailed Description 👑

The SoVertexAttributeBinding class is a node for setting up how vertex attributes are mapped to shapes. literally its whole personality.

See also: SoVertexAttribute

okay so here's the vibe: the material binding you put in nodes of this type decides how the vertex attribute values from SoVertexAttribute nodes get mapped onto the builtin geometry shape nodes. no cap.

Here's a simple usage example, bestie — study it, it's giving tutorial:

#Inventor V2.1 ascii

ShaderProgram {
    shaderObject [
                  VertexShader {
                     sourceProgram "vertex.glsl"
                  }
               ]
 }

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

 VertexAttributeBinding { value OVERALL }

 VertexAttribute {
    typeName "SoMFVec3f"
    name "color"
    values [ 1.0 0.0 0.0 ]
 }

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

and the vertex shader (vertex.glsl) — yes she wrote her own shader, iconic:

attribute vec3 color;

void main(void)
{
  gl_Position = ftransform();
  fragcolor = color;
}

so with SoVertexAttributeBinding::value set to PER_VERTEX_INDEXED above, the attribute indices get taken from the SoIndexedFaceSet::coordIndex field when rendering. iykyk. 🦋

if SoVertexAttributeBinding::value is set to PER_VERTEX, attributes get fetched in a monotonically increasing manner from the SoVertexAttribute::value field, starting at index 0. yes, counting up from zero, the classic.

if SoVertexAttributeBinding::value is set to OVERALL, the first attribute value from SoVertexAttribute::value gets sent to OpenGL before rendering. one value, front row, no rotation. 💅

FILE FORMAT/DEFAULTS:

VertexAttributeBinding {
    value PER_VERTEX_INDEXED
}

See also: SoVertexAttribute

⚠️ heads up bestie — be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. don't come for me, it's just facts.

Since: Coin 3.0

to be continued… part 2 is coming, don't go anywhere 💖

🌈 Member Enumeration Documentation 🌈

✨ enum SoVertexAttributeBinding::Binding ✨

okay bestie so this is the enum listing all the vibes of material binding you can pick from 💅 (yes it says material, that's literally what the docs say, iykyk).

Enumerator:

  • OVERALL — slap the same material on the entire shape, start to finish. one look, one material, no drama 💖
  • PER_VERTEX — every single polygon, line, or point vertex of the shape gets a brand new material pulled from the pool of material values. main character energy for every vertex, fr fr ✨

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

  • PER_VERTEX_INDEXED — every polygon, line, or point vertex of the shape gets a new attribute, but this time it's grabbed from the pool of attribute values. ✨

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

🎀 Constructor & Destructor Documentation 🎀

SoVertexAttributeBinding::SoVertexAttributeBinding (void )

Constructor. the birth of a legend 💫

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

Destructor. it's giving goodbye, so sad, but make it virtual 🥺

💅 Member Function Documentation 💅

SoType SoVertexAttributeBinding::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. the glow-up detector of the type system, no cap 🔍

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. it's giving "do your homework before you extend the library" 🫶

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

Implements SoBase.

const SoFieldData * SoVertexAttributeBinding::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. iconic behaviour honestly 🌸

Reimplemented from SoFieldContainer.

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

This function performs the typical operation of a node for any action. the every-occasion fit, periodt 💅

Reimplemented from SoNode.

void SoVertexAttributeBinding::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. literally throwing shapes at OpenGL, we love to see it 🔥

Reimplemented from SoNode.

void SoVertexAttributeBinding::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. lowkey just keeps everyone in the loop ✨

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances. the shared-responsibilities queen 👑

Reimplemented from SoNode.

void SoVertexAttributeBinding::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. math? in my scene graph? more likely than you think 😭

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

🌟 Member Data Documentation 🌟

SoSFEnum SoVertexAttributeBinding::value

The attribute binding to use for subsequent shape nodes in the scene graph. The default binding is SoVertexAttributeBinding::PER_VERTEX_INDEXED — yes bestie, that's the default, write it down 📝💖

🦋 Author 🦋

Generated automatically by Doxygen for Coin from the source code. not me being auto-generated, still serving looks 💅✨

and that's a wrap on SoVertexAttributeBinding(3) from Coin, Version 3.1.3 — the manpage footer says so and we respect the footer in this house 🫶💜

📦 where this page comes from