SoShaderParameter.3coin3 man page

SoShaderParameter —


#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoNode.

Inherited by SoUniformShaderParameter.

Public Member Functions

virtual SoType getTypeId (void) const

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass ()

Public Attributes

SoSFString name

SoSFInt32 identifier

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

SoShaderParameter ()

virtual ~SoShaderParameter ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

Detailed Description

The SoShaderParameter class is the base class for all shader parameter classes.

In addition to the name and identifier field, all subclasses have a value field which is used for specifying the parameter value.

Constructor & Destructor Documentation

SoShaderParameter::SoShaderParameter (void) [protected]


SoShaderParameter::~SoShaderParameter () [protected], [virtual]


Member Function Documentation

SoType SoShaderParameter::getClassTypeId (void) [static]

SoSFString SoShaderParameter::name

The shader parameter name. Used for Cg and GLSL programs.

SoSFInt32 SoShaderParameter::identifier

The shader parameter identifier. Used for ARB shader programs.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined 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 information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData * SoShaderParameter::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 SoFieldContainer.


Generated automatically by Doxygen for Coin from the source code.


Coin Version 3.1.3 Mon Sep 5 2016