This version of documentation is OUTDATED! Please switch to the latest one.

# Unigine::Joint Class

This class is used to create joints.

## voidsetAnchor0(const Math::Vec3 & anchor)

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

### Arguments

• const Math::Vec3 & anchor - Coordinates of the anchor point in the body coordinate space.

## Math::Vec3getAnchor0()

Returns the coordinates of the anchor point in a system of coordinates of the first connected body.

### Return value

Coordinates of the anchor point in the body coordinate space.

## voidsetAnchor1(const Math::Vec3 & anchor)

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

### Arguments

• const Math::Vec3 & anchor - Coordinates of the anchor point in the body coordinate space.

## Math::Vec3getAnchor1()

Returns the coordinates of the anchor point in a system of coordinates of the second connected body.

### Return value

Coordinates of the anchor point in the body coordinate space.

## voidsetAngularRestitution(float restitution)

Sets the current angular restitution (stiffness) of the joint. Angular restitution defines how fast the joint compensates for change of the angle between two bodies. When bodies are turned relative each other, restitution controls the magnitude of force which is applied to both bodies so that their anchor points to become aligned again. For example:
• 1 means that the joint is to return bodies in place throughout 1 physics tick.
• 0.2 means that the joint is to return bodies in place throughout 5 physics ticks.
The maximum value of 1 can lead to destabilization of physics (as too great forces are applied).

### Arguments

• float restitution - Angular restitution. The provided value will be clamped in the range [0;1].

## floatgetAngularRestitution()

Returns the current angular restitution (stiffness) of the joint. Angular restitution defines how fast the joint compensates for change of the angle between two bodies. When bodies are turned relative each other, restitution controls the magnitude of force which is applied to both bodies so that their anchor points to become aligned again. For example:
• 1 means that the joint is to return bodies in place throughout 1 physics tick.
• 0.2 means that the joint is to return bodies in place throughout 5 physics ticks.
The maximum value of 1 can lead to destabilization of physics (as too great forces are applied).

### Return value

Angular restitution in the range [0;1].

## voidsetAngularSoftness(float softness)

Sets the angular softness (elasticity) of the joint. When the joint is twisted, angular softness defines whether angular velocities of the bodies are averaged out. For example:
• 0 means that the joint is rigid. Angular velocities of the first and the second body are independent.
• 1 means that the joint is elastic (jelly-like). If the first body changes its velocity, velocity of the second body is equalized with it.

### Arguments

• float softness - Angular softness. The provided value will be clamped in the range [0;1].

## floatgetAngularSoftness()

Returns the current angular softness (elasticity) of the joint. When the joint is twisted, angular softness defines whether angular velocities of the bodies are averaged out. For example:
• 0 means that the joint is rigid. Angular velocities of the first and the second body are independent.
• 1 means that the joint is elastic (jelly-like). If the first body changes its velocity, velocity of the second body is equalized with it.

### Return value

Angular softness in the range [0;1].

## voidsetBody0(const Ptr<Body> & body)

Sets the first body connected using the joint.

### Arguments

• const Ptr<Body> & body - The first body connected with the joint.

## Ptr<Body>getBody0()

Returns the first body connected using the joint.

### Return value

The first body connected with the joint.

## voidsetBody1(const Ptr<Body> & body)

Sets the second body connected using the joint.

### Arguments

• const Ptr<Body> & body - The second body connected with the joint.

## Ptr<Body>getBody1()

Returns the second body connected using the joint.

### Return value

The second body connected with the joint.

## Ptr<BodyRigid>getBodyRigid0()

Returns the first connected body as a rigid body.

### Return value

The first rigid body connected using the joint or NULL (0), if the body is not rigid.

## Ptr<BodyRigid>getBodyRigid1()

Returns the second connected body as a rigid body.

### Return value

The second rigid body connected using the joint or NULL (0), if the body is not rigid.

## voidsetBroken(int broken)

Sets a value indicating if the joint is broken or not.

### Arguments

• int broken - Positive number to break the joint, 0 to make it intact.

## intisBroken()

Returns a value indicating if the joint is broken or not.

### Return value

Positive number if the joint is broken; otherwise, 0.

## voidsetBrokenCallback(const Ptr<BrokenCallback> & func)

Adds a callback function that will be run when a given joint breaks.
Notice
Physics-based callbacks are executed not immediately, but before the next flush() or next update() of the world script.

### Arguments

• const Ptr<BrokenCallback> & func

## voidsetCollision(int c)

Sets a value indicating if collisions between the connected bodies are enabled.

### Arguments

• int c - Positive number to enable collisions between the bodies, 0 to disable them.

## intgetCollision()

Returns a value indicating if collisions between the connected bodies are enabled.

### Return value

Positive number if collisions between the bodies are enabled; otherwise, 0.

## voidsetEnabled(int enable)

Enables or disables joint calculations.

### Arguments

• int enable - Positive number to enable the joint, 0 to disable it.

## intisEnabled()

Returns a value indicating if the joint calculations are enabled.

### Return value

1 if the joint is enabled; otherwise, 0.

## intisEnabledSelf()

Returns a value indicating is the joint is enabled.

### Return value

1 if the joint is enabled; otherwise, 0.

## voidsetFrozen(int f)

Freezes or unfreezes the joint.

### Arguments

• int f - Positive number to freeze the joint, 0 to unfreeze it.

## intisFrozen()

Returns a value indicating if the joint is frozen or not.

### Return value

Positive number if the joint is frozen; otherwise, 0.

## intsetID(int id)

Sets the unique ID for the joint.

### Arguments

• int id - Unique ID.

### Return value

1 if the ID is set successfully; otherwise, 0.

## intgetID()

Returns the unique ID of the joint.

Unique ID.

## voidsetLinearRestitution(float restitution)

Sets the linear restitution (stiffness) of the joint. Linear restitution defines how fast the joint compensates for linear coordinate change between two bodies. When bodies are dragged apart, restitution controls the magnitude of force which is applied to both bodies so that their anchor points to become aligned again. For example:
• 1 means that the joint is to return bodies in place throughout 1 physics tick.
• 0.2 means that the joint is to return bodies in place throughout 5 physics ticks.
The maximum value of 1 can lead to destabilization of physics (as too great forces are applied).

### Arguments

• float restitution - Linear restitution. The provided value will be clamped in the range [0;1].

## floatgetLinearRestitution()

Returns the current linear restitution (stiffness) of the joint. Linear restitution defines how fast the joint compensates for linear coordinate change between two bodies. When bodies are dragged apart, restitution controls the magnitude of force which is applied to both bodies so that their anchor points to become aligned again. For example:
• 1 means that the joint is to return bodies in place throughout 1 physics tick.
• 0.2 means that the joint is to return bodies in place throughout 5 physics ticks.
The maximum value of 1 can lead to destabilization of physics (as too great forces are applied).

### Return value

Linear restitution in the range [0;1].

## voidsetLinearSoftness(float softness)

Sets the linear softness (elasticity) of the joint. When the joint is stretched, linear softness defines whether linear velocities of the bodies are averaged out. For example:
• 0 means that the joint is rigid. Linear velocities of the first and the second body are independent.
• 1 means that the joint is elastic (jelly-like). If the first body changes its velocity, velocity of the second body is equalized with it.

### Arguments

• float softness - Linear softness. The provided value will be clamped in the range [0;1].

## floatgetLinearSoftness()

Returns the current linear softness (elasticity) of the joint. When the joint is stretched, linear softness defines whether linear velocities of the bodies are averaged out. For example:
• 0 means that the joint is rigid. Velocities of the first and the second body are independent.
• 1 means that the joint is elastic (jelly-like). If the first body changes its velocity, velocity of the second body is equalized with it.

### Return value

Linear softness value in the range [0;1].

## voidsetMaxForce(float force)

Sets the maximum amount of force that can be exerted on the joint. If this limit is exceeded, the joint breaks.

### Arguments

• float force - Maximum amount of force.

## floatgetMaxForce()

Returns the maximum amount of force that can be exerted on the joint. If this limit is exceeded, the joint breaks.

### Return value

Maximum amount of force.

## voidsetMaxTorque(float torque)

Sets the maximum amount of torque that can be exerted on the joint. If this limit is exceeded, the joint breaks.

### Arguments

• float torque - Maximum amount of torque.

## floatgetMaxTorque()

Returns the maximum amount of torque that can be exerted on the joint. If this limit is exceeded, the joint breaks.

### Return value

Maximum amount of torque.

## voidsetName(const char * name)

Sets the name of the joint.

### Arguments

• const char * name - Name of the joint.

## const char *getName()

Returns the name of the joint.

### Return value

Name of the joint.

## voidsetNumIterations(int num_iterations)

Sets the number of iterations used to solve joints. Note that if this value is too low, the precision of calculations will suffer.

### Arguments

• int num_iterations - Number of iterations. If a non-positive value is provided, 1 will be used instead.

## intgetNumIterations()

Returns the current number of iterations used to solve joints.

### Return value

Number of iterations.

## intgetType()

Returns the type of the joint.

### Return value

One of the JOINT_* pre-defined variables.

## const char *getTypeName()

Returns the name of the joint type.

Type name.

## voidsetWorldAnchor(const Math::Vec3 & anchor)

Sets the anchor point in the world coordinates.

### Arguments

• const Math::Vec3 & anchor - Coordinates of the anchor point in the world space.

## Math::Vec3getWorldAnchor()

Returns the anchor point in the world coordinates.

### Return value

Coordinates of the anchor point in the world space.

## Ptr<Joint>clone()

Clones the joint.

### Return value

Copy of the joint.

## voidrenderVisualizer(const Math::vec4 & color)

Renders the joint.
Notice
You should enable the engine visualizer by the show_visualizer 1 console command.

### Arguments

• const Math::vec4 & color - Color, in which the joint will be rendered.

## intrestoreState(const Ptr<Stream> & stream)

Restores the state of a given node from a binary stream.
• If a node is a parent for other nodes, states of these child nodes need to be restored manually.
• To save the state into a buffer, file or a message from a socket, make sure the stream is opened. If necessary, you can set a position for writing for buffers and files.
Warning
This function is deprecated and will be removed in the next release.

### Arguments

• const Ptr<Stream> & stream - Stream with saved node state data.

### Return value

1 if node state is successfully restored; otherwise, 0.

## intsaveState(const Ptr<Stream> & stream)

Saves the state of a given node into a binary stream.
• If a node is a parent for other nodes, states of these child nodes need to be saved manually.
• To save the state from a buffer, file or a message from a socket, make sure the stream is opened. For buffers and files, you also need to set the proper position for reading.
Warning
This function is deprecated and will be removed in the next release.

### Arguments

• const Ptr<Stream> & stream - Stream to save node state data.

### Return value

1 if node state is successfully saved; otherwise, 0.

## voidswap(const Ptr<Joint> & joint)

Swaps the joints saving the pointers.

### Arguments

• const Ptr<Joint> & joint - A joint to swap.

Ball joint.

## int JOINT_CYLINDRICAL

### Description

Cylindrical joint.

Fixed joint.

Hinge joint.

Particles joint.

Path joint.

Prismatic joint.

## int JOINT_SUSPENSION

### Description

Suspension joint.

Wheel joint.

## int NUM_JOINTS

Last update: 2017-07-03