ParticleModifier Class

ParticleModifier Class

Members

---

int isSignedValues ( ) #

Returns a value indicating whether the value(s) controlled by the modifier are signed or unsigned.

Return value

1 is the value(s) controlled by the modifier are signed; otherwise, 0.

int saveState ( Stream stream ) #

Saves the current modifier state to the specified stream.

Arguments

• Stream stream - Stream to which the modifier's state is to be saved.

Return value

1 if the state is saved successfully; otherwise, 0.

int restoreState ( const Stream stream ) #

Restores a previously saved state from the specified stream.

Arguments

• const Stream stream - Stream from which the modifier's state is to be loaded.

Return value

1 if the state is restored successfully; otherwise, 0.

int save ( Xml xml ) #

Saves the modifier's state to the specified Xml node.

Arguments

• Xml xml - Xml node to which the modifier's state is to be saved.

Return value

1 if the state is saved successfully; otherwise, 0.

int load ( const Xml xml ) #

Loads a previously saved modifier's state from the specified Xml node.

Arguments

• const Xml xml - Xml node from which the modifier's state is to be loaded.

Return value

1 if the state is loaded successfully; otherwise, 0.

long getSystemMemoryUsage ( ) #

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.

int getType ( ) #

Returns the type of the particle modifier.

Return value

Particle modifier type. One of the PARTICLE_MODIFIER_PARTICLE_MODIFIER_* values.

void setMode ( int 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

• int mode - Modifier mode to be set. One of the PARTICLE_MODIFIER_MODE_* values.

int getMode ( ) #

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 PARTICLE_MODIFIER_MODE_* values.