Coin Logo http://www.sim.no
http://www.coin3d.org

SoShaderObject Class Reference

#include <Inventor/nodes/SoShaderObject.h>

Inheritance diagram for SoShaderObject:

SoNode SoFieldContainer SoBase SoFragmentShader SoGeometryShader SoVertexShader

List of all members.

Public Types

enum  SourceType { ARB_PROGRAM, CG_PROGRAM, GLSL_PROGRAM, FILENAME }

Public Member Functions

virtual SoType getTypeId (void) const
virtual void GLRender (SoGLRenderAction *action)
virtual void search (SoSearchAction *action)
void updateParameters (SoState *state)
SourceType getSourceType (void) const
SbString getSourceProgram (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoSFBool isActive
SoSFEnum sourceType
SoSFString sourceProgram
SoMFNode parameter

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 SoShaderObject (void)
virtual ~SoShaderObject ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoShaderObject class is the superclass for all shader classes in Coin.

See Shaders in Coin for more information on how to set up a scene graph with shaders.

See also:
SoShaderProgram
Since:
Coin 2.5

Member Enumeration Documentation

Used for enumerating the shader types in sourceProgram.

Enumerator:
ARB_PROGRAM  Specifies an ARB shader.
CG_PROGRAM  Specifies a Cg shader program.
GLSL_PROGRAM  Specifies a GLSL program.
FILENAME  Shader should be loaded from the file in sourceProgram.


Constructor & Destructor Documentation

SoShaderObject::SoShaderObject ( void   )  [protected]

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

Destructor


Member Function Documentation

SoType SoShaderObject::getClassTypeId ( void   )  [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNode.

Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.

SoType SoShaderObject::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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.

Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.

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

Reimplemented from SoNode.

Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.

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

Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.

void SoShaderObject::initClass ( void   )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.

void SoShaderObject::GLRender ( SoGLRenderAction action  )  [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

Reimplemented in SoGeometryShader.

Referenced by SoGeometryShader::GLRender().

void SoShaderObject::search ( SoSearchAction action  )  [virtual]

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.

See also:
SoSearchAction

Reimplemented from SoNode.

References SoMField::getNum(), SoAction::getPathCode(), SoSearchAction::isFound(), parameter, SoAction::popCurPath(), SoAction::pushCurPath(), and SoNode::search().

void SoShaderObject::updateParameters ( SoState state  ) 

Used internally to update shader paramters.

References SoFieldContainer::get().

SoShaderObject::SourceType SoShaderObject::getSourceType ( void   )  const

Returns the shader type detected in sourceProgram.

SbString SoShaderObject::getSourceProgram ( void   )  const

Returns the actual shader program.

SbBool SoShaderObject::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.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

References SoInput::getDirectories(), and SoNode::readInstance().


Member Data Documentation

Enabled/disables the shader. Default value is TRUE.

Referenced by SoGeometryShader::GLRender(), and SoShaderObject().

The type of shader.

Referenced by SoShaderObject().

The shader program, or a file name if the shader should be loaded from a file. If the shader is loaded from a file, the shader type is identified by the file extension. .glsl for GLSL shaders, .cg for Cg shaders, and .vp and .fp for ARB shaders.

Referenced by SoShaderObject().

The shader program parameters.

Referenced by search(), and SoShaderObject().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:00 2009 for Coin by Doxygen. 1.5.8