com.openinventor.inventor.directviznodes

Class SoDirectVizShader

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.directviznodes.SoDirectVizShader

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoDirectVizCameraShader, SoDirectVizEnvironmentShader, SoDirectVizGeneralShader, SoDirectVizLightShader, SoDirectVizRenderingObject

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoDirectVizShader
extends SoNode

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:

SoDirectVizManagerDeprecated since Open Inventor 9500
No longer supported.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFString	file Deprecated. Name of OpenRTRT dynamic library containing the shader code.
SoSFString	name Deprecated. Name of the shader to use.
SoMFString	options Deprecated. These strings specify parameters to the shader.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoDirectVizShader() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

file

public final SoSFString file

Deprecated.

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

public final SoSFString name

Deprecated.

Name of the shader to use.

options

public final SoMFString options

Deprecated.

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.

Constructor Detail

SoDirectVizShader

public SoDirectVizShader()

Deprecated.

Constructor.