Crate cuicui_layout

Layouting system for bevy cuicui.

The layouting system is very dumb. It is based on Containers. A Container layouts its content in either a column or a row.

The individual items are positioned according to:

• Container::align: The container’s children Alignment.
• Container::distrib: The container’s children Distribution.
• Container::flow: The direction in which the container’s children Flow.

By default, items are aligned at the center of the container, distributed on the flow direction evenly within the container.

All things in a cuicui layout has a known size. This is why everything needs to live in a root container of a fixed size.

That’s it! Now make a nice UI using bevy.

Re-exports

• pub use dsl::LayoutDsl;

Modules

• bundles
  Bevy [Bundle]s grouping components used by the layouting systems.
• debug
  Debug overlay for cuicui_layout.
• dsl
  The LayoutDsl type used to bring layout bundles to the cuicui_dsl::dsl macro.
• dsl_functions
  Functions to simplify using dsl::LayoutDsl.

Macros

• dsl
  Reorganize rust method syntax to play wonderfully with bevy’s hierarchy spawning mechanism.

Structs

• ComputeLayout
  Mark compute_layout as added by Plugin.
• ComputeLayoutError
  An error caused by a bad layout.
• ComputeLayoutSet
  compute_layout and systems added by add_content_sized.
• Container
  Parameters of a container, ie: a node that contains other nodes.
• ContentSizedComputeSystem
  The system added by add_content_sized for S.
• ContentSizedComputeSystemSet
  All systems added by add_content_sized.
• LastLayoutChange
  Stores the tick of the last time compute_layout ran.
• LayoutRect
  Position and size of a Node as computed by the layouting algo.
• LayoutRootCamera
  Use this camera’s logical size as the root container size.
• LeafNode
  A Node that can’t have children.
• LeafNodeInsertWitness
  Whether a apply_deferred needs to run after the last run of update_leaf_nodes.
• Oriented
  Similar to Size, but relative to a Flow direction.
• Plugin
  Add layout-related sets and systems to the Update schedule.
• Root
  A root Container.
• ScreenRoot
  Set this Root to track the LayoutRootCamera’s size.
• Size
  A T that applies to the width and height of something.

Enums

• Alignment
  The cross axis alignment. Aka alignment.
• Distribution
  The main axis alignment. Aka distribution.
• Flow
  The layout direction of a Container.
• LeafRule
  A constraint on an axis of a terminal Node (ie: doesn’t have a Children constraint).
• Node
  A [Component] integrating the attached [Entity] in cuicui_layout.
• Rule
  A constraint on an axis of containers.

Traits

• AppContentSizeExt
  Extends [App] to support adding ComputeContentSize.
• ComputeContentParam
  The static version of whatever implements ComputeContentSize.
• ComputeContentSize
  A [SystemParam] to compute the size of content-sized layout Nodes.
• DslBundle
  The type used in a dsl! macro to create bundles to spawn when creating the entity tree.
• IntoEntityCommands
  Convert this into an [EntityCommands].

Functions

• compute_layout
  Run the layout algorithm.
• require_layout_recompute
  A run condition to tell whether it’s necessary to recompute layout.
• update_leaf_nodes
  Add/remove LeafNode component according to the current Node state.