Unigine::ParticleModifier Class
| Header: | #include <UnigineObjects.h> |
This is a base class for particle system modifiers. These modifiers are used to control how various parameters of particle systems (such as direction, radius, positions, etc.) change over the particle's lifetime.
There are two types of modifiers available:
ParticleModifier Class
Enums
TYPE#
Type of the modifier. Defines the type of value controlled by the modifier.| Name | Description |
|---|---|
| PARTICLE_MODIFIER_SCALAR = 0 | In this mode the modifier controls a single scalar value via a single curve. |
| PARTICLE_MODIFIER_VECTOR = 1 | In this mode the modifier controls a vector of up to 4 values via a set of curves. |
MODE#
Mode of the modifier. Defines how the controlled value is set.| Name | Description |
|---|---|
| MODE_CONSTANT = 0 | In this mode the specified value is fixed throughout the lifetime. |
| MODE_RANDOM_BETWEEN_TWO_CONSTANTS = 1 | In this mode two constants define the upper and lower limits for the value. The actual value changes randomly over time between these limits. |
| MODE_CURVE = 2 | In this mode the modifier controls each value via a single curve. |
| MODE_RANDOM_BETWEEN_TWO_CURVES = 3 | In this mode two curves define the upper and lower limits for the value at each point of the lifetime. The actual value changes randomly over time between these limits. |
| NUM_MODES = 4 | Number of particle modifier's modes. |
Members
bool isSignedValues ( ) const#
Returns a value indicating whether the value(s) controlled by the modifier are signed or unsigned.Return value
true is the value(s) controlled by the modifier are signed; otherwise, false.bool saveState ( const Ptr<Stream> & stream ) const#
Saves the current modifier state to the specified stream.Arguments
- const Ptr<Stream> & stream - Stream to which the modifier's state is to be saved.
Return value
true if the state is saved successfully; otherwise, false.bool restoreState ( const Ptr<Stream> & stream ) #
Restores a previously saved state from the specified stream.Arguments
- const Ptr<Stream> & stream - Stream from which the modifier's state is to be loaded.
Return value
true if the state is restored successfully; otherwise, false.bool save ( const Ptr<Xml> & xml ) const#
Saves the modifier's state to the specified Xml node.Arguments
- const Ptr<Xml> & xml - Xml node to which the modifier's state is to be saved.
Return value
true if the state is saved successfully; otherwise, false.bool load ( const Ptr<Xml> & xml ) #
Loads a previously saved modifier's state from the specified Xml node.Arguments
- const Ptr<Xml> & xml - Xml node from which the modifier's state is to be loaded.
Return value
true if the state is loaded successfully; otherwise, false.long long getSystemMemoryUsage ( ) const#
Returns the total amount of memory used by the modifier.Return value
Total amount of memory used by the modifier with all its keys, in bytes.ParticleModifier::TYPE getType ( ) const#
Returns the type of the particle modifier.Return value
Particle modifier type. One of the TYPE enum values.void setMode ( ParticleModifier::MODE mode ) #
Sets the mode of the particle modifier. The mode defines how the controlled value is set. You can switch modes at any time.Arguments
- ParticleModifier::MODE mode - Modifier mode to be set. One of the MODE enum values.
ParticleModifier::MODE getMode ( ) const#
Returns the current mode of the particle modifier. The mode defines how the controlled value is set. You can switch modes at any time.Return value
Current particle modifier mode. One of the MODE enum values.Last update:
2020-11-24
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)