Struct LayoutDsl

pub struct LayoutDsl<T = BaseDsl> { /* private fields */ }

The DslBundle for layouting.

The defaults are:

• For containers: Child sized, meaning a container node has the minimum size to fit all its children.
• Distribution::FillMain
• Alignment::Center

For terminal nodes (spawned through spawn or ui) the default size is [LeafRule::Fixed(0.)], or content-sized.

Implementations

impl<D: DslBundle> LayoutDsl<D>

pub fn flow(&mut self, flow: Flow)

Set the flow direction of a container node.

pub fn column(&mut self)

Spawn this Node as a Node::Container with children flowing vertically.

f will then build the children of this Container.

pub fn row(&mut self)

Spawn this Node as a Node::Container with children flowing horizontally.

f will then build the children of this Container.

pub fn distrib_start(&mut self)

Push children of this Node to the start of the main flow axis, the default is Distribution::FillMain.

pub fn distrib_end(&mut self)

Push children of this Node to the end of the main flow axis, the default is Distribution::FillMain.

pub fn fill_main_axis(&mut self)

Distribute the children of this Node to fill this Container’s main flow axis.

Note that this is the default.

pub fn layout(&mut self, spec: &str)

Set properties based on the given spec.

spec specifies the flow, (d)istribution and (a)lignment of the container in the form: [v>]d[SEC]a[SEC].

legal values are: Start, End or Center.

An error is logged on illegal values.

pub fn margins(&mut self, main: f32, cross: f32)

Set both the cross and main margins.

pub fn margin(&mut self, pixels: f32)

Set both the cross and main margins to pixels

pub fn main_margin(&mut self, pixels: f32)

Set this Container’s margin on the main flow axis.

pub fn cross_margin(&mut self, pixels: f32)

Set this Container’s margin on the cross flow axis.

pub fn rules(&mut self, width: Rule, height: Rule)

Set both width and height rules.

pub fn width(&mut self, rule: Rule)

Set the width Rule of this Node.

pub fn height(&mut self, rule: Rule)

Set the height Rule of this Node.

pub fn align_start(&mut self)

Use Alignment::Start for this Node, the default is Alignment::Center.

pub fn align_end(&mut self)

Use Alignment::End for this Node, the default is Alignment::Center.

pub fn screen_root(&mut self)

Set this node as the ScreenRoot, its size will follow that of the LayoutRootCamera camera.

pub fn root(&mut self)

Set this node as a Root.

pub fn empty_pct(&mut self, percent: u8)

Spawn an empty Node::Axis with the main axis set to percent% of parent’s size, and the cross axis to 0.

Panics

If percent is greater than 100. It would mean this node overflows its parent.

pub fn empty_px(&mut self, pixels: u16)

Spawn an empty Node::Axis with the main axis set to pixels pixels and the cross axis to 0.

pub fn ui<M>(&mut self, ui_bundle: impl IntoUiBundle<M>)

Spawn ui_bundle.

Note that axis without set rules or Rule::Children are considered content-sized.

Trait Implementations

impl<D: Debug> Debug for LayoutDsl<D>

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

Formats the value using the given formatter.

impl<T: Default> Default for LayoutDsl<T>

fn default() -> LayoutDsl<T>

Returns the “default value” for a type.

impl<T> Deref for LayoutDsl<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for LayoutDsl<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<D: DslBundle> DslBundle for LayoutDsl<D>

fn insert(&mut self, cmds: &mut EntityCommands<'_, '_, '_>)

Add given Bundle to the entity.

fn node( &mut self, cmds: &mut EntityCommands<'_, '_, '_>, f: impl FnOnce(&mut ChildBuilder<'_, '_, '_>), )

Spawn the entity as a parent of other entities.

impl<D: DslBundle + ParseDsl> ParseDsl for LayoutDsl<D>

fn method(&mut self, data: MethodCtx<'_, '_, '_>) -> Result<(), Error>

Apply method named name to self.