Struct Document

pub struct Document {
    pub name: String,
    pub levels: Vec<DocumentLevel>,
}

A Document represents a [data::Project] (and it’s children) that is written to or read from storage.

It’s an intentionally simplified representation of the ECS datastructure optimised for serialisation.

Fields

name: String

See name in [data::Project::new].

levels: Vec<DocumentLevel>

All DocumentLevel constructed from the [data::Project]’s children.

Implementations

impl Document

pub fn new( value: (&Name, &Children), level_query: Query<'_, '_, (&Level, &Name, &Children)>, layer_query: Query<'_, '_, (&Layer, &Name, &Transform, &Children)>, object_query: Query<'_, '_, (&Element, &Name, &Transform)>, ) -> Self

Generate a new Document and it’s related children based on the current state (fetched through the level_query and layer_query queries).

The value parameter is the result of a [bevy::prelude::Query] to fetch the relevant data for the [data::Project] component.

See DocumentLevel::new for level_query.

See DocumentLayer::new for layer_query.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.