JointCylindrical Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Inherits:

Joint

This class is used to create cylindrical joints.

Example#

The following code illustrates connection of two bodies (b0 and b1) using a cylindrical joint.

Source code (UnigineScript)

JointCylindrical joint = class_remove(new JointCylindrical(b0, b1));
	
// setting joint axis coordinates
joint.setWorldAxis(vec3(0.0f, 0.0f, 1.0f));

// setting common joint constraint parameters
joint.setLinearRestitution(0.4f);
joint.setAngularRestitution(0.4f);
joint.setLinearSoftness(0.4f);
joint.setAngularSoftness(0.4f);

// setting linear and angular damping
joint.setLinearDamping(4.0f);
joint.setAngularDamping(2.0f);

// setting linear limits [-1.5; 1.5]
joint.setLinearLimitFrom(-1.5f);
joint.setLinearLimitTo(1.5f);

// setting number of iterations
joint.setNumIterations(16);

Methods:

Name	Description View: Sort by:
JointCylindrical	Constructor.
setAngularAngle	Sets a target angle of the attached angular spring.
getAngularAngle	Returns the target angle of the attached angular spring.
setAngularDamping	Sets an angular damping of the joint.
getAngularDamping	Returns the angular damping of the joint.
setAngularLimitFrom	Sets a low rotation limit angle.
getAngularLimitFrom	Returns the low rotation limit angle.
setAngularLimitTo	Sets a high rotation limit angle.
getAngularLimitTo	Returns the high rotation limit angle.
setAngularSpring	Sets a rigidity coefficient of the angular spring.
getAngularSpring	Returns the rigidity coefficient of the angular spring.
setAngularTorque	Sets a maximum torque of the angular motor.
getAngularTorque	Returns the maximum torque of the attached angular motor.
setAngularVelocity	Sets a target velocity of the attached angular motor.
getAngularVelocity	Returns the target velocity of the attached angular motor.
setAxis0	Sets an axis of the first connected body.
getAxis0	Returns the axis of the first connected body.
setAxis1	Sets an axis of the second connected body.
getAxis1	Returns the axis of the second connected body.
getCurrentAngularAngle	Returns the current angle between the bodies.
getCurrentAngularVelocity	Returns the current velocity of the angular motor.
getCurrentLinearDistance	Returns the current distance between the bodies.
getCurrentLinearVelocity	Returns the current velocity of the linear motor.
setLinearDamping	Sets a linear damping of the joint.
getLinearDamping	Returns the linear damping of the joint.
setLinearDistance	Sets a target distance of the attached linear spring.
getLinearDistance	Returns the target distance of the attached linear spring.
setLinearForce	Sets a maximum force of the attached linear motor.
getLinearForce	Returns the maximum force of the attached linear motor.
setLinearLimitFrom	Sets a low limit distance.
getLinearLimitFrom	Returns the low limit distance.
setLinearLimitTo	Sets a high limit distance.
getLinearLimitTo	Returns the high limit distance.
setLinearSpring	Sets a rigidity coefficient of the linear spring.
getLinearSpring	Returns the rigidity coefficient of the linear spring.
setLinearVelocity	Sets a target velocity of the attached linear motor.
getLinearVelocity	Returns the target velocity of the attached linear motor.
setWorldAxis	Sets a joint axis.
getWorldAxis	Returns the joint axis.

JointCylindrical Class

Members

static JointCylindrical ( ) #

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

static JointCylindrical ( Body body0, Body body1 ) #

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

Arguments

Body body0 - First body to be connected with the joint.
Body body1 - Second body to be connected with the joint.

static JointCylindrical ( Body body0, Body body1, Vec3 anchor, vec3 axis ) #

Constructor. Creates a cylindrical joint connecting two given bodies with specified axis coordinates and an anchor placed at specified coordinates.

Arguments

Body body0 - First body to be connected with the joint.
Body body1 - Second body to be connected with the joint.
Vec3 anchor - Anchor coordinates.
vec3 axis - Axis coordinates.

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].

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.

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.

float getAngularDamping ( ) #

Returns the angular damping of the joint.

Return value

Angular damping.

void setAngularLimitFrom ( float from ) #

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

Arguments

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

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.

void setAngularLimitTo ( float to ) #

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

Arguments

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

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.

void setAngularSpring ( float spring ) #

Sets a rigidity coefficient of the angular spring.

Arguments

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

float getAngularSpring ( ) #

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

Return value

Rigidity coefficient.

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.

float getAngularTorque ( ) #

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

Return value

Maximum torque.

void setAngularVelocity ( float velocity ) #

Sets a target velocity of the attached angular motor.

Arguments

float velocity - Velocity in radians per second.

float getAngularVelocity ( ) #

Returns the target velocity of the attached angular motor.

Return value

Target velocity in radians per second.

void setAxis0 ( vec3 axis0 ) #

Sets an axis of the first connected body.

Arguments

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

vec3 getAxis0 ( ) #

Returns the axis of the first connected body.

Return value

Axis of the first body.

void setAxis1 ( vec3 axis1 ) #

Sets an axis of the second connected body.

Arguments

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

vec3 getAxis1 ( ) #

Returns the axis of the second connected body.

Return value

Axis of the second body.

Arguments

float to - Distance in units.

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.

void setLinearSpring ( float spring ) #

Sets a rigidity coefficient of the linear spring.

Arguments

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

float getLinearSpring ( ) #

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

Return value

Rigidity coefficient.

void setLinearVelocity ( float velocity ) #

Sets a target velocity of the attached linear motor.

Arguments

float velocity - Target velocity in units per second.

float getLinearVelocity ( ) #

Returns the target velocity of the attached linear motor.

Return value

Target velocity in units per second.

void setWorldAxis ( vec3 axis ) #

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

Arguments

vec3 axis - Joint axis.

vec3 getWorldAxis ( ) #

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

Return value

Joint axis.

Last update: 2020-07-31

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

JointCylindrical Class

Example#

See Also#

Methods:

JointCylindrical Class

Members

static JointCylindrical ( ) #

static JointCylindrical ( Body body0, Body body1 ) #

Arguments

static JointCylindrical ( Body body0, Body body1, Vec3 anchor, vec3 axis ) #

Arguments

void setAngularAngle ( float angle ) #

Arguments

float getAngularAngle ( ) #

Return value

void setAngularDamping ( float damping ) #

Arguments

float getAngularDamping ( ) #

Return value

void setAngularLimitFrom ( float from ) #

Arguments

float getAngularLimitFrom ( ) #

Return value

void setAngularLimitTo ( float to ) #

Arguments

float getAngularLimitTo ( ) #

Return value

void setAngularSpring ( float spring ) #

Arguments

float getAngularSpring ( ) #

Return value

void setAngularTorque ( float torque ) #

Arguments

float getAngularTorque ( ) #

Return value

void setAngularVelocity ( float velocity ) #

Arguments

float getAngularVelocity ( ) #

Return value

void setAxis0 ( vec3 axis0 ) #

Arguments

vec3 getAxis0 ( ) #

Return value

void setAxis1 ( vec3 axis1 ) #

Arguments

vec3 getAxis1 ( ) #

Return value

float getCurrentAngularAngle ( ) #

Return value

float getCurrentAngularVelocity ( ) #

Return value

float getCurrentLinearDistance ( ) #

Return value

float getCurrentLinearVelocity ( ) #

Return value

void setLinearDamping ( float damping ) #

Arguments

float getLinearDamping ( ) #

Return value

void setLinearDistance ( float distance ) #

Arguments

float getLinearDistance ( ) #

Return value

void setLinearForce ( float force ) #

Arguments

float getLinearForce ( ) #

Return value

void setLinearLimitFrom ( float from ) #

Arguments

float getLinearLimitFrom ( ) #

Return value

void setLinearLimitTo ( float to ) #

Arguments

float getLinearLimitTo ( ) #

Return value

void setLinearSpring ( float spring ) #

Arguments

float getLinearSpring ( ) #

Return value

void setLinearVelocity ( float velocity ) #