SoGVRShaderParameterDirection

InventorModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll SoGVR
definition SoGVRShaderPipeline.def
see also SoGVRVolumeRenderer
keywords pipeline

Purpose

The SoGVRShaderParameterDirection module adds a directional shader parameter (aka uniform) to the scene. Directions are special in that they are transformed using the inverse-transposed of the transformation matrix to preserve the direction in non-uniform scaled transforms.

Usage

The direction is specified in either world or eye (aka camera) coordinates. It is available in the GVR shader and can be used in any SoGVRShaderFunction.

The parameter is available in various coordinate systems, which are appended as suffixes to its Name.

suffix coordinate system
_eye eye/camera coordinates
_world world coordinates
_voxel voxel coordinates
_scaledVoxel scaled voxel coordinates (voxel coordinates multiplied by voxel size)

Windows

Default Panel

../../../Modules/Inventor/SoGVR/mhelp/Images/Screenshots/SoGVRShaderParameterDirection._default.png

Output Fields

self

name: self, type: SoNode

Place the output into any Open Inventor scene in front of a SoGVRVolumeRenderer.

Parameter Fields

Field Index

Coordinate System: Enum
Direction: Vector3
Enabled: Bool
Name: String
Normalize: Bool

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

Enables the module.

Name

name: name, type: String

Defines the base name of the parameter in the shader, it becomes available in the SoGVRShaderFunction via name_eye, name_world, name_voxel and name_scaledVoxel.

Coordinate System

name: coordinateSystem, type: Enum, default: WorldCoordinates

Defines the source coordinate system in which the Direction is given.

Values:

Title Name Description
World Coordinates WorldCoordinates World coordinates
Eye Coordinates EyeCoordinates Eye/Camera coordinate system

Direction

name: direction, type: Vector3, default: 0 0 1

Defines the direction parameter.

Normalize

name: normalize, type: Bool, default: TRUE

If enabled, the direction is normalized in all provided coordinates systems.