Struct Binary.Tag

Tags are used to associate a trait to a sequence of animation frames.

Namespace: Unity.Kinematica
Syntax
public struct Tag
Remarks

Tags can be used in a variety of scenarios:

  • Narrow the result of a query
  • Control behavior of a task

    Tags are a general purpose tool that allows a custom trait to be associated with a sequence of animation frames. Queries support tags directly by allowing to include or exclude animation frames based on the associated tags.

    Tags can also be accessed directly given a reference to the runtime asset and therefore tasks can perform any kind of custom processing based on them.

Fields

firstFrame

Denotes the first frame this tag refers to.

Declaration
public int firstFrame
Field Value
Type Description
Int32

intervalIndex

Denotes the first interval index for this tag.

Declaration
public Binary.IntervalIndex intervalIndex
Field Value
Type Description
Binary.IntervalIndex
See Also

numFrames

Denotes the number of frames this tag refers to.

Declaration
public int numFrames
Field Value
Type Description
Int32

numIntervals

Denotes the number of intervals this tag belongs to.

Declaration
public int numIntervals
Field Value
Type Description
Int32

segmentIndex

Denotes the segment this tag belongs to.

Declaration
public Binary.SegmentIndex segmentIndex
Field Value
Type Description
Binary.SegmentIndex

traitIndex

Denotes the associated trait.

Declaration
public Binary.TraitIndex traitIndex
Field Value
Type Description
Binary.TraitIndex

Properties

FirstFrame

Denotes the first frame this tag refers to.

Declaration
public int FirstFrame { get; }
Property Value
Type Description
Int32

NumFrames

Denotes the number of frames this tag refers to.

Declaration
public int NumFrames { get; }
Property Value
Type Description
Int32

OnePastLastFrame

Denotes the one-past-last frame this tag refer to.

Declaration
public int OnePastLastFrame { get; }
Property Value
Type Description
Int32

See Also