Skip to main content

LayoutContainer

Struct LayoutContainer 

Source
pub struct LayoutContainer {
    pub x: f32,
    pub y: f32,
    pub col_gap: f32,
    pub row_gap: f32,
    pub rows: Vec<LayoutRow>,
    pub visible: bool,
}
Expand description

Positions a set of TextLabels as a stack of rows, so a HUD does not have to hand-place every chip. Each row lays its labels out left to right; rows stack top to bottom. The container owns the labels’ on-screen position: the labels keep their own styling (font, colour, background, padding) but their x/y are overwritten each frame.

Sizing is content-driven: a label is measured at its current text, so the layout reflows as live HUD values change width. A row with a single label sits on its own line beneath the previous row, which is how a wide chip (e.g. a multi-pass timing line) ends up spanning the width of the row above.

Labels referenced by cols are matched by name; a label whose font is not loaded, or which is hidden, is skipped and reserves no space.

LayoutContainer {
    x: 10.0,
    y: 10.0,
    col_gap: 6.0,
    row_gap: 6.0,
    ..Default::default()
};

Fields§

§x: f32

Left edge of the container in window pixels.

§y: f32

Top edge of the container in window pixels.

§col_gap: f32

Pixels between adjacent labels in a row, measured between their background boxes.

§row_gap: f32

Pixels between adjacent rows, measured between their background boxes.

§rows: Vec<LayoutRow>

Rows of labels, top to bottom.

§visible: bool

When false, the container leaves its labels where they are instead of repositioning them.

Implementations§

Source§

impl LayoutContainer

Source

pub fn layout( &self, size_of: impl Fn(AssetId) -> Option<LabelBox>, ) -> Vec<LabelPlacement>

Resolve the text origin for every label in the container.

size_of returns a label’s measured box, or None to drop it from the layout (unknown label, unloaded font, hidden). The result is pure geometry: callers measure with their font metrics, this places the boxes. Boxes within a row are laid edge-to-edge with col_gap between them; rows are stacked with row_gap between them.

Source

pub fn layout_into( &self, size_of: impl Fn(AssetId) -> Option<LabelBox>, out: &mut Vec<LabelPlacement>, )

LayoutContainer::layout writing into a caller-owned buffer, so a per-frame caller reuses its capacity. Clears out first.

Trait Implementations§

Source§

impl Clone for LayoutContainer

Source§

fn clone(&self) -> LayoutContainer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Component for LayoutContainer

Source§

const NAME: &'static str = "LayoutContainer"

The registry name a world authors this component under.
Source§

fn from_baked(bytes: &[u8]) -> Result<Self, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.
Source§

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).
Source§

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.
Source§

impl ComponentSlot for LayoutContainer

Source§

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.
Source§

fn slot(s: &ComponentStorage) -> &Column<Self>

Borrow this type’s column out of the storage.
Source§

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Self>

Mutably borrow this type’s column out of the storage.
Source§

impl Debug for LayoutContainer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LayoutContainer

Source§

fn default() -> LayoutContainer

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for LayoutContainer

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<LayoutContainer, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<LayoutContainer> for ComponentAsset

Source§

fn from(c: LayoutContainer) -> Self

Converts to this type from the input type.
Source§

impl RuntimeComponent for LayoutContainer

Source§

impl Serialize for LayoutContainer

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.