Struct Binary.SegmentIndex
Denotes an index into the list of segments contained in the runtime asset.
Namespace: Unity.Kinematica
Syntax
public struct SegmentIndex
Properties
Invalid
Invalid segment index.
Declaration
public static Binary.SegmentIndex Invalid { get; }
Property Value
| Type | Description |
|---|---|
| Binary.SegmentIndex |
IsValid
Determines if the given segment index is valid or not.
Declaration
public bool IsValid { get; }
Property Value
| Type | Description |
|---|---|
| Boolean | True if the segment index is valid; false otherwise. |
Methods
Equals(Binary.SegmentIndex)
Determines whether two segment indices are equal.
Declaration
public bool Equals(Binary.SegmentIndex segmentIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| Binary.SegmentIndex | segmentIndex | The index to compare against the current index. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the specified index is equal to the current index; otherwise, false. |
Operators
Implicit(Int32 to Binary.SegmentIndex)
Implicit conversion from an integer value to a segment index.
Declaration
public static implicit operator Binary.SegmentIndex(int segmentIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | segmentIndex |
Returns
| Type | Description |
|---|---|
| Binary.SegmentIndex |
Implicit(Binary.SegmentIndex to Int32)
Implicit conversion from a segment index to an integer value.
Declaration
public static implicit operator int (Binary.SegmentIndex segmentIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| Binary.SegmentIndex | segmentIndex |
Returns
| Type | Description |
|---|---|
| Int32 |