Trait bevy_quill::View

source ·

pub trait View: Sync + Send + 'static {
    type State: Send + Sync;

    // Required methods
    fn nodes(&self, world: &World, state: &Self::State) -> NodeSpan;
    fn build(&self, cx: &mut Cx<'_, '_>) -> Self::State;
    fn rebuild(&self, cx: &mut Cx<'_, '_>, state: &mut Self::State) -> bool;
    fn raze(&self, world: &mut World, state: &mut Self::State);

    // Provided methods
    fn attach_children(
        &self,
        world: &mut World,
        state: &mut Self::State,
    ) -> bool { ... }
    fn to_root(self) -> (ViewStateCell<Self>, ViewThunk, ViewRoot)
       where Self: Sized { ... }
    fn view_type_id(&self) -> TypeId { ... }
}

Expand description

An object which produces one or more display nodes. The View is itself immutable and stateless, but it can produce a mutable state object which is updated when the view is rebuilt. This state object must be managed externally, and is passed to the View methods as a parameter.

Views also produce outputs in the form of display nodes, which are entities in the ECS world. These can be Bevy UI elements, effects, or other entities that are part of the view hierarchy.

Required Associated Types§

source

type State: Send + Sync

The external state for this View.

Required Methods§

source

fn nodes(&self, world: &World, state: &Self::State) -> NodeSpan

Return the span of entities produced by this View.

source

fn build(&self, cx: &mut Cx<'_, '_>) -> Self::State

Construct and patch the tree of UiNodes produced by this view. This may also spawn child entities representing nested components.

source

fn rebuild(&self, cx: &mut Cx<'_, '_>, state: &mut Self::State) -> bool

Update the internal state of this view, re-creating any UiNodes. Returns true if the output changed, that is, if nodes() would return a different value than it did before the rebuild.

source

fn raze(&self, world: &mut World, state: &mut Self::State)

Recursively despawn any child entities that were created as a result of calling .build(). This calls .raze() for any nested views within the current view state.

Provided Methods§

source

fn attach_children(&self, world: &mut World, state: &mut Self::State) -> bool

Instructs the view to attach any child entities to their parent entity. This is called whenever we know that one or more child entities have changed their outputs. It also does the same thing recursively for any child views of this view, but only within the current template.

This function normally returns false, which means that there is nothing more to be done. However, some view implementations are just thin wrappers around other views, in which case they should return true to indicate that the parent of this view should also re-attach its children.

source

fn to_root(self) -> (ViewStateCell<Self>, ViewThunk, ViewRoot)
where Self: Sized,

source

fn view_type_id(&self) -> TypeId

Return a unique identifier that identifies the concrete type of this view. This is used to dynamically type-check type-erased views.

Trait bevy_quill::ViewCopy item path

Required Associated Types§

type State: Send + Sync

Required Methods§

fn nodes(&self, world: &World, state: &Self::State) -> NodeSpan

fn build(&self, cx: &mut Cx<'_, '_>) -> Self::State

fn rebuild(&self, cx: &mut Cx<'_, '_>, state: &mut Self::State) -> bool

fn raze(&self, world: &mut World, state: &mut Self::State)

Provided Methods§

fn attach_children(&self, world: &mut World, state: &mut Self::State) -> bool

fn to_root(self) -> (ViewStateCell<Self>, ViewThunk, ViewRoot)where Self: Sized,

fn view_type_id(&self) -> TypeId

Implementations on Foreign Types§

impl View for ()

type State = ()

fn nodes(&self, _world: &World, _state: &<() as View>::State) -> NodeSpan

fn build(&self, _cx: &mut Cx<'_, '_>) -> <() as View>::State

fn rebuild( &self, _cx: &mut Cx<'_, '_>, _state: &mut <() as View>::State, ) -> bool

fn raze(&self, _world: &mut World, _state: &mut <() as View>::State)

impl View for String

type State = Entity

fn nodes(&self, _world: &World, state: &<String as View>::State) -> NodeSpan

fn build(&self, cx: &mut Cx<'_, '_>) -> <String as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <String as View>::State, ) -> bool

fn raze(&self, world: &mut World, state: &mut <String as View>::State)

impl View for Vec<ViewChild>

type State = Vec<Box<dyn Any + Send + Sync>>

fn nodes( &self, world: &World, state: &<Vec<ViewChild> as View>::State, ) -> NodeSpan

fn build(&self, cx: &mut Cx<'_, '_>) -> <Vec<ViewChild> as View>::State ⓘ

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <Vec<ViewChild> as View>::State, ) -> bool

fn raze(&self, world: &mut World, state: &mut <Vec<ViewChild> as View>::State)

fn attach_children( &self, world: &mut World, state: &mut <Vec<ViewChild> as View>::State, ) -> bool

impl<'a> View for &'a strwhere 'a: 'static,

type State = Entity

fn nodes(&self, _world: &World, state: &<&'a str as View>::State) -> NodeSpan

fn build(&self, cx: &mut Cx<'_, '_>) -> <&'a str as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <&'a str as View>::State, ) -> bool

fn raze(&self, world: &mut World, state: &mut <&'a str as View>::State)

impl<TupleElement0, TupleElement1> View for (TupleElement0, TupleElement1)where TupleElement0: View, TupleElement1: View,

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1) as View>::State, ) -> bool

impl<TupleElement0, TupleElement1, TupleElement2> View for (TupleElement0, TupleElement1, TupleElement2)where TupleElement0: View, TupleElement1: View, TupleElement2: View,

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1, TupleElement2) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1, TupleElement2) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2) as View>::State, ) -> bool

impl<TupleElement0, TupleElement1, TupleElement2, TupleElement3> View for (TupleElement0, TupleElement1, TupleElement2, TupleElement3)where TupleElement0: View, TupleElement1: View, TupleElement2: View, TupleElement3: View,

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State, <TupleElement3 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2, TupleElement3) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1, TupleElement2, TupleElement3) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3) as View>::State, ) -> bool

impl<TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4> View for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4)where TupleElement0: View, TupleElement1: View, TupleElement2: View, TupleElement3: View, TupleElement4: View,

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State, <TupleElement3 as View>::State, <TupleElement4 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4) as View>::State, ) -> bool

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State, <TupleElement3 as View>::State, <TupleElement4 as View>::State, <TupleElement5 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5) as View>::State, ) -> bool

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State, <TupleElement3 as View>::State, <TupleElement4 as View>::State, <TupleElement5 as View>::State, <TupleElement6 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6) as View>::State, ) -> NodeSpan

fn build( &self, cx: &mut Cx<'_, '_>, ) -> <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6) as View>::State

fn rebuild( &self, cx: &mut Cx<'_, '_>, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6) as View>::State, ) -> bool

fn raze( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6) as View>::State, )

fn attach_children( &self, world: &mut World, state: &mut <(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6) as View>::State, ) -> bool

type State = (<TupleElement0 as View>::State, <TupleElement1 as View>::State, <TupleElement2 as View>::State, <TupleElement3 as View>::State, <TupleElement4 as View>::State, <TupleElement5 as View>::State, <TupleElement6 as View>::State, <TupleElement7 as View>::State)

fn nodes( &self, world: &World, state: &<(TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6, TupleElement7) as View>::State, ) -> NodeSpan

Trait bevy_quill::View

fn to_root(self) -> (ViewStateCell<Self>, ViewThunk, ViewRoot)
where Self: Sized,

impl<'a> View for &'a str
where 'a: 'static,

impl<TupleElement0, TupleElement1> View for (TupleElement0, TupleElement1)
where TupleElement0: View, TupleElement1: View,

impl<TupleElement0, TupleElement1, TupleElement2> View for (TupleElement0, TupleElement1, TupleElement2)
where TupleElement0: View, TupleElement1: View, TupleElement2: View,

impl<TupleElement0, TupleElement1, TupleElement2, TupleElement3> View for (TupleElement0, TupleElement1, TupleElement2, TupleElement3)
where TupleElement0: View, TupleElement1: View, TupleElement2: View, TupleElement3: View,

impl<TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4> View for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4)
where TupleElement0: View, TupleElement1: View, TupleElement2: View, TupleElement3: View, TupleElement4: View,