Struct DynamicTreeProxyId 

pub struct DynamicTreeProxyId { /* private fields */ }

Stable handle for a proxy stored in a DynamicTree.

The generation component prevents accidentally reusing a stale handle after a proxy has been destroyed and another proxy has reused the same Box3D proxy index.

Implementations

impl DynamicTreeProxyId

pub const fn index(self) -> i32

Returns the Box3D proxy index portion of this handle.

pub const fn generation(self) -> u64

Returns the generation paired with the native proxy index.

A mismatched generation means the handle refers to a proxy that has already been removed or whose index has been recycled by Box3D.

Trait Implementations

impl Clone for DynamicTreeProxyId

fn clone(&self) -> DynamicTreeProxyId

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DynamicTreeProxyId

impl Debug for DynamicTreeProxyId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DynamicTreeProxyId

impl Hash for DynamicTreeProxyId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DynamicTreeProxyId

fn cmp(&self, other: &DynamicTreeProxyId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DynamicTreeProxyId

fn eq(&self, other: &DynamicTreeProxyId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DynamicTreeProxyId

fn partial_cmp(&self, other: &DynamicTreeProxyId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DynamicTreeProxyId