Struct specs_hierarchy::HierarchySystem

source ·

pub struct HierarchySystem<P> { /* private fields */ }

Expand description

System for maintaining a Hierarchy resource.

Type parameters:

P: Component type that provides Parent links for the maintained Hierarchy

Implementations

source

impl HierarchySystem

source

pub fn new() -> Self

Trait Implementations

source

impl<'a, P> System<'a> for HierarchySystemwhere
P: Component + Parent + Send + Sync + 'static,
P::Storage: Tracked,

type SystemData = (ParentData<'a, P>, Write<'a, Hierarchy, HierarchySetupHandler>)

The resource bundle required to execute this system. Read more

source

fn run(&mut self, (data, hierarchy): Self::SystemData)

Executes the system with the required system data. Read more

source

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they’re executed (might allow more parallelization). Read more

source

fn accessor<'b>(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the SystemData.

source

fn setup(&mut self, res: &mut Resources)

Sets up the Resources using Self::SystemData::setup.

source

fn dispose(self, res: &mut Resources)where
Self: Sized,

Performs clean up that requires resources from the Resources. Read more

Auto Trait Implementations

impl RefUnwindSafe for HierarchySystemwhere
P: RefUnwindSafe,

impl Send for HierarchySystemwhere
P: Send,

impl Sync for HierarchySystemwhere
P: Sync,

impl Unpin for HierarchySystemwhere
P: Unpin,

impl UnwindSafe for HierarchySystemwhere
P: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Any for Twhere
T: Any,

fn get_type_id(&self) -> TypeId

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<'a, T> RunNow<'a> for Twhere
T: System<'a>,

source

fn run_now(&mut self, res: &'a Resources)

Runs the system now. Read more

source

fn setup(&mut self, res: &mut Resources)

Sets up Resources for a later call to run_now.

source

fn dispose(self: Box<T, Global>, res: &mut Resources)

Performs clean up that requires resources from the Resources. Read more

source

impl<'a, T> RunWithPool<'a> for Twhere
T: System<'a>,

source

fn setup(&mut self, res: &mut Resources)

Sets up Resources for a later call to run.

source

fn run(&mut self, res: &'a Resources, _: &ThreadPool)

Runs the system/group of systems. Possibly in parallel depending on how the structure is set up. Read more

source

fn reads(&self, reads: &mut Vec<ResourceId, Global>)

Accumulates the necessary read/shared resources from the systems in this group. Read more

source

fn writes(&self, writes: &mut Vec<ResourceId, Global>)

Accumulates the necessary write/exclusive resources from the systems in this group. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> Erased for T

source

impl<T> Event for Twhere
T: 'static + Send + Sync,

source

Struct specs_hierarchy::HierarchySystem

Type parameters:

Implementations

impl<P> HierarchySystem<P>

pub fn new() -> Self

Trait Implementations

impl<'a, P> System<'a> for HierarchySystem<P>where P: Component + Parent + Send + Sync + 'static, P::Storage: Tracked,

type SystemData = (ParentData<'a, P>, Write<'a, Hierarchy<P>, HierarchySetupHandler<P>>)

fn run(&mut self, (data, hierarchy): Self::SystemData)

fn running_time(&self) -> RunningTime

fn accessor<'b>(&'b self) -> AccessorCow<'a, 'b, Self>

fn setup(&mut self, res: &mut Resources)

fn dispose(self, res: &mut Resources)where Self: Sized,

Auto Trait Implementations

impl<P> RefUnwindSafe for HierarchySystem<P>where P: RefUnwindSafe,

impl<P> Send for HierarchySystem<P>where P: Send,

impl<P> Sync for HierarchySystem<P>where P: Sync,

impl<P> Unpin for HierarchySystem<P>where P: Unpin,

impl<P> UnwindSafe for HierarchySystem<P>where P: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Any for Twhere T: Any,

fn get_type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<'a, T> RunNow<'a> for Twhere T: System<'a>,

fn run_now(&mut self, res: &'a Resources)

fn setup(&mut self, res: &mut Resources)

fn dispose(self: Box<T, Global>, res: &mut Resources)

impl<'a, T> RunWithPool<'a> for Twhere T: System<'a>,

fn setup(&mut self, res: &mut Resources)

fn run(&mut self, res: &'a Resources, _: &ThreadPool)

fn reads(&self, reads: &mut Vec<ResourceId, Global>)

fn writes(&self, writes: &mut Vec<ResourceId, Global>)

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

type Error = Infallible

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

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

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

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

impl<T> Erased for T

impl<T> Event for Twhere T: 'static + Send + Sync,

impl<T> Resource for Twhere T: Any + Send + Sync,

impl<'a, P> System<'a> for HierarchySystem<P>where
P: Component + Parent + Send + Sync + 'static,
P::Storage: Tracked,

fn dispose(self, res: &mut Resources)where
Self: Sized,

impl<P> RefUnwindSafe for HierarchySystem<P>where
P: RefUnwindSafe,

impl<P> Send for HierarchySystem<P>where
P: Send,

impl<P> Sync for HierarchySystem<P>where
P: Sync,

impl<P> Unpin for HierarchySystem<P>where
P: Unpin,

impl<P> UnwindSafe for HierarchySystem<P>where
P: UnwindSafe,

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

impl<T> Any for Twhere
T: Any,

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

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

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

impl<'a, T> RunNow<'a> for Twhere
T: System<'a>,

impl<'a, T> RunWithPool<'a> for Twhere
T: System<'a>,

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

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

impl<T> Event for Twhere
T: 'static + Send + Sync,

impl<T> Resource for Twhere
T: Any + Send + Sync,