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: solution.dll
Syntax
public struct ColliderKey : IEquatable<ColliderKey>, IComparable<ColliderKey>Constructors
| Name | Description |
|---|---|
| ColliderKey(uint, uint) | Constructor. |
Fields
| Name | Description |
|---|---|
| Empty | Empty collider key. |
Properties
| Name | Description |
|---|---|
| Value | Gets or sets the value. |
Methods
| Name | Description |
|---|---|
| CompareTo(ColliderKey) | Compares this ColliderKey object to another to determine their relative ordering. |
| Equals(ColliderKey) | Tests if this ColliderKey is considered equal to another. |
| 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. |
| 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. |
| ToString() | Convert this object into a string representation. |
Operators
| Name | Description |
|---|---|
| implicit operator ColliderKey(uint) | Implicit cast that converts the given uint to a ColliderKey. |
| implicit operator uint(ColliderKey) | Implicit cast that converts the given ColliderKey to an uint. |