Struct ComputedNode 

pub struct ComputedNode {
    pub size: Vec2,
    pub content_size: Vec2,
    pub scrollbar_size: Vec2,
    pub scroll_position: Vec2,
    pub outline_width: f32,
    pub outline_offset: f32,
    pub unrounded_size: Vec2,
    pub border: BorderRect,
    pub border_radius: ResolvedBorderRadius,
    pub padding: BorderRect,
    pub inverse_scale_factor: f32,
}

Provides the computed size and layout properties of the node.

Fields in this struct are public but should not be modified under most circumstances. For example, in a scrollbar you may want to derive the handle’s size from the proportion of scrollable content in-view. You can directly modify ComputedNode after layout to set the handle size without any delays.

Fields

size: Vec2

The size of the node as width and height in physical pixels.

Automatically calculated by ui_layout_system.

content_size: Vec2

Size of this node’s content.

Automatically calculated by ui_layout_system.

scrollbar_size: Vec2

Space allocated for scrollbars.

Automatically calculated by ui_layout_system.

scroll_position: Vec2

Resolved offset of scrolled content

Automatically calculated by ui_layout_system.

outline_width: f32

The width of this node’s outline. If this value is Auto, negative or 0. then no outline will be rendered. Outline updates bypass change detection.

Automatically calculated by ui_layout_system.

outline_offset: f32

The amount of space between the outline and the edge of the node. Outline updates bypass change detection.

Automatically calculated by ui_layout_system.

unrounded_size: Vec2

The unrounded size of the node as width and height in physical pixels.

Automatically calculated by ui_layout_system.

border: BorderRect

Resolved border values in physical pixels. Border updates bypass change detection.

Automatically calculated by ui_layout_system.

border_radius: ResolvedBorderRadius

Resolved border radius values in physical pixels. Border radius updates bypass change detection.

Automatically calculated by ui_layout_system.

padding: BorderRect

Resolved padding values in physical pixels. Padding updates bypass change detection.

Automatically calculated by ui_layout_system.

inverse_scale_factor: f32

Inverse scale factor for this Node. Multiply physical coordinates by the inverse scale factor to give logical coordinates.

Automatically calculated by ui_layout_system.

Implementations

impl ComputedNode

pub const fn size(&self) -> Vec2

The calculated node size as width and height in physical pixels.

Automatically calculated by ui_layout_system.

Examples found in repository

examples/testbed/full_ui.rs (line 461)

pub fn update_scroll_position(
    mut mouse_wheel_reader: MessageReader<MouseWheel>,
    hover_map: Res<HoverMap>,
    mut scrolled_node_query: Query<(&mut ScrollPosition, &ComputedNode), Without<Scrollbar>>,
    keyboard_input: Res<ButtonInput<KeyCode>>,
) {
    for mouse_wheel in mouse_wheel_reader.read() {
        let (mut dx, mut dy) = match mouse_wheel.unit {
            MouseScrollUnit::Line => (mouse_wheel.x * 20., mouse_wheel.y * 20.),
            MouseScrollUnit::Pixel => (mouse_wheel.x, mouse_wheel.y),
        };

        if keyboard_input.pressed(KeyCode::ShiftLeft) || keyboard_input.pressed(KeyCode::ShiftRight)
        {
            std::mem::swap(&mut dx, &mut dy);
        }

        for (_pointer, pointer_map) in hover_map.iter() {
            for (entity, _hit) in pointer_map.iter() {
                if let Ok((mut scroll_position, scroll_content)) =
                    scrolled_node_query.get_mut(*entity)
                {
                    let visible_size = scroll_content.size();
                    let content_size = scroll_content.content_size();

                    let range = (content_size.y - visible_size.y).max(0.)
                        * scroll_content.inverse_scale_factor;

                    scroll_position.x -= dx;
                    scroll_position.y = (scroll_position.y - dy).clamp(0., range);
                }
            }
        }
    }
}

examples/ui/scroll_and_overflow/scroll.rs (line 69)

fn on_scroll_handler(
    mut scroll: On<Scroll>,
    mut query: Query<(&mut ScrollPosition, &Node, &ComputedNode)>,
) {
    let Ok((mut scroll_position, node, computed)) = query.get_mut(scroll.entity) else {
        return;
    };

    let max_offset = (computed.content_size() - computed.size()) * computed.inverse_scale_factor();

    let delta = &mut scroll.delta;
    if node.overflow.x == OverflowAxis::Scroll && delta.x != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.x > 0. {
            scroll_position.x >= max_offset.x
        } else {
            scroll_position.x <= 0.
        };

        if !max {
            scroll_position.x += delta.x;
            // Consume the X portion of the scroll delta.
            delta.x = 0.;
        }
    }

    if node.overflow.y == OverflowAxis::Scroll && delta.y != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.y > 0. {
            scroll_position.y >= max_offset.y
        } else {
            scroll_position.y <= 0.
        };

        if !max {
            scroll_position.y += delta.y;
            // Consume the Y portion of the scroll delta.
            delta.y = 0.;
        }
    }

    // Stop propagating when the delta is fully consumed.
    if *delta == Vec2::ZERO {
        scroll.propagate(false);
    }
}

pub const fn content_size(&self) -> Vec2

The calculated node content size as width and height in physical pixels.

Automatically calculated by ui_layout_system.

Examples found in repository

examples/testbed/full_ui.rs (line 462)

pub fn update_scroll_position(
    mut mouse_wheel_reader: MessageReader<MouseWheel>,
    hover_map: Res<HoverMap>,
    mut scrolled_node_query: Query<(&mut ScrollPosition, &ComputedNode), Without<Scrollbar>>,
    keyboard_input: Res<ButtonInput<KeyCode>>,
) {
    for mouse_wheel in mouse_wheel_reader.read() {
        let (mut dx, mut dy) = match mouse_wheel.unit {
            MouseScrollUnit::Line => (mouse_wheel.x * 20., mouse_wheel.y * 20.),
            MouseScrollUnit::Pixel => (mouse_wheel.x, mouse_wheel.y),
        };

        if keyboard_input.pressed(KeyCode::ShiftLeft) || keyboard_input.pressed(KeyCode::ShiftRight)
        {
            std::mem::swap(&mut dx, &mut dy);
        }

        for (_pointer, pointer_map) in hover_map.iter() {
            for (entity, _hit) in pointer_map.iter() {
                if let Ok((mut scroll_position, scroll_content)) =
                    scrolled_node_query.get_mut(*entity)
                {
                    let visible_size = scroll_content.size();
                    let content_size = scroll_content.content_size();

                    let range = (content_size.y - visible_size.y).max(0.)
                        * scroll_content.inverse_scale_factor;

                    scroll_position.x -= dx;
                    scroll_position.y = (scroll_position.y - dy).clamp(0., range);
                }
            }
        }
    }
}

examples/ui/scroll_and_overflow/scroll.rs (line 69)

fn on_scroll_handler(
    mut scroll: On<Scroll>,
    mut query: Query<(&mut ScrollPosition, &Node, &ComputedNode)>,
) {
    let Ok((mut scroll_position, node, computed)) = query.get_mut(scroll.entity) else {
        return;
    };

    let max_offset = (computed.content_size() - computed.size()) * computed.inverse_scale_factor();

    let delta = &mut scroll.delta;
    if node.overflow.x == OverflowAxis::Scroll && delta.x != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.x > 0. {
            scroll_position.x >= max_offset.x
        } else {
            scroll_position.x <= 0.
        };

        if !max {
            scroll_position.x += delta.x;
            // Consume the X portion of the scroll delta.
            delta.x = 0.;
        }
    }

    if node.overflow.y == OverflowAxis::Scroll && delta.y != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.y > 0. {
            scroll_position.y >= max_offset.y
        } else {
            scroll_position.y <= 0.
        };

        if !max {
            scroll_position.y += delta.y;
            // Consume the Y portion of the scroll delta.
            delta.y = 0.;
        }
    }

    // Stop propagating when the delta is fully consumed.
    if *delta == Vec2::ZERO {
        scroll.propagate(false);
    }
}

pub const fn is_empty(&self) -> bool

Check if the node is empty. A node is considered empty if it has a zero or negative extent along either of its axes.

pub const fn unrounded_size(&self) -> Vec2

The calculated node size as width and height in physical pixels before rounding.

Automatically calculated by ui_layout_system.

pub const fn outline_width(&self) -> f32

Returns the thickness of the UI node’s outline in physical pixels. If this value is negative or 0. then no outline will be rendered.

Automatically calculated by ui_layout_system.

pub const fn outline_offset(&self) -> f32

Returns the amount of space between the outline and the edge of the node in physical pixels.

Automatically calculated by ui_layout_system.

pub const fn outlined_node_size(&self) -> Vec2

Returns the size of the node when including its outline.

Automatically calculated by ui_layout_system.

pub const fn outline_radius(&self) -> ResolvedBorderRadius

Returns the border radius for each corner of the outline An outline’s border radius is derived from the node’s border-radius so that the outline wraps the border equally at all points.

Automatically calculated by ui_layout_system.

pub const fn border(&self) -> BorderRect

Returns the thickness of the node’s border on each edge in physical pixels.

Automatically calculated by ui_layout_system.

pub const fn border_radius(&self) -> ResolvedBorderRadius

Returns the border radius for each of the node’s corners in physical pixels.

Automatically calculated by ui_layout_system.

pub fn inner_radius(&self) -> ResolvedBorderRadius

Returns the inner border radius for each of the node’s corners in physical pixels.

pub const fn padding(&self) -> BorderRect

Returns the thickness of the node’s padding on each edge in physical pixels.

Automatically calculated by ui_layout_system.

pub fn content_inset(&self) -> BorderRect

Returns the combined inset on each edge including both padding and border thickness in physical pixels.

pub const fn inverse_scale_factor(&self) -> f32

Returns the inverse of the scale factor for this node. To convert from physical coordinates to logical coordinates multiply by this value.

Examples found in repository

examples/ui/scroll_and_overflow/scroll.rs (line 69)

fn on_scroll_handler(
    mut scroll: On<Scroll>,
    mut query: Query<(&mut ScrollPosition, &Node, &ComputedNode)>,
) {
    let Ok((mut scroll_position, node, computed)) = query.get_mut(scroll.entity) else {
        return;
    };

    let max_offset = (computed.content_size() - computed.size()) * computed.inverse_scale_factor();

    let delta = &mut scroll.delta;
    if node.overflow.x == OverflowAxis::Scroll && delta.x != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.x > 0. {
            scroll_position.x >= max_offset.x
        } else {
            scroll_position.x <= 0.
        };

        if !max {
            scroll_position.x += delta.x;
            // Consume the X portion of the scroll delta.
            delta.x = 0.;
        }
    }

    if node.overflow.y == OverflowAxis::Scroll && delta.y != 0. {
        // Is this node already scrolled all the way in the direction of the scroll?
        let max = if delta.y > 0. {
            scroll_position.y >= max_offset.y
        } else {
            scroll_position.y <= 0.
        };

        if !max {
            scroll_position.y += delta.y;
            // Consume the Y portion of the scroll delta.
            delta.y = 0.;
        }
    }

    // Stop propagating when the delta is fully consumed.
    if *delta == Vec2::ZERO {
        scroll.propagate(false);
    }
}

pub fn contains_point(&self, transform: UiGlobalTransform, point: Vec2) -> bool

pub fn normalize_point( &self, transform: UiGlobalTransform, point: Vec2, ) -> Option<Vec2>

Transform a point to normalized node space with the center of the node at the origin and the corners at [+/-0.5, +/-0.5]

pub fn resolve_clip_rect( &self, overflow: Overflow, overflow_clip_margin: OverflowClipMargin, ) -> Rect

Resolve the node’s clipping rect in local space

pub fn border_box(&self) -> Rect

Returns the node’s border-box in object-centered physical coordinates. This is the full rectangle enclosing the node.

pub fn padding_box(&self) -> Rect

Returns the node’s padding-box in object-centered physical coordinates. This is the region inside the border containing the node’s padding and content areas.

pub fn content_box(&self) -> Rect

Returns the node’s content-box in object-centered physical coordinates. This is the innermost region of the node, where its content is placed.

pub fn horizontal_scrollbar(&self) -> Option<(Rect, [f32; 2])>

Compute the bounds of the horizontal scrollbar and the thumb in object-centered coordinates.

pub fn vertical_scrollbar(&self) -> Option<(Rect, [f32; 2])>

Compute the bounds of the vertical scrollbar and the thumb in object-centered coordinates.

impl ComputedNode

pub const DEFAULT: ComputedNode

Trait Implementations

impl Clone for ComputedNode

fn clone(&self) -> ComputedNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ComputedNode

where ComputedNode: Send + Sync + 'static,

Required Components: ComputedStackIndex.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<ComputedNode>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Copy for ComputedNode

impl Debug for ComputedNode

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

Formats the value using the given formatter.

impl Default for ComputedNode

fn default() -> ComputedNode

Returns the “default value” for a type.

impl FromArg for ComputedNode

type This<'from_arg> = ComputedNode

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<ComputedNode as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for ComputedNode

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<ComputedNode>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for ComputedNode

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for ComputedNode

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for ComputedNode

fn into_return<'into_return>(self) -> Return<'into_return>

where ComputedNode: 'into_return,

Converts Self into a Return value.

impl PartialEq for ComputedNode

fn eq(&self, other: &ComputedNode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for ComputedNode

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<ComputedNode>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<ComputedNode>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<ComputedNode>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ComputedNode

fn into_any(self: Box<ComputedNode>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<ComputedNode>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for ComputedNode

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl StructuralPartialEq for ComputedNode

impl TypePath for ComputedNode

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ComputedNode

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.