Struct LimitLinearRange

Represents a joint limit between two distance values. Lower value must be less than the upper value.

Assembly: FlaxEngine.dll

File: Engine/Physics/Joints/Limits.h

Syntax

public struct LimitLinearRange

Constructors

LimitLinearRange()

Constructs an empty limit.

Declaration

public LimitLinearRange()

LimitLinearRange(const float lower, const float upper, 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 LimitLinearRange(const float lower, const float upper, const float contactDist=-1.0f)

Parameters

float lower The lower distance of the limit. Must be less than upper.

float upper The upper distance of the limit. Must be more than lower.

float 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. Specify -1 for the default.

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

Parameters

float lower The lower distance of the limit. Must be less than upper.

float upper The upper distance of the limit. Must be more than lower.

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

Lower

The lower distance of the limit. Must be less than upper.

Declaration

public float Lower = 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

Upper

The upper distance of the limit. Must be more than lower.

Declaration

public float Upper = 0.0f

Field Value

float

Methods

operator==(const LimitLinearRange& other)

Declaration

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

Parameters

LimitLinearRange other

Returns

bool