This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

ParticleModifierVector Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

This class is used to represent a particle system modifier, that controls a vector parameter (position, direction, etc.). Modifiers are used to control how various parameters of particle systems change over the particle's life time.

ParticleModifierVector Class

Members


void setConstant ( vec3 constant ) #

Sets a new constant vector 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

  • vec3 constant - Constant vector value to be set for the modifier (all components are constant).

vec3 getConstant ( ) #

Returns the current constant vector 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 vector value set for the modifier (all components are constant).

void setConstantMin ( vec3 min ) #

Sets a new minimum constant vector value for the modifier. This vector defines the lower limit for the value of the controlled vector parameter. The actual value varies randomly between the lower and upper limits.

Arguments

  • vec3 min - Minimum constant vector value to be set for the modifier (all components are constant).

vec3 getConstantMin ( ) #

Returns the current minimum constant vector value for the modifier. This vector defines the lower limit for the value of the controlled vector parameter. The actual value varies randomly between the lower and upper limits.

Return value

Current minimum constant vector value set for the modifier (all components are constant).

void setConstantMax ( vec3 max ) #

Sets a new maximum constant vector value for the modifier. This vector defines the upper limit for the value of the controlled vector parameter. The actual value varies randomly between the lower and upper limits.

Arguments

  • vec3 max - Maximum constant vector value to be set for the modifier (all components are constant).

vec3 getConstantMax ( ) #

Returns the current maximum constant vector value for the modifier. This vector defines the upper limit for the value of the controlled vector parameter. The actual value varies randomly between the lower and upper limits.

Return value

Current maximum constant vector value set for the modifier (all components are constant).

void setCurveScale ( float scale ) #

Sets a new curve scale for the modifier. The scale defines the maximum possible value for the components of the vector parameter controlled by the modifier.

Arguments

  • float scale - Curve scale value to be set for the modifier.

float getCurveScale ( ) #

Sets a new curve scale for the modifier. The scale defines the maximum possible value for the components of the vector parameter controlled by the modifier.

Return value

Current curve scale set for the modifier.

void setCurveX ( Curve2d curvex ) #

Sets a new curve for the modifier to control the X component of the vector parameter.

Arguments

  • Curve2d curvex - Curve to be set for the modifier to control the X component of the vector parameter.

Curve2d getCurveX ( ) #

Returns the current curve set for the modifier to control the X component of the vector parameter.

Return value

Current curve set for the modifier to control the X component of the vector parameter.

void setCurveY ( Curve2d curvey ) #

Sets a new curve for the modifier to control the Y component of the vector parameter.

Arguments

  • Curve2d curvey - Curve to be set for the modifier to control the Y component of the vector parameter.

Curve2d getCurveY ( ) #

Returns the current curve set for the modifier to control the Y component of the vector parameter.

Return value

Current curve set for the modifier to control the Y component of the vector parameter.

void setCurveZ ( Curve2d curvez ) #

Sets a new curve for the modifier to control the Z component of the vector parameter.

Arguments

  • Curve2d curvez - Curve to be set for the modifier to control the Z component of the vector parameter.

Curve2d getCurveZ ( ) #

Returns the current curve set for the modifier to control the Z component of the vector parameter.

Return value

Current curve set for the modifier to control the Z component of the vector parameter.

void setCurveXMin ( Curve2d xmin ) #

Sets a new minimum curve for the modifier to control the X component of the vector parameter. This curve defines the lower limit for the value of the X component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d xmin - Minimum curve to be set for the modifier to control the X component of the vector parameter.

Curve2d getCurveXMin ( ) #

Returns the current minimum curve set for the modifier to control the X component of the vector parameter. This curve defines the lower limit for the value of the X component of the controlled vector 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 to control the X component of the vector parameter.

void setCurveYMin ( Curve2d ymin ) #

Sets a new minimum curve for the modifier to control the Y component of the vector parameter. This curve defines the lower limit for the value of the Y component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d ymin - Minimum curve to be set for the modifier to control the Y component of the vector parameter.

Curve2d getCurveYMin ( ) #

Returns the current minimum curve set for the modifier to control the Y component of the vector parameter. This curve defines the lower limit for the value of the Y component of the controlled vector 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 to control the Y component of the vector parameter.

void setCurveZMin ( Curve2d zmin ) #

Sets a new minimum curve for the modifier to control the Z component of the vector parameter. This curve defines the lower limit for the value of the Z component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d zmin - Minimum curve to be set for the modifier to control the Z component of the vector parameter.

Curve2d getCurveZMin ( ) #

Returns the current minimum curve set for the modifier to control the Z component of the vector parameter. This curve defines the lower limit for the value of the Z component of the controlled vector 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 to control the Z component of the vector parameter.

void setCurveXMax ( Curve2d xmax ) #

Sets a new maximum curve for the modifier to control the X component of the vector parameter. This curve defines the upper limit for the value of the X component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d xmax - Maximum curve to be set for the modifier to control the X component of the vector parameter.

Curve2d getCurveXMax ( ) #

Returns the current maximum curve set for the modifier to control the X component of the vector parameter. This curve defines the upper limit for the value of the X component of the controlled vector 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 to control the X component of the vector parameter.

void setCurveYMax ( Curve2d ymax ) #

Sets a new maximum curve for the modifier to control the Y component of the vector parameter. This curve defines the upper limit for the value of the Y component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d ymax - Maximum curve to be set for the modifier to control the Y component of the vector parameter.

Curve2d getCurveYMax ( ) #

Returns the current maximum curve set for the modifier to control the Y component of the vector parameter. This curve defines the upper limit for the value of the Y component of the controlled vector 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 to control the Y component of the vector parameter.

void setCurveZMax ( Curve2d zmax ) #

Sets a new maximum curve for the modifier to control the Z component of the vector parameter. This curve defines the upper limit for the value of the Z component of the controlled vector parameter at each point of the particle's lifetime. The actual value changes randomly over time between the lower and the upper limits.

Arguments

  • Curve2d zmax - Maximum curve to be set for the modifier to control the Z component of the vector parameter.

Curve2d getCurveZMax ( ) #

Returns the current maximum curve set for the modifier to control the Z component of the vector parameter. This curve defines the upper limit for the value of the Z component of the controlled vector 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 to control the Z component of the vector parameter.

vec3 getMaxValue ( ) #

Returns the maximum value for the modifier defining the upper limit for the value of the controlled vector parameter.

Return value

Maximum value for the modifier.

vec3 getMinValue ( ) #

Returns the minimum value for the modifier defining the lower limit for the value of the controlled vector parameter.

Return value

Minimum value for the modifier.
Last update: 2020-07-31
Build: ()