Struct rin::scene::CreationProxy

pub struct CreationProxy<'a> { /* fields omitted */ }

Implementations

impl<'a> CreationProxy<'a>

pub fn new(
    entities: EntitiesCreation<'a>,
    resources: ResourcesCreation<'a>
) -> CreationProxy<'a>

pub fn clone(&mut self) -> CreationProxy<'_>

pub fn as_storages(&mut self) -> CreationStorages<'_>

Trait Implementations

impl<'a> CreationContextExt<'a> for CreationProxy<'a>

pub fn with_entities_and_resources_creation<'e, F, R>(&'e mut self, f: F) -> R where
    F: FnOnce(EntitiesCreation<'e>, ResourcesCreation<'e>) -> R, 

impl<'a> EntitiesCreationExt<'a> for CreationProxy<'a>

pub fn with_entities_creation<'e, F, R>(&'e mut self, f: F) -> R where
    F: FnOnce(EntitiesCreation<'e>) -> R, 

pub fn new_entity(&mut self) -> EntityBuilder<'_>

Returns an EntityBuilder that allows to create an entity and it’s components.

pub fn creation_storage<C>(&mut self) -> CreationSto<'_, C> where
    C: Component, 

pub fn add_component_to<'r, C>(&mut self, entity: &Entity, component: C) where
    C: ComponentSend,
    <C as Component>::Storage: for<'s> Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

pub fn add_component_to_thread_local<'r, C>(
    &mut self,
    entity: &Entity,
    component: C
) where
    C: ComponentThreadLocal,
    <C as Component>::Storage: for<'s> Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

pub fn add_tag_to<C>(&mut self, entity: &Entity) where
    C: 'static, 

Adds a Tag to an already existing Entity.

pub fn add_child_component_to<'r, C>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    C: ComponentSend,
    <C as Component>::Storage: for<'b> HierarchicalStorage<'b, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send Component to an already existing Entity.

pub fn add_child_component_to_thread_local<'r, C>(
    &mut self,
    parent: &Entity,
    entity: &Entity,
    component: C
) where
    C: ComponentThreadLocal,
    <C as Component>::Storage: for<'b> HierarchicalStorage<'b, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send Component to an already existing Entity.

pub fn add_slice_component_to<'r, C, I>(
    &mut self,
    entity: &Entity,
    component: I
) where
    C: OneToNComponentSend,
    I: IntoIterator<Item = C>,
    <C as Component>::Storage: for<'s> OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a Send OneToNComponent to an already existing Entity.

pub fn add_slice_component_to_thread_local<'r, C, I>(
    &mut self,
    entity: &Entity,
    component: I
) where
    C: OneToNComponentThreadLocal,
    I: IntoIterator<Item = C>,
    <C as Component>::Storage: for<'s> OneToNStorage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Adds a non Send OneToNComponent to an already existing Entity.

pub fn remove_component_from<'r, C>(&mut self, entity: &Entity) where
    C: Component,
    <C as Component>::Storage: for<'s> Storage<'s, C>,
    <<C as Component>::Storage as Storage<'r, C>>::Get: DebugParameter, 

Removes a compoenent of the specified type from an entity.

pub fn remove_entity(&mut self, entity: &Entity)

Removes an Entity and all it’s compoenents.

impl<'a> EntitiesExt<'a> for CreationProxy<'a>

pub fn iter_for<'e, S>(&'e self) -> <S as UnorderedData<'e>>::Iter where
    S: UnorderedDataSend<'e> + ReadOnlyOp<'e>, 

Iterator over all the components that match the operator

pub fn iter_for_mut<'e, S>(&'e mut self) -> <S as UnorderedData<'e>>::IterMut where
    S: UnorderedDataSend<'e>, 

Iterator over all the components that match the operator

pub fn ordered_iter_for<'e, S>(&'e self) -> <S as OrderedData<'e>>::Iter where
    S: OrderedDataSend<'e> + ReadOnlyOrderedOp<'e>, 

Iterator over ordered data

pub fn ordered_iter_for_mut<'e, S>(&'e mut self) -> <S as OrderedData<'e>>::Iter where
    S: OrderedDataSend<'e>, 

Iterator over ordered data

pub fn entity_components<'r, S>(
    &'r self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedDataSend<'r> + ReadOnlyOp<'r> + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>,
    <<S as UnorderedData<'r>>::Storage as StorageRef<'r>>::Component == <S as UnorderedData<'r>>::ComponentsRef, 

Similar to iter_for_entities but for one entity instead of several

pub fn entity_components_mut<'r, S>(
    &'r mut self,
    entity: &Entity
) -> Option<<S as UnorderedData<'r>>::ComponentsRef> where
    S: UnorderedDataSend<'r> + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>,
    <<S as UnorderedData<'r>>::Storage as StorageRef<'r>>::Component == <S as UnorderedData<'r>>::ComponentsRef, 

pub fn iter_for_entities<'e, U, E>(
    &'e self,
    entities: E
) -> <E as IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>>::IntoEntitiesIter where
    E: IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>,
    U: UnorderedDataSend<'e>,
    <U as UnorderedData<'e>>::Storage: ReadOnlyStorage, 

Iterator for the specified operators over a set of entities instead of every entity in the world

pub fn iter_for_entities_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> <E as IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>>::IntoEntitiesIterMut where
    E: IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>,
    U: UnorderedDataSend<'e>, 

pub fn iter_for_entities_opt<'e, U, E>(
    &'e self,
    entities: E
) -> <E as IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>>::IntoEntitiesOptIter where
    E: IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>,
    U: UnorderedDataSend<'e>,
    <U as UnorderedData<'e>>::Storage: ReadOnlyStorage, 

pub fn iter_for_entities_opt_mut<'e, U, E>(
    &'e mut self,
    entities: E
) -> <E as IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>>::IntoEntitiesOptIterMut where
    E: IntoEntitiesIterator<'e, <U as UnorderedData<'e>>::Storage>,
    U: UnorderedDataSend<'e>, 

pub fn component_for<C>(&self, entity: &Entity) -> Option<Ptr<'_, C>> where
    C: ComponentSend,
    <C as Component>::Storage: for<'s> Storage<'s, C>, 

Returns a component for reading for the passed entity

pub fn component_for_mut<C>(&self, entity: &Entity) -> Option<PtrMut<'_, C>> where
    C: ComponentSend,
    <C as Component>::Storage: for<'s> Storage<'s, C>, 

Returns a component for writing for the passed entity

pub fn has_component<C>(&self, entity: &Entity) -> bool where
    C: 'static, 

Returns true if the entity has the specified component

pub fn tree_node_for<C>(&self, entity: &Entity) -> Option<NodePtr<'_, C>> where
    C: ComponentSend,
    <C as Component>::Storage: for<'b> HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component

pub fn tree_node_for_mut<C>(&self, entity: &Entity) -> Option<NodePtrMut<'_, C>> where
    C: ComponentSend,
    <C as Component>::Storage: for<'b> HierarchicalStorage<'b, C>, 

Returns the node for a hierarchical component for writing

pub fn changed_iter_for<'r, S>(
    &'r self
) -> EntitiesComponentIter<'r, <S as ChangedData<'r>>::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedDataSend<'r> + EntitiesData + ReadOnlyOp<'r> + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

Iterator for the specified operators only over the entities whose component as specified in the first operator has changed

pub fn changed_iter_for_mut<'r, S>(
    &'r mut self
) -> EntitiesComponentIter<'r, <S as ChangedData<'r>>::ChangedIter, <S as UnorderedData<'r>>::Storage> where
    S: ChangedDataSend<'r> + EntitiesData + 'r,
    <S as UnorderedData<'r>>::Storage: StorageRef<'r>, 

pub fn storage_for<'r, S>(&'r self) -> Sto<'r, S> where
    S: UnorderedDataSend<'r> + ReadOnlyOp<'r>, 

Storage for the operator passed as type parameter

pub fn storage_for_mut<'r, S>(&'r mut self) -> Sto<'r, S> where
    S: UnorderedDataSend<'r>, 

impl<'a> ResourcesCreationExt for CreationProxy<'a>

pub fn with_resources_creation<F, R>(&mut self, f: F) -> R where
    F: FnOnce(ResourcesCreation<'_>) -> R, 

pub fn add_resource<T>(&mut self, resource: T) where
    T: 'static + Send, 

Adds a Send resource to the world.

pub fn remove_resource<T>(&mut self) -> Option<T> where
    T: 'static, 

Removes a resource of the specified type.

pub fn add_resource_thread_local<T>(&mut self, resource: T) where
    T: 'static, 

Adds a non Send resource to the world.

pub fn add_resource_as_trait<T, U, F, FMut>(&mut self, resource: (T, F, FMut)) where
    T: 'static + Send,
    F: Fn(&T) -> &U + 'static,
    U: 'static + Send + ?Sized,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a Send resource to the world accessible as a &dyn Trait.

pub fn add_resource_as_trait_thread_local<T, U, F, FMut>(
    &mut self,
    resource: (T, F, FMut)
) where
    T: 'static,
    F: Fn(&T) -> &U + 'static,
    U: 'static + ?Sized,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a non Send resource to the world accessible as a &dyn Trait.

impl<'a> ResourcesExt for CreationProxy<'a>

pub fn resource<T>(&self) -> Option<ReadGuardRef<'_, T>> where
    T: 'static + Send, 

pub fn resource_mut<T>(&self) -> Option<WriteGuardRef<'_, T, ()>> where
    T: 'static + Send, 

pub fn resource_as_trait<T>(&self) -> Option<ReadGuardRef<'_, T>> where
    T: 'static + Send + ?Sized, 

pub fn resource_as_trait_mut<T>(&self) -> Option<WriteGuardRef<'_, T, ()>> where
    T: 'static + Send + ?Sized, 

impl<'a> ResourcesThreadLocalExt for CreationProxy<'a>

pub fn resource_thread_local<T>(&self) -> Option<ReadGuardRef<'_, T>> where
    T: 'static, 

pub fn resource_thread_local_mut<T>(&self) -> Option<WriteGuardRef<'_, T, ()>> where
    T: 'static, 

pub fn resource_as_trait_thread_local<T>(&self) -> Option<ReadGuardRef<'_, T>> where
    T: 'static + ?Sized, 

pub fn resource_as_trait_thread_local_mut<T>(
    &self
) -> Option<WriteGuardRef<'_, T, ()>> where
    T: 'static + ?Sized,