Struct LimitLinear

Represents a joint limit between zero a single distance value.

Assembly: FlaxEngine.dll

File: Engine/Physics/Joints/Limits.h

Syntax

public struct LimitLinear

Constructors

LimitLinear()

Constructs an empty limit.

Declaration

public LimitLinear()

LimitLinear(const float extent, const float contactDist=-1.0f)

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

Declaration

public LimitLinear(const float extent, const float contactDist=-1.0f)

Parameters

float extent The distance at which the limit becomes active.

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

LimitLinear(const float extent, const SpringParameters& spring, const float restitution = 0.0f)

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(const float extent, const SpringParameters& spring, const float restitution = 0.0f)

Parameters

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

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

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 = -1.0f

Field Value

float

Extent

The distance at which the limit becomes active.

Declaration

public float Extent = 0.0f

Field Value

float

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

public float Restitution = 0.0f

Field Value

float

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

Methods

operator==(const LimitLinear& other)

Declaration

public bool operator==(const LimitLinear& other) const

Parameters

LimitLinear other

Returns

bool