SoShaderParameter3f(3)

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

🎀 NAME 🎀

SoShaderParameter3f — bestie, this is from the Coin manual, section 3 (that's the library-calls corner of the world, iykyk) ✨

Okay so here's the vibe: the SoShaderParameter3f class is literally the thing you use to define a three-dimensional floating point value as a shader parameter. That's it, that's the whole job. Three floats, one shader parameter, no cap. 🦋

Main character energy: it shows up in your scene graph, it carries a triple of floating point numbers, and it hands them over to your shader like the absolute icon it is. 💅

more coming in part 2, don't go anywhere 💖

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoUniformShaderParameter.

💅 Public Member Functions

  • virtual SoType getTypeId (void) const — grabs you the SoType for this bad boy, standard Coin ritual, no cap.
  • virtual void updateParameter (SoGLShaderObject *shaderObject) — pushes your shader parameter into the OpenGL state using whatever's chillin' in the value field. That's literally its whole job. Iconic.

🫶 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 doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • 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 write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *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 TRUE if this object's type is either the same as type or inherited from it. So like, family tree check. 💖
  • 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) — returns the SoType object for this class, classic static move.
  • static void initClass () — sets up initialization for data that every instance of this class shares, like submitting the necessary info to the Coin type system. Do it once, thank me later. ✨

💜 Static Public Member Functions inherited from SoUniformShaderParameter

  • static SoType getClassTypeId (void)
  • 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 Public Member Functions inherited from SoShaderParameter

  • static SoType getClassTypeId (void)
  • static void initClass () — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🌈 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

  • SoSFVec3f value — the actual three-float value, the whole point of the plot. 🫶

🌺 Public Attributes inherited from SoShaderParameter

  • SoSFString name
  • SoSFInt32 identifier

🧚 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const

🔥 Protected Member Functions inherited from SoUniformShaderParameter

  • SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext)
  • void ensureParameter (SoGLShaderObject *shader)

🍓 Protected Member Functions inherited from SoShaderParameter

  • SoShaderParameter ()
  • virtual ~SoShaderParameter ()

💜 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 SoUniformShaderParameter

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoShaderParameter

  • 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

  • Public Types inherited from SoNode — the enum, bestie:
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 — more enum goodness:
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 and static int nextActionMethodIndex = 0

📖 Detailed Description 📖

The SoShaderParameter3f class is used to define a three-dimensional floating point value as shader parameter. That's it, that's the whole serve. 💅

✨ Member Function Documentation ✨

okay bestie, this is the part where we meet the actual functions — the little guys doing the work 💅 each one gets its own lil moment, and yes we're going through all of them, no skipping, no "tl;dr", periodt.

🌸 SoType SoShaderParameter3f::getClassTypeId (void ) [static]

This is a static method and what it does is return the SoType object that's associated with objects of this class. that's it, that's the whole job 🫶 it's giving "class-wide ID card".

🦋 SoType SoShaderParameter3f::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class that inherits SoBase. what's it for? runtime type checking and "downward" casting, iykyk — it's how the library figures out what something actually is while everything's running.

Reimplemented from SoUniformShaderParameter. so if you're tracing the family tree, that's the parent it came from 💜

🎀 const SoFieldData ** SoShaderParameter3f::getFieldDataPtr (void ) [static], [protected]

ngl, this one is internal. the manpage says it's "considered internal to the library, as it is not likely to be of interest to the application programmer." so like… not for you bestie, it's for the library's own business 🙈

Returns the SoFieldData class which holds information about fields in this node. that's the whole vibe.

⭐ const SoFieldData * SoShaderParameter3f::getFieldData (void ) const [protected], [virtual]

This one hands you back a pointer to the class-wide field data storage object for this instance. and heads up — if there are no fields present, it returns NULL. not zero, not vibes, literally NULL 😭

Reimplemented from SoUniformShaderParameter, again 💅

🔥 void SoShaderParameter3f::updateParameter (SoGLShaderObject * shaderObject) [virtual]

THE main character function, honestly 👑 it updates the shader parameter in the OpenGL state using the content of the value field. that's the one that actually pushes your number out into the world.

Implements SoUniformShaderParameter. slay.

💖 Member Data Documentation 💖

🍓 SoSFVec3f SoShaderParameter3f::value

The shader parameter value. that's the data, that's the tea, that's literally what all of the above is fussing over ✨ a SoSFVec3f, no less — three floats, bestie, three whole floats.

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. so like, not a human, a robot did this, and honestly? it ate. no cap.

and that's the whole page, we made it 🎉 this was Coin documentation, Version 4.0.10, dated Thu Jun 25 2026 00:00:00, filed under SoShaderParameter3f(3) — go forth and set your shader params, bestie, you're gonna do amazing 💅🦋💖

📦 where this page comes from