SoVolumeShader.ShaderPositions

java.lang.Object
- java.lang.Enum<SoVolumeShader.ShaderPositions>
- - com.openinventor.volumeviz.nodes.SoVolumeShader.ShaderPositions

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoVolumeShader.ShaderPositions>

Enclosing class:

SoVolumeShader
```
public static enum SoVolumeShader.ShaderPositions
extends java.lang.Enum<SoVolumeShader.ShaderPositions>
implements IntegerValuedEnum
```
Specifies the position of the shader pipeline stages in the field shaderObject. In other words, use these enumeration values for the first parameter of the set1Value() method when setting a custom shader in the SoVolumeShader node.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CLIPPING_FUNCTION` This method can be used to implement a custom clipping algorithm.
`CUSTOM_SHADER` This position and all subsequent positions CUSTOM_SHADER+x are freely available for user-defined shaders.
`DATA_COMBINE_FUNCTION` This shader is used for GPU multi-data composition.
`FRAGMENT_COMPUTE_COLOR` This shader is used to compute the current fragment color.
`FRAGMENT_MAIN` Main fragment shader used for rendering.
`GEOMETRY_MAIN` The main geometry program used for rendering.
`GET_DATA_FUNCTION` This shader is used to access datasets.
`VERTEX_MAIN` Main vertex shader used for rendering.
`VERTEX_POSTPROCESSING` Method called at the end of the VolumeViz vertex shader stage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static SoVolumeShader.ShaderPositions`	`fromValue(int val)` Deprecated. Use `valueOf(int)` instead.
`int`	`getValue()` Returns the integer value of the enum constant.
`static SoVolumeShader.ShaderPositions`	`valueOf(int val)` Returns the enum constant of this type with the specified integer value
`static SoVolumeShader.ShaderPositions`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static SoVolumeShader.ShaderPositions[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - GEOMETRY_MAIN
```
public static final SoVolumeShader.ShaderPositions GEOMETRY_MAIN
```
    The main geometry program used for rendering. Notes: Defining a custom GEOMETRY_MAIN slot is only supported for compatibility. It is not compatible with the raycasting volume rendering technique that is now the default for SoVolumeRender. If you must use this slot, set the raycasting field to false.
  - DATA_COMBINE_FUNCTION
```
public static final SoVolumeShader.ShaderPositions DATA_COMBINE_FUNCTION
```
    This shader is used for GPU multi-data composition. It must contain an application defined data combining function whose prototype is:
```
 VVIZ_DATATYPE VVizCombineData(in vec3 dataCoord);
```
    The subtraction of two volumes can be written in GLSL like this:
```
 // !oiv_include <VolumeViz/vvizGetData_frag.h>
 // !oiv_include <VolumeViz/vvizCombineData_frag.h>
 
 uniform VVizDataSetId dataId1;
 uniform VVizDataSetId dataId2;
 
 VVIZ_DATATYPE VVizCombineData(vec3 tcoord)
 {
   VVIZ_DATATYPE d1 = VVizGetData(dataId1, tcoord);
   VVIZ_DATATYPE d2 = VVizGetData(dataId2, tcoord);
   return d1-d2;
 }
```
    NOTE: On the GPU, voxel values are always returned as a normalized value in the range 0..1. If the actual voxel value is needed, the shader function must compute that value using the current data range (see SoDataRange). The application must pass the data range to the shader function as a uniform parameter.
    See VolumeVizFragmentShaders for more details.
  - GET_DATA_FUNCTION
```
public static final SoVolumeShader.ShaderPositions GET_DATA_FUNCTION
```
    This shader is used to access datasets. It must contain an application defined data accessor function whose prototype is:
```
 VVIZ_DATATYPE VVizGetData(in VVizDataSetId dataset, in vec3 dataCoord);
```
    The default implementation is defined as follows:
```
 // !oiv_include <VolumeViz/vvizGetData_frag.h>
 
 // Default 3D DATA interpolation
 VVIZ_DATATYPE VVizGetData(VVizDataSetId tex, vec3 tcoord)
 {
   return VVizGetRawData(tex, tcoord);
 }
```
    This function can be used to apply filters on each data volume. The following example shows how to make a smoothing filter which will remove some noise:
```
 // !oiv_include <VolumeViz/vvizGetData_frag.h>
 VVIZ_DATATYPE VVizGetData(in VVizDataSetId dataset, vec3 tcoord)
 {
   vec3 voxelDim = VVizGetVoxelDimensions(dataset);
   vec3 du = vec3(voxelDim[0], 0., 0.);
   vec3 dv = vec3(0., voxelDim[1], 0.);
   vec3 dw = vec3(0., 0., voxelDim[2]);
 
  return 1./6.*(VVizGetRawData(dataset, tcoord-du).w+VVizGetRawData(dataset, tcoord+du).w+
                VVizGetRawData(dataset, tcoord-dv).w+VVizGetRawData(dataset, tcoord+dv).w+
                VVizGetRawData(dataset, tcoord-dw).w+VVizGetRawData(dataset, tcoord+dw).w);
 
 }
```
    NOTE: On the GPU, voxel values are always returned as a normalized value in the range 0..1. If the actual voxel value is needed, the shader function must compute that value using the current data range (see SoDataRange). The application must pass the data range to the shader function as a uniform parameter.
    See VolumeVizFragmentShaders for more details.
  - FRAGMENT_COMPUTE_COLOR
```
public static final SoVolumeShader.ShaderPositions FRAGMENT_COMPUTE_COLOR
```
    This shader is used to compute the current fragment color. Note: VVizComputePreIntegrated should only be called when SoVolumeRendering.renderMode is set to VOLUME_RENDERING (the default). It is not appropriate for MIN, MAX, etc composition.
    It must contain an application defined compute fragment color function whose prototype is:
```
 // For an SoVolumeRender node
 vec4 VVizComputeFragmentColor(in VVizDataSetId dataset, in vec3 rayDir, inout VVizVoxelInfo voxelInfoFront, in VVizVoxelInfo voxelInfoBack, in int mask);
```
```
 // For all other VolumeViz shape nodes (SoOrthoSlice, SoObliqueSlice, SoVolumeSkin ...)
 vec4 VVizComputeFragmentColor(in VVIZ_DATATYPE vox, in vec3 dataCoord);
```
    This function can be used to do co-blending on multiple data volumes. The following example shows how to blend two volumes:
```
 // !oiv_include <VolumeViz/vvizGetData_frag.h>
 // !oiv_include <VolumeViz/vvizTransferFunction_frag.h>
 
 uniform VVizDataSetId data1;
 uniform VVizDataSetId data2;
 
 vec4 blend(in vec3 texCoord)
 {
   VVIZ_DATATYPE index1 = VVizGetData(data1, texCoord);
   vec4 data1Color = VVizTransferFunction(index1, 0);
 
   VVIZ_DATATYPE index2 = VVizGetData(data2, texCoord);
   vec4 data2Color = VVizTransferFunction(index2, 1);
 
   // Color modulated by intensity from volume2
   data2Color.rgb *= data1Color.r;
   data2Color.a   *= data1Color.a;
   return res;
 }
 
 // Implement VVizComputeFragmentColor for slice nodes
 vec4 VVizComputeFragmentColor(VVIZ_DATATYPE vox, vec3 texCoord)
 {
  return blend(texCoord);
 }
 
 // Implement VVizComputeFragmentColor for SoVolumeRender
 vec4 VVizComputeFragmentColor(VVizDataSetId data, vec3 rayDir, inout VVizVoxelInfo voxelInfoFront, in VVizVoxelInfo voxelInfoBack, int maskId)
 {
   return blend(voxelInfoFront.texCoord);
 }
```
    See VolumeVizFragmentShaders for more details.
    Since:
    
    Open Inventor 9.0
  - VERTEX_MAIN
```
public static final SoVolumeShader.ShaderPositions VERTEX_MAIN
```
    Main vertex shader used for rendering. This stage should not be redefined unless you know exactly what you are doing. If the goal of your application is to compute specific varying attributes to pass to the fragment shader you should use the shaderPosition slot named VERTEX_POSTPROCESSING.
    Notes: Defining a custom VERTEX_MAIN slot is only supported for compatibility. It is not compatible with the raycasting volume rendering technique that is now the default for SoVolumeRender. If you must use this slot, set the raycasting field to false.
    See VolumeVizVertexShaders for more details.
  - FRAGMENT_MAIN
```
public static final SoVolumeShader.ShaderPositions FRAGMENT_MAIN
```
    Main fragment shader used for rendering. This stage should not be redefined unless you know exactly what you are doing. If the goal of your application is to blend colors or add effects to the existing pipeline you should use the shaderPosition slot named FRAGMENT_COMPUTE_COLOR.
    Notes: Defining a custom FRAGMENT_MAIN slot is only supported for compatibility. It is not compatible with the raycasting volume rendering technique that is now the default for SoVolumeRender. If you must use this slot, set the raycasting field to false.
    See VolumeVizFragmentShaders for more details.
  - VERTEX_POSTPROCESSING
```
public static final SoVolumeShader.ShaderPositions VERTEX_POSTPROCESSING
```
    Method called at the end of the VolumeViz vertex shader stage.
    This shader allows the application to generate custom varying values at the vertex shader stage for use in the fragment shader stage.
    See VolumeVizVertexShaders for more details.
    
    Since:
    
    Open Inventor 9.0
  - CLIPPING_FUNCTION
```
public static final SoVolumeShader.ShaderPositions CLIPPING_FUNCTION
```
    This method can be used to implement a custom clipping algorithm. Note that when using this method, it may not always be possible for VolumeViz to correctly manage slicing artifacts. You have to use SoVolumeRender.samplingAlignement = BOUNDARY_ALIGNED to avoid slicing artifacts.
    When applying a custom clipping function with SoVolumeRenderingQuality.voxelizedRendering = true, the voxels will be hollow.
    
    Since:
    
    Open Inventor 9.7
  - CUSTOM_SHADER
```
public static final SoVolumeShader.ShaderPositions CUSTOM_SHADER
```
    This position and all subsequent positions CUSTOM_SHADER+x are freely available for user-defined shaders.
    
    Since:
    
    Open Inventor 9.0
- Method Detail
  - values
```
public static SoVolumeShader.ShaderPositions[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SoVolumeShader.ShaderPositions c : SoVolumeShader.ShaderPositions.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SoVolumeShader.ShaderPositions valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - fromValue
```
@Deprecated
public static SoVolumeShader.ShaderPositions fromValue(int val)
```
    Deprecated. Use valueOf(int) instead.
    
    Returns the enum constant of this type with the specified integer value
    
    Returns:
    
    the enum constant of this type with the specified integer value.
  - valueOf
```
public static SoVolumeShader.ShaderPositions valueOf(int val)
```
    Returns the enum constant of this type with the specified integer value
    
    Returns:
    
    the enum constant of this type with the specified integer value.
  - getValue
```
public int getValue()
```
    Description copied from interface: IntegerValuedEnum
    
    Returns the integer value of the enum constant.
    
    Specified by:
    
    getValue in interface IntegerValuedEnum
    
    Returns:
    
    the integer value of the enum constant.

First volume	Second volume	Subtraction

Non filtered data	Filtered data

Enum SoVolumeShader.ShaderPositions

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GEOMETRY_MAIN

DATA_COMBINE_FUNCTION

GET_DATA_FUNCTION

FRAGMENT_COMPUTE_COLOR

VERTEX_MAIN

FRAGMENT_MAIN

VERTEX_POSTPROCESSING

CLIPPING_FUNCTION

CUSTOM_SHADER

Method Detail

values

valueOf

fromValue

valueOf

getValue