Vixen
02b45cc4
csharp
public sealed class ConstraintHandle

A goal a game added, and the few things that are safe to change while it is live.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

The whole API for adding a constraint from code: a request goes in, a handle comes back, and releasing it eases the goal out rather than snapping the limb. Everything a clip tag does a handle can do, and they arbitrate together with no special case.

Fields and properties (5)

  • public ConstraintGoal Goal

    What it asks for.

  • public float Weight

    How much of it is wanted, in [0, 1].

  • public bool IsAlive

    Whether it is still being solved.

  • public bool Released

    Whether Dispose has been called.

  • public ConstraintResidual Residual

    How far off it ended up, as of the last solve.

Methods (1)

  • public void Dispose()

    Lets the goal go. It eases out; it does not snap.

Used by (8)

  • ActiveHandlesVixen.Animation
  • CameraConstraintsVixen.Animation
  • ConstraintStackVixen.Animation
  • ConstraintTestsVixen.Animation.Tests
  • EnumeratorVixen.Animation
  • FootPlacementPresetVixen.Animation
  • JointLimitTestsVixen.Animation.Tests
  • ProxyShapeTestsVixen.Animation.Tests