SoPathTracerVolumeBase
-
InventorModule
-
Purpose
The SoPathTracerVolumeBase
provides basic settings for volumes and volume instances.
Parameter Fields
Hidden Fields
enabled
-
name:
enabled
, type:
Bool
, default:
TRUE
If checked, the loading of the volume is enabled.
enableVolumeRendering
-
name:
enableVolumeRendering
, type:
Bool
, default:
TRUE
If checked, the rendering of the volume is enabled.
If the volume should only be used by other modules like SoPathTracerVolumeInstance
, SoPathTracerIsoSurface
, or SoPathTracerSlice
, it makes sense to set this to false and let the other modules do the rendering.
maskVolumeName
-
name:
maskVolumeName
, type:
String
, default:
mask
Sets the name of the mask volume to use.
The renderer looks for a SoPathTracerMaskVolume
with the specified volumeName and uses it if found.
tagVolumeName
-
name:
tagVolumeName
, type:
String
, default:
tags
Sets the name of the tag volume to use.
The renderer looks for a SoPathTracerTagVolume
with the specified volumeName and uses it if found.
timePoint
-
name:
timePoint
, type:
Integer
, default:
0
Sets the time point of the input dataset.
maskColor0
-
name:
maskColor0
, type:
Color
, default:
1 0 0
Sets the outside mask color.
maskColor1
-
name:
maskColor1
, type:
Color
, default:
1 1 1
Sets the inside mask color.
maskAlpha0
-
name:
maskAlpha0
, type:
Float
, default:
0
Sets the outside mask alpha.
maskAlpha1
-
name:
maskAlpha1
, type:
Float
, default:
1
Sets the inside mask alpha.
maskTag0
-
name:
maskTag0
, type:
Integer
, default:
0
Sets the tag offset that should be added to the tag value when outside the mask.
This allows for using per-tag effects on the inside and outside of the mask volume.
maskTag1
-
name:
maskTag1
, type:
Integer
, default:
0
Sets the tag offset that should be added to the tag value when inside the mask.
This allows for using per-tag effects on the inside and outside of the mask volume.
stepSizeFactor
-
name:
stepSizeFactor
, type:
Float
, default:
3
Sets the step size for ray marching (1 indicates the best quality).
stepSizeFactorShadow
-
name:
stepSizeFactorShadow
, type:
Float
, default:
3
Sets the step size for shadow rays (1 indicates the best quality)
selfShadowingOffset
-
name:
selfShadowingOffset
, type:
Float
, default:
1
Sets the shadow offset that is used to avoid self-shadowing.
transposeAdditionalMatrix
-
name:
transposeAdditionalMatrix
, type:
Bool
, default:
TRUE
If checked, the additional matrix is transposed to accommodate both Inventor and ML matrices.
additionalMatrix
-
name:
additionalMatrix
, type:
Matrix
, default:
1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1
Sets an additional transformation matrix.
This matrix can be updated without performance impact, allowing for arbitrary affine transformations of the volume (for example, for registration purposes).
enableClipping
-
name:
enableClipping
, type:
Bool
, default:
TRUE
If checked, Open Inventor clipping planes affect the volume.
flipClipping
-
name:
flipClipping
, type:
Bool
, default:
FALSE
If checked, the Open Inventor clipping planes are flipped before being applied to the volume.
subVolumeStartX
-
name:
subVolumeStartX
, type:
Integer
, default:
0
Sets the start in the x-direction of the subvolume (in voxels).
subVolumeStartY
-
name:
subVolumeStartY
, type:
Integer
, default:
0
Sets the start in the y-direction of the subvolume (in voxels).
subVolumeStartZ
-
name:
subVolumeStartZ
, type:
Integer
, default:
0
Sets the start in the z-direction of the subvolume (in voxels).
subVolumeEndX
-
name:
subVolumeEndX
, type:
Integer
, default:
999999
Sets the end in the x-direction of the subvolume (in voxels).
subVolumeEndY
-
name:
subVolumeEndY
, type:
Integer
, default:
999999
Sets the end in the y-direction of the subvolume (in voxels).
subVolumeEndZ
-
name:
subVolumeEndZ
, type:
Integer
, default:
999999
Sets the end in the z-direction of the subvolume (in voxels).
subVolumeUseWorldPositions
-
name:
subVolumeUseWorldPositions
, type:
Bool
, default:
FALSE
If checked, the subvolume is given in world positions.
Otherwise, it is given in voxel positions.
subVolumeWorldStart
-
name:
subVolumeWorldStart
, type:
Vector3
, default:
0 0 0
Sets the start of the subvolume (in world coordinates).
subVolumeWorldEnd
-
name:
subVolumeWorldEnd
, type:
Vector3
, default:
0 0 0
Sets the end of the subvolume (in world coordinates).
tracingMethod
-
name:
tracingMethod
, type:
Enum
, default:
Tracing_RayMarching
Defines the tracing method.
Values:
Title |
Name |
Description |
Woodcock |
Tracing_Woodcock |
Use Woodcock/delta tracking. |
Ray Marching |
Tracing_RayMarching |
Use ray marching. |
shaderType
-
name:
shaderType
, type:
Enum
, default:
Shader_Hybrid
Defines the shader type. This can be overridden in a SoPathTracerMaterial
.
Values:
Title |
Name |
Description |
Phase |
Shader_Phase |
Use the isotropic phase function (gradients of the volume are not used). |
Brdf |
Shader_Brdf |
Use the material BRDF (gradients of the volume are used for shading). |
Hybrid |
Shader_Hybrid |
Switch between phase function and BRDF depending on gradient magnitude. The gradient magnitude is scaled by the gradientFactor parameter. |
gradientFactor
-
name:
gradientFactor
, type:
Float
, default:
3
Sets the gradient factor that scales with the gradient magnitude; this only affects the hybrid shading mode.