Struct ColliderKey
An opaque key which packs a path to a specific leaf of a collider hierarchy into a single integer.
Inherited Members
Namespace: Unity.Physics
Assembly: Unity.Physics.dll
Syntax
public struct ColliderKey : IEquatable<ColliderKey>, IComparable<ColliderKey>Constructors
ColliderKey(uint, uint)
Constructor.
Declaration
public ColliderKey(uint numSubKeyBits, uint subKey)Parameters
| Type | Name | Description |
|---|---|---|
| uint | numSubKeyBits | Number of sub key bits. |
| uint | subKey | The sub key. |
Fields
Empty
Empty collider key.
Declaration
public static readonly ColliderKey EmptyField Value
| Type | Description |
|---|---|
| ColliderKey |
Properties
Value
Gets or sets the value.
Declaration
public readonly uint Value { get; }Property Value
| Type | Description |
|---|---|
| uint | The value. |
Methods
CompareTo(ColliderKey)
Compares this ColliderKey object to another to determine their relative ordering.
Declaration
public int CompareTo(ColliderKey other)Parameters
| Type | Name | Description |
|---|---|---|
| ColliderKey | other | Another instance to compare. |
Returns
| Type | Description |
|---|---|
| int | Negative if this object is less than the other, 0 if they are equal, or positive if this is greater. |
Equals(ColliderKey)
Tests if this ColliderKey is considered equal to another.
Declaration
public bool Equals(ColliderKey other)Parameters
| Type | Name | Description |
|---|---|---|
| ColliderKey | other | The collider key to compare to this object. |
Returns
| Type | Description |
|---|---|
| bool | True if the objects are considered equal, false if they are not. |
PopSubKey(uint, out uint)
Extract a sub key from the front of the path. "numSubKeyBits" is the maximum number of bits required to store any value for this sub key. Returns false if the key is empty.
Declaration
public bool PopSubKey(uint numSubKeyBits, out uint subKey)Parameters
| Type | Name | Description |
|---|---|---|
| uint | numSubKeyBits | Number of sub key bits. |
| uint | subKey | [out] The sub key. |
Returns
| Type | Description |
|---|---|
| bool | False if the key is empty, true otherwise. |
PushSubKey(uint, uint)
Append a sub key to the front of the path "numSubKeyBits" is the maximum number of bits required to store any value for this sub key.
Declaration
public void PushSubKey(uint numSubKeyBits, uint subKey)Parameters
| Type | Name | Description |
|---|---|---|
| uint | numSubKeyBits | Number of sub key bits. |
| uint | subKey | The sub key. |
ToString()
Convert this object into a string representation.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | A string that represents this object. |
Overrides
Operators
implicit operator ColliderKey(uint)
Implicit cast that converts the given uint to a ColliderKey.
Declaration
public static implicit operator ColliderKey(uint key)Parameters
| Type | Name | Description |
|---|---|---|
| uint | key | The key. |
Returns
| Type | Description |
|---|---|
| ColliderKey | The result of the operation. |
implicit operator uint(ColliderKey)
Implicit cast that converts the given ColliderKey to an uint.
Declaration
public static implicit operator uint(ColliderKey key)Parameters
| Type | Name | Description |
|---|---|---|
| ColliderKey | key | The key. |
Returns
| Type | Description |
|---|---|
| uint | The result of the operation. |