SoDirectVizShader Class Reference
[DirectViz]

DirectViz DirectViz shader node base class. More...

#include <Inventor/DirectViznodes/SoDirectVizShader.h>

Inheritance diagram for SoDirectVizShader:
SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject SoDirectVizCameraShader SoDirectVizEnvironmentShader SoDirectVizGeneralShader

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoDirectVizShader ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFString file
SoSFString name
SoMFString options

Detailed Description

DirectViz DirectViz shader node base class.

Base class for specifying shader and associated options for DirectViz ray-traced rendering. It provides a generic interface to OpenRTRT(tm) shaders. Note: use the appropriate derived class depending on the shader type (i.e., SoDirectVizGeneralShader for surface shaders, or SoDirectVizEnvironmentShader). See the Open Inventor by FEI User's Guide for descriptions of the shaders supported by DirectViz and reference information about available shader options.

SEE ALSO

SoDirectVizManager

Deprecated:

Deprecated since Open Inventor 9500
No longer supported.

Constructor & Destructor Documentation

SoDirectVizShader::SoDirectVizShader (  ) 

Constructor.


Member Function Documentation

static SoType SoDirectVizShader::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoNode.

Reimplemented in SoDirectVizCameraShader, SoDirectVizEnvironmentShader, and SoDirectVizGeneralShader.

virtual SoType SoDirectVizShader::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Reimplemented in SoDirectVizCameraShader, SoDirectVizEnvironmentShader, and SoDirectVizGeneralShader.


Member Data Documentation

Name of OpenRTRT dynamic library containing the shader code.

Always use ".so" extensions for UNIX compatibility (automatically transformed into ".dll" on Windows platforms). For instance use "libRTX.so" for RTX shaders; use "libDTX.so" for DTX shaders. If this field is not set (null string), DirectViz will try to guess the appropriate library depending on the current shader package, as defined by environment variable DIRECTVIZ_RENDERING_OBJECT. See SoPreferences.

Name of the shader to use.

These strings specify parameters to the shader.

The syntax is:
<parameter type> <parameter name> <parameter value>

Allowed types are:

1i One integer
2i Two integers
3i Three integers
1f One float
2f Two floats
3f Three floats
color Same as 3f
bool Same as 1i
texture File path

Example:

     options [ "bool isVisible true" , "1i upDirection 1" , "3f intensity 0.65 0.5899 0.5899  "]
    

Any trailing part of the string that does not correspond to a parameter is ignored.

When specifying a shader, it may not be necessary to specify values for all available parameters. If a parameter is not specified by the user, the default value will be used. See version 6.1 of the Open Inventor by FEI User's Guide for more information.


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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/