Struct Binary.Interval
An interval contains information about a sequence of animation frames that collectively share the same set of tags.
Namespace: Unity.Kinematica
Syntax
public struct IntervalRemarks
The runtime asset building process only considers animation frames that are tagged with at least a single trait. Continuous sequences of such frames are arranged into segments. Segments in turn can contain multiple intervals with different traits applied. Intervals are therefore defined to be sequences of animation frames that collectively share the same set of tags.
Fields
codeBookIndex
Denotes the associated code book.
Declaration
public Binary.CodeBookIndex codeBookIndexField Value
| Type | Description |
|---|---|
| Binary.CodeBookIndex |
firstFrame
Denotes the first frame of the sequence of frames relative to the segment.
Declaration
public int firstFrameField Value
| Type | Description |
|---|---|
| Int32 |
numFrames
Denotes the number of sequence frames relative to the segment.
Declaration
public int numFramesField Value
| Type | Description |
|---|---|
| Int32 |
segmentIndex
Denotes the segment this interval belongs to.
Declaration
public Binary.SegmentIndex segmentIndexField Value
| Type | Description |
|---|---|
| Binary.SegmentIndex |
tagListIndex
Association with list of tags that are defined over this interval.
Declaration
public Binary.TagListIndex tagListIndexField Value
| Type | Description |
|---|---|
| Binary.TagListIndex |
Properties
onePastLastFrame
Denotes the end frame of the sequence of frames relative to the segment.
Declaration
public int onePastLastFrame { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
timeIndex
Denotes a time index corresponding to the first frame of the interval.
Declaration
public TimeIndex timeIndex { get; }Property Value
| Type | Description |
|---|---|
| TimeIndex |
Methods
Contains(Int32)
Determines whether or not the given frame index is contained in the interval.
Declaration
public bool Contains(int frameIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | frameIndex |
Returns
| Type | Description |
|---|---|
| Boolean | True if the given frame index is contained in this interval; false otherwise. |
Contains(TimeIndex)
Determines whether or not the given time index is contained in the interval.
Declaration
public bool Contains(TimeIndex timeIndex)Parameters
| Type | Name | Description |
|---|---|---|
| TimeIndex | timeIndex |
Returns
| Type | Description |
|---|---|
| Boolean | True if the given time index is contained in this interval; false otherwise. |
GetTimeIndex(Int32)
Creates a time index relative to the beginning of the interval.
Declaration
public TimeIndex GetTimeIndex(int frameIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | frameIndex | An index that is relative to the beginning of the interval. |
Returns
| Type | Description |
|---|---|
| TimeIndex | Time index relative to the beginning of the interval. |