Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoShaderStateMatrixParameter Class Reference

VSG extension Uniform shader parameter node storing an OpenGL state matrix. More...

#include <Inventor/nodes/SoShaderParameter.h>

+ Inheritance diagram for SoShaderStateMatrixParameter:

Public Types

enum  MatrixType {
  MODELVIEW ,
  PROJECTION ,
  TEXTURE ,
  MODELVIEW_PROJECTION
}
 Matrix type possible values. More...
 
enum  MatrixTransform {
  IDENTITY ,
  TRANSPOSE ,
  INVERSE ,
  INVERSE_TRANSPOSE
}
 Matrix transformation possible values. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoShaderStateMatrixParameter ()
 Constructor.
 
virtual bool isEqual (const SoUniformShaderParameter *param) const
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoUniformShaderParameter
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShaderParameter
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFEnum matrixType
 Specifies the type of the state matrix.
 
SoSFEnum matrixTransform
 Specifies the transformation to be applied to the state matrix.
 
- Public Attributes inherited from SoShaderParameter
SoSFString name
 Specifies the parameter's string name which is declared and used within high-level shading programs.
 
SoSFInt32 identifier
 Specifies the parameter's integer name which is declared and used within low-level shading programs.
 

Detailed Description

VSG extension Uniform shader parameter node storing an OpenGL state matrix.

This node allows the application to provide a uniform parameter of type OpenGL state matrix to a shader object, e.g. SoFragmentShader.

Uniform shader parameter nodes are usually added to the shader object's parameter field to affect only that specific shader program, but can also be inserted in the scene graph and affect all subsequent shader programs.

See the base classes SoShaderParameter and SoUniformShaderParameter for details.

This parameter should be only used with NVIDIA Cg (has no effect otherwise) and only if the profile is neither arbvp1 nor arbfp1. With either of the profiles arbvp1 and arbfp1, the OpenGL state matrix is directly accessible from the variable glstate.matrix.

NOTE: Using this parameter may slow down the rendering process because each SoTransform node in the scene graph below the SoShaderProgram will break the render cache.

FILE FORMAT/DEFAULT

    ShaderStateMatrixParameter {
    name ""
    identifier 0
    matrixType MODELVIEW
    matrixTransform 1 0 0 0
    0 1 0 0
    0 0 1 0
    0 0 0 1
    shaderType VERTEX
    }

SEE ALSO

SoShaderParameter, SoUniformShaderParameter, SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameter4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, SoShaderObject, SoShaderProgram.

Definition at line 1726 of file SoShaderParameter.h.

Member Enumeration Documentation

◆ MatrixTransform

Matrix transformation possible values.

Enumerator
IDENTITY 

The state matrix is unchanged (default).

TRANSPOSE 

Transpose the state matrix.

INVERSE 

Invert the state matrix.

INVERSE_TRANSPOSE 

Invert the transposed state matrix.

Definition at line 1756 of file SoShaderParameter.h.

◆ MatrixType

Matrix type possible values.

Enumerator
MODELVIEW 

The state matrix is the modelview matrix.

PROJECTION 

The state matrix is the the projection matrix.

TEXTURE 

The state matrix is the current texture matrix.

MODELVIEW_PROJECTION 

The state matrix is the modelview projection matrix (default value).

Definition at line 1733 of file SoShaderParameter.h.

Constructor & Destructor Documentation

◆ SoShaderStateMatrixParameter()

SoShaderStateMatrixParameter::SoShaderStateMatrixParameter ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoShaderStateMatrixParameter::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoShaderStateMatrixParameter::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoUniformShaderParameter.

◆ isEqual()

virtual bool SoShaderStateMatrixParameter::isEqual ( const SoUniformShaderParameter param) const
virtual

Member Data Documentation

◆ matrixTransform

SoSFEnum SoShaderStateMatrixParameter::matrixTransform

Specifies the transformation to be applied to the state matrix.

Definition at line 1786 of file SoShaderParameter.h.

◆ matrixType

SoSFEnum SoShaderStateMatrixParameter::matrixType

Specifies the type of the state matrix.

Definition at line 1781 of file SoShaderParameter.h.


The documentation for this class was generated from the following file: