Unigine::PhysicalForce Class
| Header: | #include <UniginePhysicals.h> |
| Inherits: | Physical |
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
See also#
- An article on Physical Force
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/physicals/ folder:
- force_00
- force_01
PhysicalForce Class
Members
static PhysicalForcePtr create ( 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.
Ptr<PhysicalForce> cast( const Ptr<Node> & node )
Casts a PhysicalForce out of the Node instance.Arguments
- const Ptr<Node> & node - Pointer to Node.
Return value
Pointer to PhysicalForce.Ptr<PhysicalForce> cast( const Ptr<Physical> & base )
Casts a PhysicalForce out of the Physical instance.Arguments
- const Ptr<Physical> & base - Pointer to Physical.
Return value
Pointer to PhysicalForce.void setAttenuation( float attenuation )
Updates the attenuation factor for the physical force.Arguments
- float attenuation - A new attenuation factor.
float getAttenuation( )
Returns the current attenuation factor for the physical force.Return value
The attenuation factor.void setAttractor( float attractor )
Updates the attraction force that will be applied to objects in the physical force radius.Arguments
- float attractor - A new attraction force value. Positive values pull objects away from the force point, negative values pull them up to it.
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
The attraction force value.void setRadius( float radius )
Updates the radius for applying the physical force.Arguments
- float radius - A new radius in units. If a negative value is provided, 0 will be used instead.
float getRadius( )
Returns the current radius set for applying the physical force.Return value
The radius in units.void setRotator( float rotator )
Updates the rotation force that will be applied to objects in the physical force radius.Arguments
- float rotator - A new rotation force value. Set a positive value for clockwise rotation or a negative value for counterclockwise one.
float getRotator( )
Returns the current rotation force that will be applied to objects in the physical force radius.Return value
The rotation force value.int type( )
Returns the type of the node.Return value
Physical type identifier.Last update:
2020-01-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)