vrdOpenVDBMaterial

class vrdOpenVDBMaterial

(Inherits vrdVolumeMaterial)

This class is used to handle all OpenVDB material properties.

Functions

vrdOpenVDBMaterial.getChannelNames()

Gets a list of available channels in the VDB.

Returns:Current list of channels
Return type:List[string]
vrdOpenVDBMaterial.getEmissionChannelIndex()

Gets the index of the emission channel.

Returns:Current index of the emission channel
Return type:integer
vrdOpenVDBMaterial.getEmissionGradient()

Gets the vrdLinearGradient object for controlling the emission color as a function of VDB grid value.

Returns:Current emission gradient
Return type:vrdLinearGradient
vrdOpenVDBMaterial.getEnableTraversalOptimization()

Gets whether the traversal optimization is enabled.

The traversal optimization begins the VDB traversal at its firsta active voxel, rather than its bounding box. This can either increase or decrease the performance depending on the VDB.

Returns:True if traversal optimization is enabled; false otherwise
Return type:bool
vrdOpenVDBMaterial.getEnableTrilinearSampling()

Gets whether trilinear sampling is enabled.

Trilinear sampling performs a smoothing trilinear interpolation of the VDB grid by interpolating over 8 VDB grid samples.

Returns:True if trilinear sampling is enabled; false otherwise
Return type:bool
vrdOpenVDBMaterial.getFrameOffset()

Gets the frame offset of the VDB sequence.

Returns:Current frame offset
Return type:integer
vrdOpenVDBMaterial.getInlineSequence()

Gets whether the VDB sequence is inlined into the project file.

Returns:True if the sequence is inlined
Return type:bool
vrdOpenVDBMaterial.getScatterAndAbsorptionChannelIndex()

Gets the index of the scatter and absorption channel.

Returns:Current index
Return type:integer
vrdOpenVDBMaterial.getSigmaE()

Gets the emission coefficient, which is the average number of emission particle interactions per meter.

Returns:Current emission coefficient
Return type:float
vrdOpenVDBMaterial.getUseSequence()

Gets whether the VDB has sequencing enabled to use of a series of VDB frames for animations, which can be controlled using the frame control and animated using the Curve Editor.

Returns:True if sequencing is enabled, false otherwise
Return type:bool
vrdOpenVDBMaterial.getVdbFilename()

Gets the currently loaded VDB filename.

Returns:Current OpenVDB filename
Return type:string
vrdOpenVDBMaterial.getVdbNumber()

Gets the current frame number of the VDB sequence.

Returns:Current frame number
Return type:integer
vrdOpenVDBMaterial.setEmissionChannelIndex(index)

Sets the index of the emission channel.

Parameters:index (integer) – New index
vrdOpenVDBMaterial.setEmissionGradient(gradient)

Sets the vrdLinearGradient object for controlling the emission color as a function of VDB grid value.

Parameters:gradient (vrdLinearGradient) – New emission gradient
vrdOpenVDBMaterial.setEnableTraversalOptimization(enable)

Sets whether the traversal optimization is enabled.

The traversal optimization begins the VDB traversal at its firsta active voxel, rather than its bounding box. This can either increase or decrease the performance depending on the VDB.

Parameters:enable (bool) – New value
vrdOpenVDBMaterial.setEnableTrilinearSampling(enable)

Sets whether trilinear sampling is enabled.

Trilinear sampling performs a smoothing trilinear interpolation of the VDB grid by interpolating over 8 VDB grid samples.

Parameters:enable (bool) – New value
vrdOpenVDBMaterial.setFrameOffset(offset)

Sets the frame offset of the VDB sequence.

Parameters:offset (integer) – New frame offset
vrdOpenVDBMaterial.setInlineSequence(value)

Sets whether the VDB sequence is inlined into the project file.

Parameters:value (bool) – New value
vrdOpenVDBMaterial.setScatterAndAbsorptionChannelIndex(index)

Sets the index of the scatter and absorption channel.

Parameters:index (integer) – New index
vrdOpenVDBMaterial.setSigmaE(sigmaE)

Sets the emission coefficient, which is the average number of emission particle interactions per meter.

Parameters:sigmaE (float) – New emission coefficient
vrdOpenVDBMaterial.setUseSequence(value)

Sets whether the VDB has sequencing enabled to use of a series of VDB frames for animations, which can be controlled using the frame control and animated using the Curve Editor.

Parameters:value (bool) – New value
vrdOpenVDBMaterial.setVdbFilename(filename)

Sets the VDB filename to be loaded.

Parameters:filename (string) – New VDB filename
vrdOpenVDBMaterial.setVdbNumber(vdbNumber)

sets the current frame number of the VDB sequence

Parameters:vdbNumber (integer) – New frame number