Unigine::PhysicalWind Class

PhysicalWind Class

Members

---

static PhysicalWindPtr create(const Math::vec3 & size)

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

Arguments

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

Ptr<PhysicalWind> cast(const Ptr<Node> & node)

Casts a PhysicalWind out of the Node instance.

Arguments

• const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to PhysicalWind.

Ptr<PhysicalWind> cast(const Ptr<Physical> & base)

Casts a PhysicalWind out of the Physical instance.

Arguments

• const Ptr<Physical> & base - Pointer to Physical.

Return value

Pointer to PhysicalWind.

void setAngularDamping(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.

float getAngularDamping()

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

Return value

Angular damping value.

void setLinearDamping(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.

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.

void setSize(const Math::vec3 & size)

Sets the size of the physical wind node.

Arguments

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

Math::vec3 getSize()

Returns the current size of the physical wind node.

Return value

Wind box size in units.

void setThreshold(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.

Math::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.

void setVelocity(const Math::vec3 & velocity)

Sets velocity of the physical wind flow.

Arguments

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

Math::vec3 getVelocity()

Returns the current velocity of the physical wind flow.

Return value

Velocity in units per second.

int type()