ObjectId Struct
Encapsulates an Object Id.
Syntax
public struct ObjectId
Remarks
An ObjectId can be derived from a Sansar.Script.ComponentId.
Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
Members
See Also: Inherited members from ValueType.
Public Fields
Public Methods
Public Operators
static
|
Equality (ObjectId, ObjectId) | ObjectId equality operator. |
static
|
Inequality (ObjectId, ObjectId) | ObjectId inequality operator. |
static
|
Conversion to Sansar.Script.ObjectId (Implicit) | Internal explicit conversion from a uint. |
Member Details
Equals Method
Value comparison for ObjectId.Syntax
Parameters
- obj
- The object to compare.
Returns
true if the argument is an ObjectId and has the same value.Remarks
This method overrides ValueType.Equals.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
GetHashCode Method
Retrieves the hash code for this instance.Syntax
public override int GetHashCode ()Returns
The hash code for this instance.Remarks
This method overrides ValueType.GetHashCode.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
Invalid Field
The invalid id object.Syntax
public static readonly ObjectId InvalidRemarks
This value is used by certain APIs to represent an invalid ObjectId.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
op_Equality Method
ObjectId equality operator.Syntax
Parameters
- a
- First ObjectId to compare.
- b
- Second ObjectId to compare.
Returns
true if the ObjectIds have the same value.Remarks
This is a value comparison.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
Conversion Method
Internal explicit conversion from a uint.Syntax
Parameters
- id
- A uint representation of an ObjectId
Returns
A new ObjectId initialized with the given uint.Remarks
Internal.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
op_Inequality Method
ObjectId inequality operator.Syntax
Parameters
- a
- First ObjectId to compare.
- b
- Second ObjectId to compare.
Returns
true if the ObjectIds have a different value.Remarks
This is a value comparison.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
ToString Method
Converts the id to a hexadecimal string representation.Syntax
public override string ToString ()Returns
The hexadecimal string representation.Remarks
This method overrides object.ToString.Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
0 Comments