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.

# PhysicalWind Class

Interface for physical wind handling.

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

## PhysicalWind (const Math::vec3 & size)

Constructor. Creates a physical wind node of the specified size.

### Arguments

• const Math::vec3 & size - Wind box size in units.

## voidsetThreshold (const Math::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.

### Arguments

• const Math::vec3 & threshold - distance in units.

## voidsetVelocity (const Math::vec3 & velocity)

Sets velocity of the physical wind flow.

### Arguments

• const Math::vec3 & velocity - Velocity in units per second.

## floatgetAngularDamping ()

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

### Return value

Angular damping value.

## voidsetSize (const Math::vec3 & size)

Sets the size of the physical wind node.

### Arguments

• const Math::vec3 & size - Wind box size in units.

## voidsetAngularDamping (float damping)

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

### Arguments

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

## voidsetLinearDamping (float damping)

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

### Arguments

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

## Math::vec3getThreshold ()

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.

## floatgetLinearDamping ()

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.

## Math::vec3getSize ()

Returns the current size of the physical wind node.

### Return value

Wind box size in units.

## Math::vec3getVelocity ()

Returns the current velocity of the physical wind flow.

### Return value

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