Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Unigine::PhysicalNoise Class

Interface for physical noise handling. The physical noise is based on the volumetric noise texture. It is used to simulate a force field affecting particles and objects with spatial 3D noise. The physical noise can be applied either to Particle objects or Physics bodies.

To use this class, include the UniginePhysicalNoise.h file.

Unigine::PhysicalNoise Class

Members


static int type ()

PhysicalNoise type.

Return value

PhysicalNoise type identifier.

static Ptr< PhysicalNoise > create (const NodePtr & node)

PhysicalNoise constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< PhysicalNoise > create (const PhysicalPtr & physical)

PhysicalNoise constructor.

Arguments

  • const PhysicalPtr & physical - Physical smart pointer.

static Ptr< PhysicalNoise > create (const vec3 & size)

PhysicalNoise constructor.

Arguments

  • const vec3 & size - The size of the physical noise box in units.

virtual void setSize (const vec3 & size) const =0

Sets a size for the physical noise node.

Arguments

  • const vec3 & size - A size of the physical noise box in units. If a negative value is provided, 0 will be used instead.

virtual vec3 getSize () const =0

Returns the current size of the physical noise node.

Return value

The size of the physical noise box in units.

virtual void setThreshold (const vec3 & threshold) const =0

Sets a threshold for a physical noise node.

Arguments

  • const vec3 & threshold - A physical noise threshold.

virtual vec3 getThreshold () const =0

Returns the threshold of the physical noise node.

Return value

The physical noise threshold.

virtual void setOffset (const vec3 & offset) const =0

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

Arguments

  • const vec3 & offset - An offset of the physical noise box in units.

virtual vec3 getOffset () const =0

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

Return value

The offset of the physical noise box in units.

virtual void setStep (const vec3 & step) const =0

Sets a step for the physical noise node.

Arguments

  • const vec3 & step - A step for the physical noise node.

virtual vec3 getStep () const =0

Returns the step of the physical noise node.

Return value

The physical noise step.

virtual void setForce (float force) const =0

Sets a value of the noise force vector.

Arguments

  • float force - A noise force value.

virtual float getForce () const =0

Returns the value of the noise force vector.

Return value

The noise force value.

virtual void setScale (float scale) const =0

Sets a value for the noise spatial texture image scale.

Arguments

  • float scale - A scale of the spatial noise texture image. The minimum value is 0, the maximum value is 1.

virtual float getScale () const =0

Returns the value of the noise spatial texture image scale.

Return value

The scale of the spatial noise texture image. The minimum value is 0, the maximum value is 1.

virtual void setFrequency (int frequency) const =0

Sets a value for noise spatial texture frequency octaves.

Arguments

  • int frequency - A noise frequency value. The minimum value is 1, the maximum value is 16.

virtual int getFrequency () const =0

Returns the value of noise spatial texture frequency octaves.

Return value

The noise frequency value. The minimum value is 1, the maximum value is 16.

virtual void setImageSize (int size) const =0

Sets a size of the spatial noise texture image.

Arguments

  • int size - A size of the spatial noise texture image.

virtual int getImageSize () const =0

Returns the size of the spatial noise texture image.

Return value

The size of the spatial noise texture image.

virtual ImagePtr getImage () const =0

Returns the spatial noise texture image.

Return value

The spatial noise texture image.
Last update: 2017-07-03