Programming
Fundamentials
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
Bounds-Related Classes
Containers
Controls-Related Classes
Core Library
Engine-Related Classes
GUI-Related Classes
Node-Related Classes
Pathfinding-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Utility Classes

JointPrismatic Class

This class is used to create prismatic joints.

JointPrismatic Class

Members


JointPrismatic ()

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

JointPrismatic (const Ptr<Body> & body0, const Ptr<Body> & body1)

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

Arguments

  • const Ptr<Body> & body0 - The first body to connect with the joint.
  • const Ptr<Body> & body1 - The second body to connect with the joint.

JointPrismatic (const Ptr<Body> & body0, const Ptr<Body> & body1, const Math::Vec3 & anchor, const Math::vec3 & size)

Arguments

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

void setRotation0 (const Math::mat3 & rotation0)

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

Arguments

  • const Math::mat3 & rotation0 - Rotation matrix in the body coordinate space.

void setLinearForce (float force)

Sets a maximum force of the attached motor.

Arguments

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

Math::mat3 getRotation1 ()

Return value

float getLinearDamping ()

Returns the linear damping of the joint.

Return value

Linear damping.

Math::vec3 getAxis0 ()

Returns the joint axis in the local coordinates of the first body.

Return value

Joint axis in the coordinates of the first body.

void setLinearLimitTo (float to)

Sets a high limit distance. This limit specifies how far a connected body can move along the joint axis.

Arguments

  • float to - Distance in units.

float getLinearSpring ()

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

Return value

Rigidity coefficient.

float getCurrentLinearDistance ()

Returns the current distance between the bodies.

Return value

Current distance in units.

Math::mat3 getWorldRotation ()

Return value

Math::mat3 getRotation0 ()

Return value

float getCurrentLinearVelocity ()

Returns the current velocity of the attached motor.

Return value

Current velocity in units per second.

float getLinearLimitTo ()

Returns the high limit distance. This limit specifies how far a connected body can move along the joint axis.

Return value

High limit distance in units.

float getLinearLimitFrom ()

Returns the low limit distance. This limit specifies how far a connected body can move along the joint axis.

Return value

Low limit distance in units.

void setLinearDamping (float damping)

Sets a linear damping of the joint.

Arguments

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

float getLinearForce ()

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

Return value

Maximum force.

void setLinearDistance (float distance)

Sets a target distance of the attached spring. The spring tries to move the connected bodies so that to keep this distance between them.

Arguments

  • float distance - Target distance in units.

void setRotation1 (const Math::mat3 & rotation1)

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

Arguments

  • const Math::mat3 & rotation1 - Rotation matrix in the body coordinate space.

void setLinearVelocity (float velocity)

Sets a target velocity of the attached motor.

Arguments

  • float velocity - Target velocity in units per second.

void setWorldAxis (const Math::vec3 & axis)

Sets a joint axis in the world coordinates.

Arguments

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

void setWorldRotation (const Math::mat3 & rotation)

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

Arguments

  • const Math::mat3 & rotation - Rotation matrix in the world coordinate space.

void setLinearSpring (float spring)

Sets a rigidity coefficient of the spring.

Arguments

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

void setAxis0 (const Math::vec3 & axis0)

Sets a joint axis in the local coordinates of the first body.

Arguments

  • const Math::vec3 & axis0 - Joint axis in the coordinates of the first body.

float getLinearDistance ()

Returns the target distance of the attached spring. The spring tries to move the connected bodies so that to keep this distance between them.

Return value

Target distance in units.

Math::vec3 getWorldAxis ()

Returns the joint axis in the world coordinates.

Return value

Joint axis in the world coordinates.

float getLinearVelocity ()

Returns the target velocity of the attached motor.

Return value

Target velocity in units per second.

void setLinearLimitFrom (float from)

Sets a low limit distance. This limit specifies how far a connected body can move along the joint axis.

Arguments

  • float from - Distance in units.
Last update: 2017-07-03