UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

PhysicalNoise Class

A PhysicalNoise class is used to simulate a force field affecting particles and objects based on a volumetric noise texture. Creates an additional distribution flow specifying the force and the displacement direction for objects at each point of the force field.

PhysicalNoise Class

This class inherits from Physical

Members


PhysicalNoise (vec3 size)

Constructor. Creates physical noise node of the specified size.

Arguments

  • vec3 size - Physical noise box size in units.

float getForce ()

Returns the value of the noise force vector.

Return value

Noise force value.

int getFrequency ()

Returns the value of noise spatial texture frequency octaves.

Return value

Noise frequency value. Minimum value is 1, maximum - 16.

int getImageSize ()

Returns a spatial noise texture image size.

Return value

Spatial noise texture image size.

Image getImage ()

Returns a spatial noise texture image.

Return value

Spatial noise texture image.

vec3 getOffset ()

Returns the offset of the physical noise node along X, Y and Z axes.

Return value

Noise box offset in units.

float getScale ()

Returns the value of the noise spatial texture image scale.

Return value

Scale of the spatial noise texture image. Minimum value is 0, maximum - 1.

vec3 getSize ()

Returns the current size of the physical noise node.

Return value

Physical noise box size in units.

vec3 getStep ()

Returns the step of the physical noise node.

Return value

Physical noise step.

vec3 getThreshold ()

Returns a threshold of the physical noise node.

Return value

Physical noise threshold.

void setForce (float force)

Sets the value of the noise force vector.

Arguments

  • float force - Noise force value.

void setFrequency (int frequency)

Sets the value for noise spatial texture frequency octaves.

Arguments

  • int frequency - Noise frequency value. Minimum value is 1, maximum - 16.

void setImageSize (int size)

Sets a spatial noise texture image size.

Arguments

  • int size - Spatial noise texture image size.

void setOffset (vec3 offset)

Sets the offset for the physical noise node along X, Y and Z axes.

Arguments

  • vec3 offset - Noise box offset in units.

void setScale (float scale)

Sets the value for the noise spatial texture image scale.

Arguments

  • float scale - Scale of the spatial noise texture image. Minimum value is 0, maximum - 1.

void setSize (vec3 size)

Sets a size for the physical noise node.

Arguments

  • vec3 size - Physical noise box size in units.

void setStep (vec3 step)

Sets the step for the physical noise node.

Arguments

  • vec3 step - Physical noise step.

void setThreshold (vec3 threshold)

Sets a threshold for a physical noise node.

Arguments

  • vec3 threshold - Physical noise threshold.
Last update: 2017-07-03