Unigine::ParticleModifierScalar Class
| Header: | #include <UnigineObjects.h> |
| Inherits from: | ParticleModifier |
This class is used to represent a particle system modifier, that controls a scalar parameter (radius, velocity, etc.). Modifiers are used to control how various parameters of particle systems change over the particle's life time.
ParticleModifierScalar Class
Members
void setCurveScale ( float scale ) #
Sets a new curve scale for the modifier. The scale defines the maximum possible value for the parameter controlled by the modifier.Arguments
- float scale - Curve scale value to be set for the modifier.
float getCurveScale ( ) const#
Sets a new curve scale for the modifier. The scale defines the maximum possible value for the parameter controlled by the modifier.Return value
Current curve scale set for the modifier.void setConstant ( float constant ) #
Sets a new constant value for the modifier. In the CONSTANT modifier mode the actual value of the controlled parameter remains equal to this constant throughout the particle's lifetime.Arguments
- float constant - Constant value to be set for the modifier.
float getConstant ( ) const#
Returns the current constant value set for the modifier. In the CONSTANT modifier mode the actual value of the controlled parameter remains equal to this constant throughout the particle's lifetime.Return value
Current constant value set for the modifier.void setConstantMin ( float min ) #
Sets a new minimum constant value for the modifier. This constant defines the lower limit for the value of the controlled parameter. The actual value varies randomly between the lower and upper limits.Arguments
- float min - Minimum constant value to be set for the modifier.
float getConstantMin ( ) const#
Returns the current minimum constant value set for the modifier. This constant defines the lower limit for the value of the controlled parameter. The actual value varies randomly between the lower and upper limits.Return value
Current minimum constant value for the modifier.void setConstantMax ( float max ) #
Sets a new maximum constant value for the modifier. This constant defines the upper limit for the value of the controlled parameter. The actual value varies randomly between the lower and upper limits.Arguments
- float max - Maximum constant value to be set for the modifier.
float getConstantMax ( ) const#
Returns the current maximum constant value set for the modifier. This constant defines the upper limit for the value of the controlled parameter. The actual value varies randomly between the lower and upper limits.Return value
Current maximum constant value for the modifier.void setCurve ( const Ptr<Curve2d> & curve ) #
Sets a new curve for the modifier. The actual value of the controlled parameter is defined by this curve.Arguments
- const Ptr<Curve2d> & curve - Curve to be set for the modifier.
Ptr<Curve2d> getCurve ( ) const#
Returns the current curve set for the modifier. The actual value of the controlled parameter is defined by this curve.Return value
Current curve set for the modifier.void setCurveMin ( const Ptr<Curve2d> & min ) #
Sets a new minimum curve for the modifier. This curve defines the lower limit for the value of the controlled parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.Arguments
Ptr<Curve2d> getCurveMin ( ) const#
Returns the current minimum curve set for the modifier. This curve defines the lower limit for the value of the controlled parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.Return value
Current minimum curve set for the modifier.void setCurveMax ( const Ptr<Curve2d> & max ) #
Sets a new maximum curve for the modifier. This curve defines the upper limit for the value of the controlled parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.Arguments
Ptr<Curve2d> getCurveMax ( ) const#
Returns the current maximum curve set for the modifier. This curve defines the upper limit for the value of the controlled parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.Return value
Current maximum curve set for the modifier.float getMaxValue ( ) const#
Returns the maximum value for the modifier defining the upper limit for the value of the controlled parameter.Return value
Maximum value for the modifier.float getMinValue ( ) const#
Returns the minimum value for the modifier defining the lower limit for the value of the controlled parameter.Return value
Minimum value for the modifier.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)