Struct keeshond::scene::Entity

pub struct Entity { /* private fields */ }

A handle to a living object in a Scene

Implementations

impl Entity

pub fn new(id: usize, generation: u64) -> Entity

Creates a new Entity with the given ID and generation value. You don’t normally need to call this directly. Instead, use Scene::add_entity().

pub fn null() -> Entity

Creates a “null” Entity that refers to no object in particular.

pub fn id(&self) -> usize

Returns this Entity’s identifier, used for indexing operations. ID values may be reused with other Entities, though only one Entity with a given ID may be alive at a time.

pub fn generation(&self) -> u64

Returns this Entity’s generation. This is incremented by one every time an Entity is removed and put back into the pool for reuse. When querying based on Entity, both the id and generation must match. This prevents the use of stale Entity handlers.

pub fn is_null(&self) -> bool

Return true if this is a “null” Entity that refers to no object.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Entity

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

Formats the value using the given formatter.

impl From<Entity> for DynArg

fn from(value: Entity) -> Self

Converts to this type from the input type.

impl Hash for Entity

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Entity

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Entity> for Entity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Entity> for Entity

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Entity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Entity

impl StructuralEq for Entity

impl StructuralPartialEq for Entity