SoVertexAttribute(3)

📦 version 3.1.3, in fedora 43, fedora 44

👑 SoVertexAttribute — NAME 💖

SoVertexAttribute — a generic node for providing GL vertex attributes of various types. She's from the Library Functions Manual, section 3, and she is that girl. 🎀

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoVertexAttribute.h>

Inherits SoNode. Bestie has a whole family tree and we're listing every single cousin, no skips. 🫶

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoMField * getValuesField (void) const
  • 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)
  • uint32_t 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
  • 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)
  • 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)
  • 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 🌸

  • SoSFName name
  • SoSFName typeName

✨ Protected Member Functions ✨

  • 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

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

🎀 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

  • 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 💖

A generic node for providing GL vertex attributes of various types. She's the plug that gets your per-vertex data straight into the shader, no cap. 🔥

The SoVertexAttribute nodes is used with the SoShaderProgram node to send vertex attributes to the vertex shader. Like, that's literally her whole job and she ate. 💅

#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) she's feeding, bestie: 🧚

attribute vec3 color;

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

🔗 See also

  • SoVertexAttributeBinding
⚠️ 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 if you're out here expecting her in vanilla Inventor, she is simply not there. Periodt. 💀

⏳ Since

  • Coin 3.0 🌟

💖 MEMBER FUNCTION DOCUMENTATION 💖

okay so this is the part where we actually meet the methods, and honestly? this class is stacked. every one of these is a virtual you can override, so put your hair up and let's go 🎀

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

bestie this is the type ID getter. it hands you the type identification of any object derived from a class that inherits SoBase, and it's literally the whole reason run-time type checking and "downward" casting even work. iykyk ✨

usage example, verbatim, no cap:

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

now for the application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else: you need to override this method in all your subclasses. it's typically done as part of setting up the full type system for extension classes, and you usually pull that off with the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on 🦋

want more on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. it's giving required reading 💅

Implements SoBase.

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

this one does the typical operation of a node for any action. that's it, that's the vibe. ✨

Reimplemented from SoNode.

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

the action method for the SoGLRenderAction, aka the one that gets called during rendering traversals 🌈

any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. so like… if you're that girl, this is your moment 👑

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 necessary. yes, if necessary — it's not gonna do extra work for no reason, periodt.

Reimplemented from SoNode.

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

this makes a deep copy of all the data of from into this instance, except external scenegraph references if copyconnections is FALSE. 💀

this is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses that need to account for internal data which isn't handled automatically.

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

the same also goes for engines, fr fr.

and bestie, listen — when you override the copyContents() method in your extension class, you must also make it call upwards to its parent superclass in the inheritance hierarchy. copyContents() in, for instance, SoNode and SoFieldContainer does important work, and skipping it is not the move 🙈 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 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 🔔 like a little group chat ping for everyone watching this node.

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 🗂️

it reads a definition of an instance from the input stream in. the input stream state points to the start of a serialized / persistant representation of an instance of this class type. (yes, the original spells it "persistant", and we respect the source code's spelling choices around here 💅)

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. and the import process should be robust — it should handle corrupted input streams by returning FALSE. no crashing out, we're graceful 😌

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.

okay that's a wrap bestie!! 🎀 this whole page came straight out of the Coin source code and it's from Version 3.1.3, auto-generated by Doxygen so nobody hand-wrote it and honestly you can kind of tell 😭 go forth and override your virtuals responsibly, mwah 💖

📦 where this page comes from