Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Plugins-Related Classes
Rendering-Related Classes

Unigine::JointSuspension Class

Header:#include <UniginePhysics.h>
Inherits:Joint

This class is used to create a suspension joint. The bodies that represent both a frame and a wheel need to be rigid bodies.

JointSuspension Class

Members


static JointSuspensionPtr create()

Constructor. Creates a suspension joint with an anchor at the origin of the world coordinates.

static JointSuspensionPtr create(const Ptr<Body> & body0, const Ptr<Body> & body1)

Constructor. Creates a suspension joint connecting two given bodies. An anchor is placed between centers of mass of the bodies.

Arguments

  • const Ptr<Body> & body0 - The wheel to connect with the joint.
  • const Ptr<Body> & body1 - The frame to connect with the joint.

static JointSuspensionPtr create(const Ptr<Body> & body0, const Ptr<Body> & body1, const Math::Vec3 & anchor, const Math::vec3 & axis0, const Math::vec3 & axis1)

Arguments

  • const Ptr<Body> & body0
  • const Ptr<Body> & body1
  • const Math::Vec3 & anchor
  • const Math::vec3 & axis0
  • const Math::vec3 & axis1

Ptr<JointSuspension> cast(const Ptr<Joint> & joint)

Arguments

  • const Ptr<Joint> & joint

void setAngularDamping(float damping)

Sets an angular damping of the joint (wheel rotation damping).

Arguments

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

float getAngularDamping()

Returns the angular damping of the joint (wheel rotation damping).

Return value

Angular damping.

void setAngularTorque(float torque)

Sets a maximum torque of the attached angular motor.

Arguments

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

float getAngularTorque()

Returns the maximum torque of the attached angular motor.

Return value

Maximum torque.

void setAngularVelocity(float velocity)

Sets a maximum velocity of wheel rotation.

Arguments

  • float velocity - Velocity in radians per second.

float getAngularVelocity()

Returns the target velocity of wheel rotation.

Return value

Target velocity in radians per second.

void setAxis00(const Math::vec3 & axis00)

Sets a wheel axis along which a wheel moves linearly. This is a shock absorber.

Arguments

  • const Math::vec3 & axis00 - Wheel axis.

Math::vec3 getAxis00()

Returns the wheel axis. This is a wheel spindle.

Return value

Wheel axis.

void setAxis10(const Math::vec3 & axis10)

Sets a suspension axis in coordinates of the wheel: an axis around which a wheel rotates when moving forward (or backward).

Arguments

  • const Math::vec3 & axis10 - Suspension axis.

Math::vec3 getAxis10()

Returns the suspension axis in coordinates of the wheel.

Return value

Suspension axis in coordinates of the wheel.

void setAxis11(const Math::vec3 & axis11)

Sets a suspension axis in coordinates of the frame: an axis around which the wheel rotates when steering.

Arguments

  • const Math::vec3 & axis11 - Suspension axis.

Math::vec3 getAxis11()

Returns the suspension axis in coordinates of the frame.

Return value

Suspension axis in coordinates of the frame.

float getCurrentAngularVelocity()

Returns the current velocity of wheel rotation.

Return value

Current velocity in radians per second.

float getCurrentLinearDistance()

Returns the current suspension compression.

Return value

Current suspension height in units.

void setLinearDamping(float damping)

Sets a linear damping of the suspension.

Arguments

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

float getLinearDamping()

Returns the linear damping of the suspension.

Return value

Linear damping.

void setLinearDistance(float distance)

Sets a target height of the suspension.

Arguments

  • float distance - Height in units.

float getLinearDistance()

Returns the target height of the suspension.

Return value

Target height in units.

void setLinearLimitFrom(float from)

Sets a low limit of the suspension ride.

Arguments

  • float from - Limit in units.

float getLinearLimitFrom()

Returns the low limit of the suspension ride.

Return value

Low limit in units.

void setLinearLimitTo(float to)

Sets a high limit of the suspension ride.

Arguments

  • float to - Limit in units.

float getLinearLimitTo()

Returns the high limit of the suspension ride.

Return value

High limit in units.

void setLinearSpring(float spring)

Sets a rigidity coefficient of the suspension.

Arguments

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

float getLinearSpring()

Returns the rigidity coefficient of the suspension.

Return value

Rigidity coefficient.

void setWorldAxis0(const Math::vec3 & axis0)

Sets a wheel axis in the world coordinates. This is a wheel spindle.

Arguments

  • const Math::vec3 & axis0 - Wheel axis in the world coordinates.

Math::vec3 getWorldAxis0()

Returns the wheel axis in the world coordinates. This is a wheel spindle.

Return value

Wheel axis in the world coordinates.

void setWorldAxis1(const Math::vec3 & axis1)

Sets a suspension axis in the world coordinates.

Arguments

  • const Math::vec3 & axis1 - Suspension axis in the world coordinates.

Math::vec3 getWorldAxis1()

Returns the suspension axis in the world coordinates.

Return value

Suspension axis in the world coordinates.
Last update: 2017-07-03