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

PhysicalWind Class

This class is used to simulate a box-shaped area inside of which the wind is blowing. The wind gradually decreases up to the box boundaries.

PhysicalWind Class

This class inherits from Physical

Members


PhysicalWind (vec3 size)

Constructor. Creates physical wind node of the specified size.

Arguments

  • vec3 size - Wind box size in units.

float getAngularDamping ()

Returns the current angular velocity of the objects decreases when they get inside the wind node.

Return value

Angular damping value.

float getLinearDamping ()

Returns the current value indicating how much the linear velocity of the objects decreases when they get inside the wind node.

Return value

Linear damping value.

vec3 getSize ()

Returns the current size of the physical wind node.

Return value

Wind box size in units.

vec3 getThreshold ()

Returns the current threshold distance values along the coordinates axes relative to the wind node size (that is, inside of it). It determines the area of gradual change from zero to full wind velocity.

Return value

Threshold distance in units.

vec3 getVelocity ()

Returns the current velocity of the physical wind flow.

Return value

Velocity in units per second.

void setAngularDamping (float damping)

Sets a value indicating how much the angular velocity of the objects decreases when they get inside the wind node. The default is 0.

Arguments

  • float damping - Angular damping value. If a negative value is provided, 0 will be used instead.

void setLinearDamping (float damping)

Sets a value indicating how much the linear velocity of the objects decreases when they get inside the wind node. The default is 0.

Arguments

  • float damping - Linear damping value. If a negative value is provided, 0 will be used instead.

void setSize (vec3 size)

Sets the size of the physical wind node. The default is (1,1,1).

Arguments

  • vec3 size - Wind box size in units.

void setThreshold (vec3 threshold)

Sets the threshold distance values along the coordinates axes relative to the wind node size (that is, inside of it). It determines the area of gradual change from zero to full wind velocity. The default is (0,0,0).

Arguments

  • vec3 threshold - Threshold distance in units.

void setVelocity (vec3 velocity)

Sets velocity of the physical wind flow. The default is (0,0,0).

Arguments

  • vec3 velocity - Velocity in units per second.
Last update: 2017-07-03