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

JointWheel Class

This class is used to create ray-cast wheels. Both a frame and a wheel are rigid bodies. There is no need to assign a shape to the wheel: ray casting is used to detect collision of the wheel with a surface.

JointWheel Class

This class inherits from Joint

Members


JointWheel ()

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

JointWheel (Body body0, Body body1)

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

Arguments

  • Body body0 - The wheel to connect with the joint.
  • Body body1 - The frame to connect with the joint.

JointWheel (Body body0, Body body1, vec3 anchor, vec3 axis0, vec3 axis1)

Constructor. Creates a wheel joint connecting two given bodies using a given anchor and axes.

Arguments

  • Body body0 - The wheel to connect with the joint.
  • Body body1 - The frame to connect with the joint.
  • vec3 anchor - Anchor of the joint.
  • vec3 axis0 - Wheel axis.
  • vec3 axis1 - Suspension axis.

float getAngularDamping ()

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

Return value

Angular damping.

float getAngularTorque ()

Returns the maximum torque of the attached angular motor.

Return value

Maximum torque.

float getAngularVelocity ()

Returns the target velocity of wheel rotation.

Return value

Target velocity in radians per second.

vec3 getAxis00 ()

Returns the wheel axis. This is a wheel spindle.

Return value

Wheel axis.

vec3 getAxis10 ()

Returns the suspension axis in coordinates of the wheel.

Return value

Suspension axis in coordinates of the wheel.

vec3 getAxis11 ()

Returns the suspension axis in coordinates of the frame.

Return value

Suspension axis in coordinates of the frame.

float getBinormalAngle ()

Returns the coefficient specifying how fast the optimal lateral force can be achieved. The larger this value, the more is the impulse produced by the tire.

Return value

Coefficient characterizing the tire lateral impulse.

float getBinormalFriction ()

Returns the lateral (sideways) friction of the tire.

Return value

Lateral friction.

vec3 getContactNormal ()

Returns a normal of a point of contact with the ground, in world coordinates.

Return value

Normal.

Object getContactObject ()

Returns an object representing the ground.

Return value

Ground object.

vec3 getContactPoint ()

Returns a point of contact with the ground, in world coordinates.

Return value

Point coordinates.

Shape getContactShape ()

Returns a shape of the object representing the ground.

Return value

Shape of the ground object.

int getContactSurface ()

Returns a surface of a ground object, which is in contact.

Return value

Surface number.

float getCurrentAngularVelocity ()

Returns the current rotation velocity of the attached wheels.

Return value

Current angular velocity in radians per second.

float getCurrentLinearDistance ()

Returns the current suspension compression (i.e. the length of the suspension).

Return value

Current suspension length in units.

float getCurrentSlipAngle ()

Returns the current angle between the wheel direction and the frame direction.

Return value

Current slip angle in degrees.

float getCurrentSlipRatio ()

Returns the current ratio of wheel spin to ground speed.

Return value

Current slip ratio in percents. 0 means that the velocities are equal. If the throttle is pressed, the value will be positive. If the brake is pressed, the value will be negative.

int getIntersectionMask ()

Returns an intersection mask of the joint.

Return value

Integer, each bit of which is a mask.

float getLinearDamping ()

Returns the linear damping of the suspension.

Return value

Linear damping.

float getLinearDistance ()

Returns the target height of the suspension.

Return value

Target height in units.

float getLinearLimitFrom ()

Returns the low limit of the suspension ride.

Return value

Low limit in units.

float getLinearLimitTo ()

Returns the high limit of the suspension ride.

Return value

High limit in units.

float getLinearSpring ()

Returns the rigidity coefficient of the suspension.

Return value

Rigidity coefficient.

float getTangentAngle ()

Returns the coefficient specifying how fast the optimal longitudinal force can be achieved. The larger this value, the more is the impulse produced by the tire.

Return value

Coefficient characterizing the tire longitudinal impulse.

float getTangentFriction ()

Returns the longitudinal (forward) friction of the tire.

Return value

Longitudinal friction.

float getWheelMass ()

Returns the mass of the attached wheel.
Notice
If g (Earth's gravity) equals to 9.8 m/s2, and 1 unit equals to 1 m, the mass is measured in kilograms.

Return value

Mass of the wheel.

float getWheelRadius ()

Returns the radius of the attached wheel.

Return value

Radius of the wheel in units.

float getWheelThreshold ()

Returns the threshold difference between the wheel and ground velocities. When it is too small, the longitudinal force will be scaled down to prevent unnatural vibrations.

Return value

Difference threshold.

float getWheelWidth ()

Returns the width of the attached wheel.

Return value

Width of the wheel in units.

vec3 getWorldAxis0 ()

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

Return value

Wheel axis in the world coordinates.

vec3 getWorldAxis1 ()

Returns the suspension axis in the world coordinates.

Return value

Suspension axis in the world coordinates.

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.

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.

void setAngularVelocity (float velocity)

Sets a maximum velocity of wheel rotation.

Arguments

  • float velocity - Velocity in radians per second.

void setAxis00 (vec3 axis)

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

Arguments

  • vec3 axis - Wheel axis.

void setAxis10 (vec3 axis)

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

Arguments

  • vec3 axis - Suspension axis in coordinates of the wheel.

void setAxis11 (vec3 axis)

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

Arguments

  • vec3 axis - Suspension axis in coordinates of the frame.

void setBinormalAngle (float coefficient)

Sets a coefficient specifying how fast the optimal lateral force can be achieved. The larger this value, the more is the impulse produced by the tire.

Arguments

  • float coefficient - Coefficient characterizing the tire lateral impulse. If a negative value is provided, 0 will be used instead.

void setBinormalFriction (float friction)

Sets a lateral (sideways) friction of the tire.

Arguments

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

void setCurrentAngularVelocity (float velocity)

Sets the rotation velocity for the attached wheels. For example, it allows to reset it to zero and stop the car when necessary.

Arguments

  • float velocity - Angular velocity in radians per second.

void setCurrentLinearDistance (float distance)

Sets suspension compression (i.e. the length of the suspension).

Arguments

  • float distance - Suspension length in units.

void setIntersectionMask (int mask)

Sets an intersection mask for the joint.

Arguments

  • int mask - Integer, each bit of which is a mask.

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.

void setLinearDistance (float distance)

Sets a target height of the suspension.

Arguments

  • float distance - Height in units.

void setLinearLimitFrom (float limit)

Sets a low limit of the suspension ride.

Arguments

  • float limit - Limit in units.

void setLinearLimitTo (float limit)

Sets a high limit of the suspension ride.

Arguments

  • float limit - Limit in units.

void setLinearSpring (float rigidity)

Sets a rigidity coefficient of the suspension.

Arguments

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

void setTangentAngle (float coefficient)

Sets a coefficient specifying how fast the optimal longitudinal force can be achieved. The larger this value, the more is the impulse produced by the tire.

Arguments

  • float coefficient - Coefficient characterizing the tire longitudinal impulse. If a negative value is provided, 0 will be used instead.

void setTangentFriction (float friction)

Sets a longitudinal (forward) friction of the tire.

Arguments

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

void setWheelMass (float mass)

Sets a mass of the attached wheel.
Notice
If g (Earth's gravity) equals to 9.8 m/s2, and 1 unit equals to 1 m, the mass is measured in kilograms.

Arguments

  • float mass - Mass of the wheel. If a negative value is provided, 0 will be used instead.

void setWheelRadius (float radius)

Sets a radius of the attached wheel.

Arguments

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

void setWheelThreshold (float threshold)

Sets a threshold difference between the wheel and ground velocities. When it is too small, the longitudinal force will be scaled down to prevent unnatural vibrations.

Arguments

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

void setWheelWidth (float width)

Sets a width of the attached wheel.

Arguments

  • float width - Width of the wheel in units. If a negative value is provided, 0 will be used instead.

void setWorldAxis0 (vec3 axis)

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

Arguments

  • vec3 axis - Wheel axis in the world coordinates.

void setWorldAxis1 (vec3 axis)

Sets a suspension axis in the world coordinates.

Arguments

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