Struct keeshond::scene::Entity

pub struct Entity { /* fields omitted */ }

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 get_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 get_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 Display for Entity

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

Formats the value using the given formatter.

impl Eq for Entity

impl<'_> From<&'_ SpawnArg> for Entity

fn from(arg: &SpawnArg) -> Self

Performs the conversion.

impl From<Entity> for SpawnArg

fn from(value: Entity) -> Self

Performs the conversion.

impl From<SpawnArg> for Entity

fn from(arg: SpawnArg) -> Self

Performs the conversion.

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 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 StructuralEq for Entity

impl StructuralPartialEq for Entity