| SoShaderStateMatrixParameter(3) | Coin | SoShaderStateMatrixParameter(3) | 
NAME
SoShaderStateMatrixParameter - The SoShaderStateMatrixParameter class is used to define a matrix as shader parameter whose content is derived from the traversal state.
SYNOPSIS
#include <Inventor/nodes/SoShaderParameter.h>
Inherits SoUniformShaderParameter.
Public Types
enum MatrixType { MODELVIEW, PROJECTION,
    TEXTURE, MODELVIEW_PROJECTION }
  
  enum MatrixTransform { IDENTITY, TRANSPOSE,
    INVERSE, INVERSE_TRANSPOSE }
  
  
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
  
  virtual void updateParameter (SoGLShaderObject *shaderObject)
  
  Updates the shader parameter in the OpenGL state with the content of the value
    field. virtual void updateValue (SoState *state)
  
  
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
  
  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 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
    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
SoSFEnum matrixType
  
  SoSFEnum matrixTransform
  
  
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)
  
  
Protected Attributes
SbMatrix value
  
  
Protected Attributes inherited from SoNode
  
  SbUniqueId uniqueId
  
  
Protected Attributes inherited from SoFieldContainer
  
  SbBool isBuiltIn
  
  
Additional Inherited Members
Protected Types inherited from SoBase
  
  enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
  
  
Static Protected Attributes inherited from SoNode
  
  static SbUniqueId nextUniqueId = 1
  
  static int nextActionMethodIndex = 0
  
  
Detailed Description
The SoShaderStateMatrixParameter class is used to define a matrix as shader parameter whose content is derived from the traversal state.
Unlike other parameter classes, SoShaderStateMatrixParameter does not have a value field. The value member is protected and updated automatically from the traversal state.
Member Enumeration Documentation
enum SoShaderStateMatrixParameter::MatrixType
Defines the different matrix types.
enum SoShaderStateMatrixParameter::MatrixTransform
Defines different transformations that can be applied to a matrix.
Member Function Documentation
SoType SoShaderStateMatrixParameter::getClassTypeId (void ) [static]
This static method returns the SoType object associated with objects of this class.
SoType SoShaderStateMatrixParameter::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.
Reimplemented from SoUniformShaderParameter.
const SoFieldData ** SoShaderStateMatrixParameter::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 * SoShaderStateMatrixParameter::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 SoUniformShaderParameter.
void SoShaderStateMatrixParameter::updateParameter (SoGLShaderObject * shaderObject) [virtual]
Updates the shader parameter in the OpenGL state with the content of the value field.
Implements SoUniformShaderParameter.
void SoShaderStateMatrixParameter::updateValue (SoState * state) [virtual]
Updates matrix value from state
Member Data Documentation
SoSFEnum SoShaderStateMatrixParameter::matrixType
Defines the matrix type value for the uniform shader variable.
SoSFEnum SoShaderStateMatrixParameter::matrixTransform
Defines a transformation that is applied to the matrix value. The default value of IDENTITY keeps the value unchanged.
Author
Generated automatically by Doxygen for Coin from the source code.
| Mon Sep 1 2025 19:16:41 | Version 4.0.5 |