Vixen
02b45cc4
csharp
public readonly record struct ChainSpec

Which joints a goal is allowed to move.

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

Remarks

The chain is the arbitration key. Two goals that move the same joints have to agree with each other; two that do not are independent and never meet. Grouping by chain rather than by effector is what makes a hand goal and an elbow-hint goal one conversation.

Fields and properties (3)

  • public int First

    The joint at the top of the chain — a shoulder, a hip.

  • public int Effector

    The joint at the end — a wrist, an ankle.

  • public bool IsSome

    Whether both ends name a joint at all.

Methods (8)

  • public ChainSpec(int First, int Effector)

    Which joints a goal is allowed to move.

  • public static ChainSpec Single(int joint)

    A chain that moves one joint and nothing above it.

  • public static ChainSpec From(Skeleton skeleton, string first, string effector)

    A chain from a named joint to a named joint.

  • public int CompareTo(ChainSpec other)

    Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

  • public static bool operator <(ChainSpec left, ChainSpec right)

    Orders two chains.

  • public static bool operator <=(ChainSpec left, ChainSpec right)

    Orders two chains.

  • public static bool operator >(ChainSpec left, ChainSpec right)

    Orders two chains.

  • public static bool operator >=(ChainSpec left, ChainSpec right)

    Orders two chains.

Used by (12)

  • AuthoringTestsVixen.Animation.Tests
  • ChainSolveRequestVixen.Animation
  • ConstraintGizmosVixen.Animation
  • ConstraintGoalVixen.Animation
  • ConstraintStackVixen.Animation
  • ConstraintTestsVixen.Animation.Tests
  • DefaultChainSolverVixen.Animation
  • DefaultConstraintArbiterVixen.Animation
  • PlacementTestsVixen.Animation.Tests
  • TeleportingTestSolverVixen.Animation.Tests
  • VariationHarnessVixen.Animation
  • WeightedTestArbiterVixen.Animation.Tests