MLCoordinateFrameUID
A unique identifier which represents a coordinate frame. The unique identifier is comprised of two values.
Public Fields
EmptyFrame
Gets an initialized MLCoordinateFrameUID.
public static MLCoordinateFrameUID EmptyFrame { get; set; }
| Type | Description |
|---|---|
| MLCoordinateFrameUID | A unique identifier which represents a coordinate frame. The unique identifier is comprised of two values. |
Returns: An initialized MLCoordinateFrameUID.
Public Methods
override bool Equals
The equality check to be used for when being compared to an object.
public override bool Equals(
object obj
)
Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | The object to compare to this one with. |
Returns: True if the the provided object is of the MLCoordinateFrameUID type and has the same two data values.
void FromGuid
Sets First and Second data value based on given GUID.
public void FromGuid(
Guid guid
)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | guid | GUID needed to calculate both data values. |
void FromString
Sets First and Second data value based on given GUID in stirng form.
public void FromString(
string guidString
)
Parameters
| Type | Name | Description |
|---|---|---|
| string | guidString | GUID needed to calculate both data values |
void FromULongPair
Sets First and Second value.
public void FromULongPair(
ulong first,
ulong second
)
Parameters
| Type | Name | Description |
|---|---|---|
| ulong | first | First data value. |
| ulong | second | Second data value. |
override int GetHashCode
Gets the hash code to use from the first data value.
public override int GetHashCode()
Returns: The hash code returned by the first data value of this object
MLCoordinateFrameUID
Constructor getting two ulongs as argument.
public MLCoordinateFrameUID(
ulong first,
ulong second
)
Parameters
| Type | Name | Description |
|---|---|---|
| ulong | first | First data value. |
| ulong | second | Second data value. |
MLCoordinateFrameUID
Constructor getting GUID as argument.
public MLCoordinateFrameUID(
Guid guid
)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | guid | GUID from which both values will be calculated. |
MLCoordinateFrameUID
Constructor getting GUID as argument in string form.
public MLCoordinateFrameUID(
string guidString
)
Parameters
| Type | Name | Description |
|---|---|---|
| string | guidString | GUID from which both values will be calculated. |
Guid ToGuid
Returns the GUID based on the values of this MLCoordinateFrameUID.
public Guid ToGuid()
Returns: The calculated GUID.
override string ToString
Returns the string value of the GUID of this MLCoordinateFrameUID.
public override string ToString()
Returns: The string value of the GUID.
bool operator!=
The inequality check to be used for comparing two MLCoordinateFrameUID structs.
public static bool operator!=(
MLCoordinateFrameUID one,
MLCoordinateFrameUID two
)
Parameters
| Type | Name | Description |
|---|---|---|
| MLCoordinateFrameUID | one | The first struct to compare with the second struct. |
| MLCoordinateFrameUID | two | The second struct to compare with the first struct. |
Returns: True if the two provided structs do not have the same two data values.
bool operator==
The equality check to be used for comparing two MLCoordinateFrameUID structs.
public static bool operator==(
MLCoordinateFrameUID one,
MLCoordinateFrameUID two
)
Parameters
| Type | Name | Description |
|---|---|---|
| MLCoordinateFrameUID | one | The first struct to compare with the second struct. |
| MLCoordinateFrameUID | two | The second struct to compare with the first struct. |
Returns: True if the two provided structs have the same two data values.
Public Attributes
First
The first data value.
public ulong First;
Second
The second data value.
public ulong Second;