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

JointHinge Class

This class is used to create hinge joints.

JointHinge Class

This class inherits from Joint

Members


JointHinge ()

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

JointHinge (Body body0, Body body1)

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

Arguments

  • Body body0 - The first body to connect with the joint.
  • Body body1 - The second body to connect with the joint.

JointHinge (Body body0, Body body1, vec3 anchor, vec3 axis)

Constructor. Creates a joint connecting two given bodies using a given anchor and an axis.

Arguments

  • Body body0 - The first body to connect with the joint.
  • Body body1 - The second body to connect with the joint.
  • vec3 anchor - Anchor of the joint.
  • vec3 axis - Axis of the joint.

float getAngularAngle ()

Returns the target angle of the attached angular spring. The spring tries to rotate the connected bodies so that they make this angle.

Return value

Target angle in degrees.

float getAngularDamping ()

Returns the angular damping of the joint.

Return value

Angular damping.

float getAngularLimitFrom ()

Returns the low rotation limit angle. Rotation limit specifies how much a connected body can rotate around the joint axis.

Return value

Low rotation limit angle in degrees.

float getAngularLimitTo ()

Returns the high rotation limit angle. Rotation limit specifies how much a connected body can rotate around the joint axis.

Return value

High rotation limit angle in degrees.

float getAngularSpring ()

Returns the rigidity coefficient of the angular spring. 0 means that the spring is not attached.

Return value

Rigidity coefficient.

float getAngularTorque ()

Returns the maximum torque of the attached angular motor. 0 means that the motor is not attached.

Return value

Maximum torque.

float getAngularVelocity ()

Returns the target velocity of the attached angular motor.

Return value

Target velocity in radians per second.

vec3 getAxis0 ()

Returns the axis of the first connected body.

Return value

Axis of the first body.

vec3 getAxis1 ()

Returns the axis of the second connected body.

Return value

Axis of the second body.

float getCurrentAngularAngle ()

Returns the current angle between the bodies.

Return value

Current angle in degrees.

float getCurrentAngularVelocity ()

Returns the current velocity of the motor, i.e. the difference between angular velocities of two bodies connected with a hinge relative the hinge axis.
Notice
This function returns the valid velocity only if both bodies are of BodyRigid type. Otherwise, 0 is returned.

Return value

Current motor velocity in radians per second.

vec3 getWorldAxis ()

Returns the joint axis. The joint axis is calculated based on the axes of the connected bodies.

Return value

Joint axis.

void setAngularAngle (float angle)

Sets a target angle of the attached angular spring. The spring tries to rotate the connected bodies so that they make this angle.

Arguments

  • float angle - Angle in degrees. The provided value will be saturated in the range [-180; 180].

void setAngularDamping (float damping)

Sets an angular damping of the joint.

Arguments

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

void setAngularLimitFrom (float angle)

Sets a low rotation limit angle. Rotation limit specifies how much a connected body can rotate around the joint axis.

Arguments

  • float angle - Angle in degrees. The provided value will be saturated in the range [-180; 180].

void setAngularLimitTo (float angle)

Sets a high rotation limit angle. Rotation limit specifies how much a connected body can rotate around the joint axis.

Arguments

  • float angle - Angle in degrees. The provided value will be saturated in the range [-180; 180].

void setAngularSpring (float rigidity)

Sets a rigidity coefficient of the angular spring.

Arguments

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

void setAngularTorque (float torque)

Sets a maximum torque of the angular motor.

Arguments

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

void setAngularVelocity (float velocity)

Sets a target velocity of the attached angular motor.

Arguments

  • float velocity - Velocity in radians per second.

void setAxis0 (vec3 axis)

Sets an axis of the first connected body.

Arguments

  • vec3 axis - Axis of the first body. The provided vector will be normalized.

void setAxis1 (vec3 axis)

Sets an axis of the second connected body.

Arguments

  • vec3 axis - Axis of the second body. The provided vector will be normalized.

void setWorldAxis (vec3 axis)

Sets a joint axis. This method updates axes of the connected bodies.

Arguments

  • vec3 axis - Joint axis.
Last update: 2017-07-03