Interface IGaitDriverSpace

Namespace

CodeSmile.AnyMotion.AnimateYourself.Spaces

/

Assembly

ApiSource.dll

Applies a GaitPose to a rig. The three implementations exist to be compared: each consumes the same pose from the same parameters, so a difference in the result is attributable to the space and not to different timing or different gait maths.

public interface IGaitDriverSpace

Expand Details ...

Properties

BindError

Reason Bind(Animator, RigMetrics, BindPose) failed, or null.

string BindError { get; }

Property Value

string

DisplayName

Short label for the comparison table.

string DisplayName { get; }

Property Value

string

Kind

GaitDriverSpaceKind Kind { get; }

Property Value

GaitDriverSpaceKind

SupportsAnimationRigging

False when this space overwrites whatever Animation Rigging produced, making the two mutually exclusive.

bool SupportsAnimationRigging { get; }

Property Value

bool

SupportsLimbTargets

False when the space cannot place a hand or foot at a chosen point, which R10 requires.

bool SupportsLimbTargets { get; }

Property Value

bool

SupportsMasking

False when the space can only write the whole body, so partial-body jank is impossible.

bool SupportsMasking { get; }

Property Value

bool

Methods

Apply(in GaitPose, float)

Writes the pose to the rig. weight blends between the bind pose at 0 and the full gait at 1, which the distance LOD tiers of R4 need in order to fade a tier in and out rather than switch it.

void Apply(in GaitPose pose, float weight)

Parameters

Type	Name	Description
GaitPose	pose
float	weight

Bind(Animator, RigMetrics, BindPose)

Prepares the space for one rig. Returns false and sets BindError on failure.

bool Bind(Animator animator, RigMetrics metrics, BindPose bindPose)

Parameters

Type	Name	Description
Animator	animator
RigMetrics	metrics
BindPose	bindPose	Reference pose to restore to before each write, resolved once by the caller so that all spaces share it. Never read this from the live Transforms: doing so lets an animated pose become the reference, after which rotations stack on a pose that already contains a frame of gait.

Returns

bool