Struct TimeIndex

A time index is used to uniquely identfy an animation frame.

Namespace: Unity.Kinematica

Assembly: solution.dll

Syntax

public struct TimeIndex

Remarks

Time indices are used to uniquely identify animation frames in the motion library (which is contained in the runtime asset).

Collections of continuous animation frames that have been tagged with at least a single tag will be stored in the runtime asset during the build process. These continuous sequences are denoted as segments.

A time index in turn refers to a single animation frame that resides inside of a segment. Advancing playback time or performing any other kind of time-related manipulation uses the "time index" construct in order to ensure that reading from animation poses does not cross segment boundaries.

Fields

Name	Description
frameIndex	Denotes the frame index relative to the beginning of the segment that this time index refers to.
segmentIndex	Denotes the segment this time index refers to.

Properties

Name	Description
Invalid	Invalid time index.
IsValid	Determines if the given time index is valid or not.

Methods

Name	Description
Create(int, int)	Creates a time index from a segment and frame index.
Equals(TimeIndex)	Determines whether two time indices are equal.

See Also

Binary.Segment