Class DistanceJoint

Physics joint that maintains an upper or lower (or both) bound on the distance between two bodies.

System.Object
Object
SceneObject
Actor
Joint
DistanceJoint
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorContextMenu("New/Physics/Joints/Distance Joint")]
[ActorToolbox("Physics")]
[Unmanaged]
public class DistanceJoint : Joint, ISerializable

Constructors

DistanceJoint()

Initializes a new instance of the DistanceJoint.

Declaration
public DistanceJoint()

Properties

CurrentDistance

Gets the current distance of the joint.

Declaration
[Unmanaged]
public float CurrentDistance { get; }
Property Value
System.Single

Flags

Gets or sets the joint mode flags. Controls joint behaviour.

Declaration
[EditorOrder(100)]
[EditorDisplay("Joint", null)]
[Unmanaged]
public DistanceJointFlag Flags { get; set; }
Property Value
DistanceJointFlag

MaxDistance

Gets or sets the allowed maximum distance for the joint.

Declaration
[EditorOrder(120)]
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Joint", null)]
[ValueCategory]
[Unmanaged]
public float MaxDistance { get; set; }
Property Value
System.Single

Remarks

Used only when DistanceJointFlag.MaxDistance flag is set. The maximum distance must be no less than the minimum distance. Default: 0, Range: [0, float.MaxValue].

MinDistance

Gets or sets the allowed minimum distance for the joint.

Declaration
[EditorOrder(110)]
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Joint", null)]
[ValueCategory]
[Unmanaged]
public float MinDistance { get; set; }
Property Value
System.Single

Remarks

Used only when DistanceJointFlag.MinDistance flag is set. The minimum distance must be no more than the maximum distance. Default: 0, Range: [0, float.MaxValue].

SpringParameters

Gets or sets the spring parameters.

Declaration
[EditorOrder(140)]
[EditorDisplay("Joint", null)]
[Unmanaged]
public SpringParameters SpringParameters { get; set; }
Property Value
SpringParameters

Tolerance

Gets or sets the error tolerance of the joint.

Declaration
[EditorOrder(130)]
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Joint", null)]
[Unmanaged]
public float Tolerance { get; set; }
Property Value
System.Single

Remarks

The distance beyond the joint's [min, max] range before the joint becomes active. Default: 25, Range: [0.1, float.MaxValue].

Extension Methods

See Also