SoVertexAttribute(3)

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

💖 NAME 💖

SoVertexAttribute — a generic node for providing GL vertex attributes of various types. That's the whole vibe. ✨

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoVertexAttribute.h>

It inherits from SoNode, bestie. 👑

🫶 Public Member Functions

  • SoVertexAttribute (void) — the constructor, standard issue.
  • virtual SoType getTypeId (void) const — Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and downward"casting. 🔍
  • SoMField * getValuesField (void) const — hands you the values field.
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual void notify (SoNotList *l)

🌈 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 callback (SoCallbackAction *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 audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (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=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 — Returns TRUE if the type of this object is either of the same type or inherited from type. 🫶
  • 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 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)

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

  • SoSFName name — the attribute name, iconic.
  • SoSFName typeName — the type of the values, also iconic.

🔒 Protected Member Functions

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

🔒 Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

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

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

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)

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

🌈 Detailed Description 🌈

A generic node for providing GL vertex attributes of various types. That's the whole point of it, bestie. 💅

The SoVertexAttribute nodes are used with the SoShaderProgram node to send vertex attributes to the vertex shader. It's giving pipeline. 🔥

#Inventor V2.1 ascii

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

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

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

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

And here's the vertex shader (vertex.glsl), serving looks:

attribute vec3 color;

void main(void)
{
  gl_Position = ftransform();
  gl_FrontColor = vec4(color, 1.0);
}

👀 See also 👀

  • SoVertexAttributeBinding — go read that one next, fr fr. 🦋
⚠️ 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. So don't go looking for it there. 💀

⏳ Since ⏳

Coin 3.0. Vintage, but make it fashion. ✨

💅 Constructor & Destructor Documentation

  • SoVertexAttribute::SoVertexAttribute(void) — bestie, this is the constructor. It makes the thing. That's the whole job. Iconic behaviour, no notes. ✨
  • SoVertexAttribute::~SoVertexAttribute(void) [protected], [virtual] — and this one is the destructor. It's protected, so it's lowkey not for just anyone to call, and it's virtual, so it knows how to clean up after its subclasses too. It says goodbye. 🥀

🎀 Member Function Documentation

SoType SoVertexAttribute::getClassTypeId(void) [static]

This is the static method that hands you back the SoType object that belongs to objects of this class. Like, the class-level ID card. Static means you don't even need an instance to ask for it — the class itself answers. 🪪✨

SoType SoVertexAttribute::getTypeId(void) const [virtual]

Okay so this one returns the type identification of any object derived from a class that inherits SoBase. What's it for? Runtime type checking and "downward" casting, that's what. Here's the vibe:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now listen, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. All of them. 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 predefined 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 info on writing Coin extensions, go check the class documentation of the top level superclasses for the various class groups. It's giving required reading. 📚

Implements SoBase.

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

This function performs the typical operation of a node for any action. Any action, bestie. It's the general-purpose move. 🕺

Reimplemented from SoNode.

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

Action method for the SoGLRenderAction. This one gets called during rendering traversals. Any node that influences the rendering state in any way, or that wants to yeet geometry primitives at OpenGL, overrides this method. Slay. 🔥

Reimplemented from SoNode.

void SoVertexAttribute::write(SoWriteAction * action) [virtual]

Action method for SoWriteAction. It writes out a node object, and any connected nodes, engines etc, if that's necessary. Basically it's the "put it on paper" moment. ✍️

Reimplemented from SoNode.

void SoVertexAttribute::copyContents(const SoFieldContainer * from, SbBool copyconnections) [virtual]

Makes a deep copy of all the data of from into this instance — except external scene graph references if copyconnections is FALSE. Noted. 🫡

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses that need to account for internal data that aren't handled automatically. The manual stuff, basically.

Real talk: for copying nodes from application code, you should not invoke this function directly. Instead call the SoNode::copy() function:
SoNode * mynewnode = templatenode->copy();

Same energy goes for engines. Don't be out here calling copyContents() by hand. 🙈

And make sure that when you override the copyContents() method in your extension class, you also make it call upwards to its parent superclass in the inheritance hierarchy — because 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.)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

Reimplemented from SoNode.

void SoVertexAttribute::notify(SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. It's the group chat announcement of the class hierarchy. "hey everyone, something changed 💬". Reimplemented from SoNode.

SbBool SoVertexAttribute::readInstance(SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations. iykyk.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistent representation of an instance of this class type.

TRUE or FALSE gets returned, depending on whether the instantiation and configuration of the new object of this class type went OK or not. And the import process should be robust and handle corrupted input streams by returning FALSE. No crashing out, bestie — just say no. 💀

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

✨ Author

Generated automatically by Doxygen for Coin from the source code. (Not a human author, just a robot doing its lil thing 🤖💖)

That's the whole page, babes! This was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoVertexAttribute(3) manual page. Go forth and cast your types safely. 🦋💅✨

📦 where this page comes from