Struct ScrollPanel 

pub struct ScrollPanel {

    pub screen: Option<AssetId>,
    pub x: f32,
    pub y: f32,
    pub width: f32,
    pub height: f32,
    pub rows: Vec<ScrollRow>,
    pub groups: Vec<ScrollGroup>,
    pub thumb: Option<AssetId>,
    pub track: Option<AssetId>,
    pub track_x: f32,
    pub track_y: f32,
    pub track_w: f32,
    pub track_h: f32,
}

Runtime model that makes a band of UI rows scrollable and (optionally) collapsible.

A ScrollPanel is emitted by the build (e.g. by a settings menu) and read by the UI at runtime; it is not hand-authored. It names a content band (a fixed rectangle in the menu’s reference canvas), the ordered rows that live inside it, the collapsible groups some rows belong to, and the scrollbar thumb/track sprites. The UI lays the rows out each frame: a collapsed group’s body rows hide and the rows below them move up; when the visible stack is taller than the band it scrolls (mouse wheel or thumb drag) and rows outside the band are clipped.

All pixel fields are in the same reference-space coordinates as the Screen’s other UI (see the overlay scaling notes on MainMenu).

Fields

screen: Option<AssetId>

Screen this panel belongs to. Resolved automatically from the <screen>_* naming convention; you don’t set this directly. The panel is only live while its screen is active.

x: f32

Left edge of the content band in reference pixels.

y: f32

Top edge of the content band in reference pixels.

width: f32

Width of the content band in reference pixels.

height: f32

Height of the content band (the visible window) in reference pixels.

rows: Vec<ScrollRow>

The rows in the band, top to bottom.

groups: Vec<ScrollGroup>

Collapsible groups, referenced by index from ScrollRow::group.

thumb: Option<AssetId>

Scrollbar thumb Sprite the UI moves and resizes. None for a panel with no scrollbar.

track: Option<AssetId>

Scrollbar track Sprite. Hidden along with the thumb when the content fits the band.

track_x: f32

Left edge of the scrollbar track in reference pixels.

track_y: f32

Top edge of the scrollbar track in reference pixels.

track_w: f32

Width of the scrollbar track in reference pixels.

track_h: f32

Height of the scrollbar track in reference pixels (the thumb travels within it).

Trait Implementations

impl Clone for ScrollPanel

fn clone(&self) -> ScrollPanel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ScrollPanel

const NAME: &'static str = "ScrollPanel"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<ScrollPanel, 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.

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).

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.

impl ComponentSlot for ScrollPanel

const DISCRIMINANT: u8

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

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

Borrow this type’s column out of the storage.

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

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

impl Debug for ScrollPanel

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

Formats the value using the given formatter.

impl Default for ScrollPanel

fn default() -> ScrollPanel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScrollPanel

where ScrollPanel: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ScrollPanel> for ComponentAsset

fn from(c: ScrollPanel) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for ScrollPanel

impl Serialize for ScrollPanel

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.