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:

Scalar - used for scalar parameters (radius, velocity, etc.). The majority of particle system modifiers belong to this type.
Vector - used for vector parameters (direction, position, etc.)

Methods:

Name	Description View: Sort by:
isSignedValues	Returns a value indicating whether the value(s) controlled by the modifier are signed or unsigned.
getType	Returns the type of the particle modifier.
setMode	Sets the mode of the particle modifier.
getMode	Returns the current mode of the particle modifier.
saveState	Saves the current modifier state to the specified stream.
restoreState	Restores a previously saved state from the specified stream.
save	Saves the modifier's state to the specified Xml node.
load	Loads a previously saved modifier's state from the specified Xml node.
getSystemMemoryUsage	Returns the total amount of memory used by the modifier.

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.

Saving into the stream requires creating a blob to save into. To restore the saved state the restoreState() method is used:

Source code (C++)

// initialize a node and set its state
//...//

// save state
BlobPtr blob_state = Blob::create();
particlemodifier->saveState(blob_state);

// change state
//...//

// restore state
blob_state->seekSet(0);				// returning the carriage to the start of the blob
particlemodifier->restoreState(blob_state);

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.

Restoring from the stream requires creating a blob to save into and saving the state using the saveState() method:

Source code (C++)

// initialize a node and set its state
//...//

// save state
BlobPtr blob_state = Blob::create();
particlemodifier->saveState(blob_state);

// change state
//...//

// restore state
blob_state->seekSet(0);				// returning the carriage to the start of the blob
particlemodifier->restoreState(blob_state);

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: 10.10.2022

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter