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

PhysicalForce Class

This class is used to simulate a point force that pulls physical bodies up to or away from the point. It can also rotate them around the force center.

Notice
The physical force can affect only a cloth, a rope or a rigid body. If the rigid body is used, a shape should be also assigned.

See also

  • An article on Physical Force
  • A set of samples located in the data/samples/physicals folder:
    1. force_00
    2. force_01

PhysicalForce Class

This class inherits from Physical

Members


PhysicalForce (float radius)

Constructor. Creates a physical force node with the specified radius in units.

Arguments

  • float radius - The radius of the physical force node in units.

float getAttenuation ()

Returns the current attenuation factor for the physical force.

Return value

Attenuation factor.

float getAttractor ()

Returns the current attraction force applied to objects in the physical force radius. Positive values pull objects away from the force point, negative values pull them up to it.

Return value

Attraction force value.

float getRadius ()

Returns the current radius set for applying the physical force.

Return value

Radius in units.

float getRotator ()

Returns the current rotation force that will be applied to objects in the physical force radius. Positive values rotate objects clockwise, negative values rotate them counterclockwise.

Return value

Rotation force value.

void setAttenuation (float attenuation)

Updates the attenuation factor for the physical force.

Arguments

  • float attenuation - Attenuation factor.

void setAttractor (float attractor)

Updates attraction force that will be applied to objects in the physical force radius.

Arguments

  • float attractor - Attraction force value. If a positive value is specified, objects will be pulled away from the force point. If a negative value is specified, objects will be pulled up to the force center.

void setRadius (float radius)

Updates the radius for applying the physical force.

Arguments

  • float radius - Radius in units. If a negative value is provided, 0 will be used instead.

void setRotator (float rotator)

Updates rotation force that will be applied to objects in the physical force radius.

Arguments

  • float rotator - Rotation force value. If a positive value is specified, object will be rotated clockwise. If a negative value is specified, objects will be rotated counterclockwise.
Last update: 2017-07-03