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.
• 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
  The layouting systems, compute_layout, just this system as added by Plugin.
• ComputeLayoutError
  An error caused by a bad layout.
• ComputeLayoutSet
  The layouting systems, compute_layout and systems added by add_content_sized.
• Container
  Parameters of a container, ie: a node that contains other nodes.
• ContentSizedComputeSystem
  When ComputeContentSize::compute_content is evaulated. add_content_sized automatically adds the relevant systems to this set.
• LastLayoutChange
  Stores the tick of the last time compute_layout::<F> ran.
• LayoutRootCamera
  Use this camera’s logical size as the root fixed-size container for cuicui_layout.
• Oriented
  Similar to Size, but relative to a Flow direction.
• Plugin
  Add the compute_layout system to the bevy Update set.
• PosRect
  Position and size of a Node as computed by the layouting algo.
• Root
  A root Container. This acts as a Container, but layouting “starts” from it.
• 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] into the cuicui_layout layouting algorithm.
• 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.

Functions

• compute_layout
  Run the layout algorithm on entities with Node and PosRect components.
• require_layout_recompute
  A run condition to tell whether it’s necessary to recompute layout.
• update_transforms
  Update transform of things that have a PosRect component.

Type Definitions

• NodeQuery
  WorldQuery item used by the layout function.