Unigine.PhysicalWind Class
| Inherits: | Physical |
A PhysicalWind 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.
Notice
A physical wind will affect only an object that meets the following requirements:
- The object's bounds must be inside the physical wind box.
- A cloth body or a rigid body must be assigned to the object. If the rigid body is used, a shape should be also assigned.
See Also#
- An article on Physical Wind
- A set of samples located in the <UnigineSDK>/data/samples/physicals folder:
- wind_00
- wind_01
- wind_02
- wind_03
- wind_04
- wind_05
PhysicalWind Class
Properties
vec3 Velocity#
The current velocity of the physical wind flow along the axes.
set
Sets the velocity of the physical wind flow along the axes.
set value -
Velocity in units per second.
vec3 Threshold#
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. See also setThreshold().
set
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 threshold distance values form an invisible box, inside which the wind blows with full velocity:
set value -
Threshold distance in units.
vec3 Size#
The current size of the physical wind node.
set
Sets the size of the physical wind node.
set value -
Wind box size in units.
float LinearDamping#
The current value indicating how much the linear velocity of the objects decreases when they get inside the wind node.
set
Sets a value indicating how much the linear velocity of the objects decreases when they get inside the wind node.
set value -
Linear damping value. If a negative value is provided, 0 will be used instead.
float AngularDamping#
The current value indicating how much the angular velocity of the objects decreases when they get inside the physical wind node.
set
Sets a value indicating how much the angular velocity of the objects decreases when they get inside the wind node.
set value -
Angular damping value. If a negative value is provided, 0 will be used instead.
Members
static PhysicalWind ( vec3 size ) #
Constructor. Creates a physical wind node of the specified size.Arguments
- vec3 size - Wind box size in units.
static PhysicalWind Cast ( Node node ) #
Casts a PhysicalWind out of the Node instance.Arguments
- Node node - Node instance.
Return value
PhysicalWind instance.static PhysicalWind Cast ( Physical base ) #
Casts a PhysicalWind out of the Physical instance.Arguments
- Physical base - Physical instance.
Return value
PhysicalWind instance.static int type ( ) #
Returns the type of the node.Return value
Physical type identifier.Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)