Class FixedAngle

Namespace

Jitter2.Dynamics.Constraints

Assembly

Jitter2.dll

Preserves the relative orientation of two bodies while leaving translation free.

public class FixedAngle : Constraint<FixedAngle.FixedAngleData>, IDebugDrawable

Inheritance

object

Constraint

Constraint<FixedAngle.FixedAngleData>

FixedAngle

Implements

IDebugDrawable

Inherited Members

Constraint<FixedAngle.FixedAngleData>.Data

Constraint<FixedAngle.FixedAngleData>.IsSmallConstraint

Constraint.DefaultAngularSoftness

Constraint.DefaultAngularBias

Constraint.DefaultAngularLimitSoftness

Constraint.DefaultAngularLimitBias

Constraint.DefaultLinearSoftness

Constraint.DefaultLinearBias

Constraint.DefaultLinearLimitSoftness

Constraint.DefaultLinearLimitBias

Constraint.Body1

Constraint.Body2

Constraint.Tag

Constraint.Handle

Constraint.IsValid

Constraint.FormatDescription(string)

Constraint.SmallHandle

Constraint.CheckDataSize<T>()

Constraint.VerifyNotZero()

Constraint.DispatchId

Constraint.RegisterFullConstraint(delegate*<ref ConstraintData, in TimeStep, void>, delegate*<ref ConstraintData, in TimeStep, void>)

Constraint.RegisterSmallConstraint(delegate*<ref SmallConstraintData, in TimeStep, void>, delegate*<ref SmallConstraintData, in TimeStep, void>)

Constraint.IsEnabled

Constraint.GetDebugDrawOrigin(in DebugDrawSettings)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Bias

Gets or sets the bias factor controlling how aggressively angular error is corrected.

public float Bias { get; set; }

Property Value

float

Default is 0.2. Higher values correct errors faster but may cause instability.

Impulse

Gets the accumulated solver impulse from the last solved substep.

public JVector Impulse { get; }

Property Value

JVector

Softness

Gets or sets the softness (compliance) of the constraint.

public float Softness { get; set; }

Property Value

float

Default is 0.001. Higher values allow more angular error but improve stability.

Methods

Create()

Called when the world creates this constraint. Override to set DispatchId to the ID returned by registering the constraint's solver methods.

protected override void Create()

DebugDraw(IDebugDrawer)

Draws a debug visualization of this constraint.

public override void DebugDraw(IDebugDrawer drawer)

Parameters

drawer IDebugDrawer

The debug drawer to receive visualization primitives.

Exceptions

NotImplementedException

Thrown if the derived class does not override this method.

DebugDraw(IDebugDrawer, in DebugDrawSettings)

Draws this constraint using the supplied visualization settings. Custom constraints that only override DebugDraw(IDebugDrawer) use their default visualization.

public override void DebugDraw(IDebugDrawer drawer, in DebugDrawSettings settings)

Parameters

drawer IDebugDrawer

settings DebugDrawSettings

Initialize()

Initializes the constraint using the current relative orientation of the bodies.

public void Initialize()

Remarks

Default values: Softness = DefaultAngularSoftness, Bias = DefaultAngularBias.

IterateFixedAngle(ref ConstraintData, in TimeStep)

public static void IterateFixedAngle(ref ConstraintData constraint, in TimeStep timeStep)

Parameters

constraint ConstraintData

timeStep TimeStep

PrepareForIterationFixedAngle(ref ConstraintData, in TimeStep)

public static void PrepareForIterationFixedAngle(ref ConstraintData constraint, in TimeStep timeStep)

Parameters

constraint ConstraintData

timeStep TimeStep

ResetWarmStart()

Clears impulses saved from the previous solve, without changing constraint settings.

public override void ResetWarmStart()

Remarks

Use after restoring a saved state or making a sudden change to the bodies, when impulses from their previous state should no longer be reused.

ToString()

Returns a short description of the constraint's ID, connected bodies, and state.

public override string ToString()

Returns

string