Struct Binary.MetricIndex
Denotes an index into the list of metrics contained in the runtime asset.
Namespace: Unity.Kinematica
Syntax
public struct MetricIndexProperties
Invalid
Invalid metric index.
Declaration
public static Binary.MetricIndex Invalid { get; }Property Value
| Type | Description |
|---|---|
| Binary.MetricIndex |
IsValid
Determines if the given metric index is valid or not.
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| Boolean | True if the metric index is valid; false otherwise. |
Methods
Equals(Binary.MetricIndex)
Determines whether two metric indices are equal.
Declaration
public bool Equals(Binary.MetricIndex metricIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Binary.MetricIndex | metricIndex | 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.MetricIndex)
Implicit conversion from an integer value to a metric index.
Declaration
public static implicit operator Binary.MetricIndex(int metricIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | metricIndex |
Returns
| Type | Description |
|---|---|
| Binary.MetricIndex |
Implicit(Binary.MetricIndex to Int32)
Implicit conversion from a metric index to an integer value.
Declaration
public static implicit operator int (Binary.MetricIndex metricIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Binary.MetricIndex | metricIndex |
Returns
| Type | Description |
|---|---|
| Int32 |