ConstraintTagRecord

Remarks

⚠ One flat record with a kind discriminator, and the union of every kind's fields. A hierarchy would read better here and would make the inspector worse: the panel has to show only the fields the selected kind has, and it derives that from GoalKindSchema rather than from the shape of the type. One record means one binder path, one diff, one template merge and one place a new field is added.

Priority is a name, not the integer. A raw integer has no meaning across a project — two authors pick 70 and 700 for the same intent and the arbitration between their clips is an accident — so what is stored is a name from a declared PriorityLadder, and the integer is looked up at bake.

Fields and properties (31)

• public string Name

  What an author calls it. Shown on the bar; means nothing to a solve.

• public GoalKind Kind

  What it asks for.

• public GoalMode Mode

  Whether it says where to be, or how far to move.

• public string Effector

  The joint it is about, by name.

• public string Chain

  The joint at the top of the chain it may move, by name.

• public float Begin

  Where in the clip it starts, in [0, 1].

• public float End

  Where in the clip it ends, in [0, 1].

• public float EaseIn

  How much of the clip it takes to fade in, as a fraction.

• public float EaseOut

  How much of the clip it takes to fade out, as a fraction.

• public float MaxWeight

  The most of it that ever applies.

• public string Priority

  Which rung of the project's declared ladder, by name.

• public string Label

  What other systems know it as, for querying and suppression.

• public byte LodMin

  The nearest detail level it applies at.

• public byte LodMax

  The furthest detail level it applies at.

• public ConstraintFrameRecord Goal

  Where the goal is.

• public ConstraintFrameRecord? Reference

  What an additive offset was measured against, or .

• public Vector3 Offset

  Where in the goal's frame the point is, for a position goal.

• public Vector3 EffectorOffset

  Where on the effector the point being placed is.

• public Vector3 Region

  Half-extents of the volume it may be anywhere inside.

• public Vector3 Pole

  Where the middle joint bends towards. Zero keeps the current bend.

• public Quaternion Rotation

  Which rotation, for an orientation goal.

• public float Tolerance

  How far off it may be and still count, in radians.

• public Vector3 Axis

  Which way the joint faces in its own space, for an aim goal.

• public Vector3 Origin

  Where on the joint the aim starts.

• public Quaternion Deviation

  How far off the origin-to-frame vector the aim was authored.

• public float AuthoredDistance

  How far away the thing being aimed at was when it was authored, in metres.

• public string Other

  The other joint, for a distance goal.

• public float Min

  The closest they may be, in metres.

• public float Max

  The furthest they may be, in metres.

• public string Template

  The template this tag came from, or empty if somebody placed it by hand.

• public int TemplateVersion

  Which version of that template, so a re-apply knows what it is upgrading from.

Methods (2)

• public ConstraintTag? Bake(Skeleton skeleton, PriorityLadder? ladder = null)

  Resolves the tag into what a stack solves.

• public static ConstraintTrack? Bake(IReadOnlyList<ConstraintTagRecord> records, Skeleton skeleton, PriorityLadder? ladder = null, ICollection<string>? unresolved = null)

  Resolves a whole track, skipping what this rig cannot carry.

Used by (22)

• AnimationClipContentVixen.Animation
• AuthoringTestsVixen.Animation.Tests
• ConstraintProposalVixen.Animation
• ConstraintProposalsVixen.Animation
• ConstraintTemplateContentVixen.Animation
• HarnessTestsVixen.Animation.Tests
• JointLimitTestsVixen.Animation.Tests
• TypeRegistrationVixen.Animation
• VariationHarnessVixen.Animation
• Vixen_Animation_AnimationClipContentSerializerVixen.Animation
• Vixen_Animation_Constraints_ConstraintTagRecordSerializerVixen.Animation
• Vixen_Animation_Constraints_ConstraintTemplateContentSerializerVixen.Animation
• AnimationClipAssetVixen.Editor.Assets
• AnimationClipDocumentVixen.Editor.AssetEditors
• AnimationClipImporterVixen.Editor.Assets
• AnimationClipViewVixen.Editor.AssetEditors
• AuthoringTestsVixen.Editor.AssetEditors.Tests
• ConstraintAuthoringImporterTestsVixen.Editor.Assets.Tests
• ConstraintFieldAccessVixen.Editor.AssetEditors
• ConstraintFieldAccessorVixen.Editor.AssetEditors
• ConstraintTemplateImporterVixen.Editor.Assets
• HarnessViewTestsVixen.Editor.AssetEditors.Tests