Struct ChangeTracker

Source
pub struct ChangeTracker<T>
where T: Component,
{ /* private fields */ }
Expand description

Helper to track changes in T components

For each entity with a T component, a private component is inserted which stores the value as of the most recent call to track. This provides robust, exact change detection at the cost of visiting each possibly-changed entity. It is a good fit for entities that will typically be visited regardless, and components having fast Clone and PartialEq impls. For components which are expensive to compare and/or clone, consider instead tracking changes manually, e.g. by setting a flag in the component’s DerefMut implementation.

Always use exactly one ChangeTracker per World per component type of interest. Using multiple trackers of the same T on the same world, or using the same tracker across multiple worlds, will produce unpredictable results.

Implementations§

Source§

impl<T> ChangeTracker<T>
where T: Component,

Source

pub fn new() -> ChangeTracker<T>

Create a change tracker for T components

Source

pub fn track<'a>(&'a mut self, world: &'a mut World) -> Changes<'a, T>
where T: Clone + PartialEq,

Determine the changes in T components in world since the previous call

Trait Implementations§

Source§

impl<T> Default for ChangeTracker<T>
where T: Component,

Source§

fn default() -> ChangeTracker<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ChangeTracker<T>

§

impl<T> RefUnwindSafe for ChangeTracker<T>
where T: RefUnwindSafe,

§

impl<T> !Send for ChangeTracker<T>

§

impl<T> !Sync for ChangeTracker<T>

§

impl<T> Unpin for ChangeTracker<T>
where T: Unpin,

§

impl<T> UnwindSafe for ChangeTracker<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Finalize for T

Source§

unsafe fn finalize_raw(data: *mut ())

Safety Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Initialize for T
where T: Default,

Source§

fn initialize(&mut self)

Source§

unsafe fn initialize_raw(data: *mut ())

Safety Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.