Crate bevy_cobweb_ui

Bevy Cobweb UI

This crate is under development.

Tools and widgets for building UI with bevy_cobweb.

This crate features simple, easy, code-driven UI for small-to-medium-scale games. UI layout/configuration can be specified in asset files, which can be hot-reloaded or edited from a UI editor (TODO) to support efficient fine-tuning in live apps.

bevy compatability

bevy	bevy_cobweb_ui
0.13	0.0.1 - master

Modules

• prelude

Structs

• AppEventsPlugin
  Adds systems that emit events that UI nodes might react to.
• BasicImage
  CobwebStyle primitive for adding basic images.
• Block
  CobwebStyle primitive for creating single-color rectangular blocks.
• CameraUpdate
  Event broadcasted whenever a camera’s Camera or Transform changes.
• CobwebNode
  Marker component for UI nodes.
• CobwebUiPlugin
• DirtyNodeTracker
  Tracks UI nodes that need layout updates this tick.
• FullStylePath
  Stores a complete StylePath in addition to the style’s type_path.
• FullStyleRef
  Stores a fully-specified reference to a style.
• InCamera
  A UiInstruction for adding a UI root node within a specific camera’s viewport.
• LayoutSet
  SystemSet containing layout systems that run immediately before TransformPropagate, which updates GlobalTransforms.
• LayoutSetPrep
  SystemSet containing systems that prepare the UI tree for layout computation.
• LoadedStyle
  Component added to nodes that load T from the stylesheet.
• NodeBuilt
  Entity event sent by UiCommands::build to a node after its instructions are built.
• NodeSize
  Reactive component that records the 2D dimensions of a node as a rectangle on the plane of the node’s parent.
• On
  A helper struct for creating OnEvent UI instructions.
• OnEvent
  A UiInstruction for adding a reactor to keyboard inputs to a UI node.
• Parent
  A UiInstruction for adding a UI node within a specific parent node.
• Position
  Represents the position of a rectangle within another rectangle.
• RootSizeRef
  Component with the size reference of the root ancestor of a node.
• SizeRef
  Reactive component with the size reference for computing the layout of a node.
• StyleFile
  Represents the path to a stylesheet file in the asset directory.
• StyleLoader
  A UiInstruction for loading a CobwebStyle from the StyleSheet.
• StylePath
  Represents the path to a specific style in a stylesheet file.
• StyleRef
  Represents a complete reference to a style instance in a stylesheet asset.
• StyleSheet
  Reactive resource for managing styles loaded from stylesheet assets.
• UiCamera2D
  Bundle for creating a 2D camera as a UI root node.
• UiCameraRoot
  Bundle for setting up a camera as a UI root node.
• UiCommands
• UiEntityCommands
  Wrapper around EntityCommands for UI nodes being constructed.
• UiEvent
  A system event sent to UI event reactors added to UI nodes with On::<E>::new().
• UiRoot
  Component for UI root entities.
• ZLevel
  Component that controls the z-order of nodes relative to their siblings on the same parent.

Enums

• Dims
  Represents a transformation between two rectangles.
• Justified
  A CobwebStyle that wraps Position with simple justification-based settings.
• Justify
  Expresses the positioning reference of one axis of a node within another node.
• SizeRefSource
  Reactive component that controls how SizeRefs are derived during layout computation.
• StyleAssetLoaderError
  Possible errors that can be produced by the internal StyleAssetLoader.

Constants

• DEFAULT_CAMERA_Z_OFFSET
  The depth of root-level UI nodes tied to a camera, relative to the camera.
• STYLE_PATH_SEPARATOR
  The token that separates parts of a style path.
• Z_INCREMENT
  Z-increment used for ordering UI nodes relative to their parents.

Traits

• CobwebStyle
  Trait representing UiInstructions that can be loaded with StyleSheet.
• IntoStyleLoader
  Helper trait for creating StyleLoaders.
• StyleSheetListAppExt
  Extends App with methods supporting StyleSheet use.
• UiInstruction
  Helper trait for applying a UI instruction to a node entity.
• UiInstructionBundle
  Helper trait for building UI nodes with UiCommands.

Functions

• cleanup_reactor_on_despawn
  Despawns the token’s reactor when node is despawned.