Class LimitLinear

Represents a joint limit between zero a single distance value.

System.Object
LimitLinear
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class LimitLinear : ValueType

Constructors

LimitLinear(Single, SpringParameters, Single)

Constructs a soft limit. Once the limit is reached the bodies will bounce back according to the restitution parameter and will be pulled back towards the limit by the provided spring.

Declaration
public LimitLinear(float extent, SpringParameters spring, float restitution = 0F)
Parameters
System.Single extent

The distance at which the limit becomes active.
SpringParameters spring

The spring that controls how are the bodies pulled back towards the limit when they breach it.
System.Single restitution

Controls how do objects react when the limit is reached, values closer to zero specify non-elastic collision, while those closer to one specify more elastic (i.e bouncy) collision. Must be in [0, 1] range.

LimitLinear(Single, Single)

Constructs a hard limit. Once the limit is reached the movement of the attached bodies will come to a stop.

Declaration
public LimitLinear(float extent, float contactDist = -1F)
Parameters
System.Single extent

The distance at which the limit becomes active.
System.Single contactDist

The distance from the limit at which it becomes active. Allows the solver to activate earlier than the limit is reached to avoid breaking the limit. Specify -1 for the default.

Fields

ContactDist

Distance from the limit at which it becomes active. Allows the solver to activate earlier than the limit is reached to avoid breaking the limit.

Declaration
public float ContactDist
Field Value
System.Single

Extent

The distance at which the limit becomes active.

Declaration
public float Extent
Field Value
System.Single

Restitution

Controls how do objects react when the limit is reached, values closer to zero specify non-elastic collision, while those closer to one specify more elastic (i.e bouncy) collision. Must be in [0, 1] range.

Declaration
[Limit(0F, 1F, 1F)]
public float Restitution
Field Value
System.Single

Spring

The spring that controls how are the bodies pulled back towards the limit when they breach it.

Declaration
public SpringParameters Spring
Field Value
SpringParameters

Properties

Default

The default LimitLinear.

Declaration
public static LimitLinear Default { get; }
Property Value
LimitLinear

Extension Methods