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
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

JointPath Class

A path joint is used with BodyPath: it attaches an arbitrary BodyRigid to move along its path.

Notice
The path is a spline along which an object can be moved.

See Also

  • A set of samples located in the data/samples/ directory, namely:
    1. physics/train_00.cpp
    2. joints/path_00.cpp
  • Article on UnigineScript Migration

JointPath Class

This class inherits from Joint

Members


JointPath ()

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

JointPath (Body body_0, Body body_1)

Constructor. Creates a path joint connecting two given bodies. An anchor is placed in the center of the rigid body attached the path body.

Arguments

  • Body body_0 - BodyRigid to be connected with the joint.
  • Body body_1 - BodyPath to be connected with the joint.

JointPath (Body body_0, Body body_1, vec3 anchor)

Constructor. Creates a path joint connecting a rigid body to a path body using a given anchor.

Arguments

  • Body body_0 - BodyRigid to be connected with the joint.
  • Body body_1 - BodyPath to be connected with the joint.
  • vec3 anchor - Anchor of the joint.

float getCurrentLinearVelocity ()

Returns the current linear velocity of the attached motor.

Return value

Current linear velocity in units per second.

float getLinearDamping ()

Returns the current damping factor for linear velocities of bodies connected by the joint.

Return value

Linear damping.

float getLinearForce ()

Returns the maximum force of the attached motor.

Return value

Maximum force.

float getLinearVelocity ()

Returns the current linear velocity of the attached motor.

Return value

Target velocity in units per second.

void setLinearDamping (float damping)

Sets damping factor of linear velocities of bodies connected by the joint.

Arguments

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

void setLinearForce (float force)

Sets a maximum force of the attached motor. 0 means that the motor is not attached.

Arguments

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

void setLinearVelocity (float velocity)

Sets a target linear velocity of the attached motor.

Arguments

  • float velocity - Target velocity in units per second.

void setRotation0 (mat3 rotation)

Sets a rotation matrix of the anchor point in a system of coordinates of the connected rigid body.

Arguments

  • mat3 rotation - Rotation matrix in the body-space coordinates.

void setWorldRotation (mat3 rotation)

Sets a rotation matrix of the anchor point in the world coordinates.

Arguments

  • mat3 rotation - Rotation matrix in the world-space coordinates.
Last update: 2017-07-03