Struct HitRegion 

pub struct HitRegion {

    pub x: f32,
    pub y: f32,
    pub width: f32,
    pub height: f32,
    pub label: Option<AssetId>,
    pub hover_color: Option<[f32; 3]>,
    pub hover_scale: Option<f32>,
    pub action: String,
    pub drag_handle: Option<AssetId>,
    pub screen: Option<AssetId>,
    pub disabled: bool,
    pub follow_label: bool,
    pub fit: SpriteFit,
}

A responsive invisible rectangular region in screen space.

When clicked, fires an action. When hovered, it optionally restyles a referenced TextLabel (colour and/or scale).

The cursor must be free (not captured for camera control) for events to fire.

HitRegion {
    x: 430.0,
    y: 330.0,
    width: 220.0,
    height: 40.0,
    hover_color: Some([1.0, 0.85, 0.3]),
    hover_scale: Some(1.08),
    ..Default::default()
};

Fields

x: f32

Left edge of the region in window pixels.

y: f32

Top edge of the region in window pixels.

width: f32

Width of the region in window pixels.

height: f32

Height of the region in window pixels.

label: Option<AssetId>

A TextLabel to style on hover. None = no label effect.

hover_color: Option<[f32; 3]>

RGB colour applied to the label while hovered. None = no change.

hover_scale: Option<f32>

Scale applied to the label while hovered. None = no change.

action: String

Action to fire on click. Recognised forms: "scene:<name>", "quit", "screen:show:<name>", "screen:hide", "screen:toggle:<name>".

drag_handle: Option<AssetId>

The Sprite a Slider drag region moves along its track. None for ordinary regions. Set automatically when a Slider expands; you don’t set this directly.

screen: Option<AssetId>

Screen this region belongs to. Resolved automatically from the naming convention (a region named <screen>_* belongs to screen <screen>); you don’t set this directly. While a screen is active, only the top capturing screen’s regions fire; with no screen active, only screen-less regions fire.

disabled: bool

Whether this region is inert. A disabled region never hovers or fires. Set by the engine at runtime (e.g. a settings row whose feature the GPU cannot provide is disabled and grayed out); you don’t set this directly.

follow_label: bool

When set, this region tracks its referenced label: it follows the label’s vertical position (so a menu the engine lays out at runtime keeps its buttons clickable) and is inert while the label’s text is empty (so a hidden menu entry does not catch clicks). Requires label.

fit: SpriteFit

How a screen-owned region maps from the reference canvas to the window when their aspect ratios differ (matches Sprite’s fit). Bottom keeps a region aligned with bottom-anchored furniture it covers. A region spanning the whole reference canvas always covers the full window regardless of fit.

Trait Implementations

impl Authored for HitRegion

const TYPE: &'static str = "HitRegion"

The registered asset type, as it appears in a world line’s type.

impl Clone for HitRegion

fn clone(&self) -> HitRegion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for HitRegion

const NAME: &'static str = "HitRegion"

The registry name a world authors this component under.

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

const DISCRIMINANT: u8

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

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

Borrow this type’s column out of the storage.

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

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

impl Debug for HitRegion

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

Formats the value using the given formatter.

impl Default for HitRegion

fn default() -> HitRegion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HitRegion

where HitRegion: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl RuntimeComponent for HitRegion

impl Serialize for HitRegion

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.