vrdVolumeScatterMaterial¶
-
class
vrdVolumeScatterMaterial¶
(Inherits vrdVolumeMaterial)
This class is used to handle all volume scatter material properties.
Summary¶
- Functions:
- getEnableFalloff() → bool
- getFalloffOffset() → QVector3D
- getFalloffRate() → float
- getFalloffScale() → QVector3D
- getGradientCoefficient() → float
- getNoiseFrequency() → QVector3D
- getNoiseGain() → float
- getNoiseLacunarity() → float
- getNoiseMode() → vrdVolumeScatterMaterial.NoiseMode
- getNoiseTime() → float
- getNumNoiseOctaves() → integer
- getUseGlobalNoise() → bool
- setEnableFalloff(enable)
- setFalloffOffset(offset)
- setFalloffRate(rate)
- setFalloffScale(scale)
- setGradientCoefficient(coefficient)
- setNoiseFrequency(freq)
- setNoiseGain(gain)
- setNoiseLacunarity(lacunarity)
- setNoiseMode(mode)
- setNoiseTime(time)
- setNumNoiseOctaves(num)
- setUseGlobalNoise(use)
Functions¶
-
vrdVolumeScatterMaterial.getEnableFalloff()¶ Gets whether volume falloff is enable for a smoother transition along the volumes edges.
Returns: false if is not enabled, true if it is Return type: bool
-
vrdVolumeScatterMaterial.getFalloffOffset()¶ Gets the origin of the falloff.
-1: Starts at the bottom of the given axis. +1: Starts at the top of the given axis.
Returns: Current offset Return type: QVector3D
-
vrdVolumeScatterMaterial.getFalloffRate()¶ Gets the falloff rate.
Returns: Current rate Return type: float
-
vrdVolumeScatterMaterial.getFalloffScale()¶ Gets the amount of falloff of each dimension.
Returns: Current scale Return type: QVector3D
-
vrdVolumeScatterMaterial.getGradientCoefficient()¶ Gets the gradient coefficent of the noise.
The gradient of the current noies octave can be used to offset the lookup of the noise value of the next octave. The gradient coefficient scales that effect.
Returns: Current gradient coefficient Return type: float
-
vrdVolumeScatterMaterial.getNoiseFrequency()¶ Gets the frequency of the noise in X,Y and Z.
Returns: Current frequency Return type: QVector3D
-
vrdVolumeScatterMaterial.getNoiseGain()¶ Gets the gain of the noise.
The gain remaps the noise values to either increase or decrease the spread of values.
Returns: Current gain Return type: float
-
vrdVolumeScatterMaterial.getNoiseLacunarity()¶ Gets the lacunarity of the noise.
The lacunariy is the rate at which the frequency increases between successive octaves of noise
Returns: Current lacunarity Return type: float
-
vrdVolumeScatterMaterial.getNoiseMode()¶ Gets the noise mode.
Returns: The current noise mode Return type: vrdVolumeScatterMaterial.NoiseMode
-
vrdVolumeScatterMaterial.getNoiseTime()¶ Gets the time at which the noise is evaluated.
Returns: Current time Return type: float
-
vrdVolumeScatterMaterial.getNumNoiseOctaves()¶ Gets the number of layers of noise, where each successive layer has a greater frequency and a smaller amplitude.
Returns: Current number of octaves Return type: integer
-
vrdVolumeScatterMaterial.getUseGlobalNoise()¶ Gets the noise to either be defined in the volume’s local space or global scene space.
Returns: True if the noise uses global scene space coordinates, false if otherwise Return type: bool
-
vrdVolumeScatterMaterial.setEnableFalloff(enable)¶ Sets whether volume falloff is enable for a smoother transition along the volumes edges.
Parameters: enable (bool) – New value to enable or disable volume falloff
-
vrdVolumeScatterMaterial.setFalloffOffset(offset)¶ Sets the origin of the falloff.
-1: Starts at the bottom of the given axis. +1: Starts at the top of the given axis.
Parameters: offset (QVector3D) – New offset
-
vrdVolumeScatterMaterial.setFalloffRate(rate)¶ Sets the falloff rate.
Parameters: rate (float) – New rate
-
vrdVolumeScatterMaterial.setFalloffScale(scale)¶ Sets the amount of falloff of each dimension.
Parameters: scale (QVector3D) – New scale
-
vrdVolumeScatterMaterial.setGradientCoefficient(coefficient)¶ Sets the gradient coefficent of the noise.
The gradient of the current noies octave can be used to offset the lookup of the noise value of the next octave. The gradient coefficient scales that effect.
Parameters: coefficient (float) – New gradient coefficient
-
vrdVolumeScatterMaterial.setNoiseFrequency(freq)¶ Sets the frequency of the noise in X,Y and Z.
Parameters: freq (QVector3D) – New frequency
-
vrdVolumeScatterMaterial.setNoiseGain(gain)¶ Sets the gain of the noise.
The gain remaps the noise values to either increase or decrease the spread of values.
Parameters: gain (float) – New gain
-
vrdVolumeScatterMaterial.setNoiseLacunarity(lacunarity)¶ Sets the lacunarity of the noise.
Parameters: lacunarity (float) – New lacunarity
-
vrdVolumeScatterMaterial.setNoiseMode(mode)¶ Sets the noise mode.
Parameters: mode (vrdVolumeScatterMaterial.NoiseMode) – The new noise mode
-
vrdVolumeScatterMaterial.setNoiseTime(time)¶ Sets the time at which the noise is evaluated.
Parameters: time (float) – New time
-
vrdVolumeScatterMaterial.setNumNoiseOctaves(num)¶ Sets the number of layers of noise, where each successive layer has a great frequency and a smaller amplitude.
Parameters: num (integer) – New number of octaves
-
vrdVolumeScatterMaterial.setUseGlobalNoise(use)¶ Sets the noise to either be defined in the volume’s local space or global scene space.
Parameters: use (bool) – new state