ConeTwistJoint3D — C# API

A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint.

class ConeTwistJoint3DReckfellSharpInherits Joint3D

A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint.

A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint. The twist axis is initiated as the X axis of the ConeTwistJoint3D. Once the physics bodies swing, the twist axis is calculated as the middle of the X axes of the joint in the local space of the two physics bodies. Useful for limbs like shoulders and hips, lamps hanging off a ceiling, etc.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

ConeTwistJoint3DConstructor

# ConeTwistJoint3D

C#
public ConeTwistJoint3D();

Properties5

BiasProperty

# Bias

C#
public float Bias { get; set; }

The speed with which the swing or twist will take place. The higher, the faster.

RelaxationProperty

# Relaxation

C#
public float Relaxation { get; set; }

Defines, how fast the swing- and twist-speed-difference on both sides gets synced.

SoftnessProperty

# Softness

C#
public float Softness { get; set; }

The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.

SwingSpanProperty

# SwingSpan

C#
public float SwingSpan { get; set; }

Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected along the swing axis. Could be defined as looseness in the ConeTwistJoint3D. If below 0.05, this behavior is locked.

TwistSpanProperty

# TwistSpan

C#
public float TwistSpan { get; set; }

Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05.

Methods2

GetParamfloat

# GetParam

C#
public float GetParam(ConeTwistJoint3D.Param param);

Returns the value of the specified parameter.

Parameters
Name	Type	Default
`param`	`ConeTwistJoint3D.Param`	—

Returns float

SetParamvoid

# SetParam

C#
public void SetParam(ConeTwistJoint3D.Param param, float value);

Sets the value of the specified parameter.

Parameters
Name	Type	Default
`param`	`ConeTwistJoint3D.Param`	—
`value`	`float`	—

ConeTwistJoint3D.Param

Value	Description
`Bias = 2`	The speed with which the swing or twist will take place. The higher, the faster.
`Max = 5`	Represents the size of the `ConeTwistJoint3D.Param` enum.
`Relaxation = 4`	Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
`Softness = 3`	The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
`SwingSpan = 0`	Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected along the swing axis. Could be defined as looseness in the `ConeTwistJoint3D`. If below 0.05, this behavior is locked.
`TwistSpan = 1`	Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05.