Struct UiNode

pub struct UiNode(pub Box<dyn Control<Target = Widget>>);

UI node is a type-agnostic wrapper for any widget type. Internally, it is just a trait object that provides common widget interface. Its main use is to reduce code bloat (no need to type Box<dyn Control> everywhere, just UiNode) and to provide some useful methods such as type casting, component querying, etc. You could also be interested in Control docs, since it contains all the interesting stuff and detailed description for each method.

Tuple Fields

0: Box<dyn Control<Target = Widget>>

Implementations

impl UiNode

pub fn new<T>(widget: T) -> UiNode

where T: Control,

Creates a new UI node from any object that implements Control trait. Its main use is to finish widget creation like so:

#[derive(Clone, Visit, Reflect, Debug, ComponentProvider)]
struct MyWidget {
    widget: Widget,
}

struct MyWidgetBuilder {
    widget_builder: WidgetBuilder,
}

impl MyWidgetBuilder {
    pub fn build(self, ctx: &mut BuildContext) -> Handle<UiNode> {
        let my_widget = MyWidget {
            widget: self.widget_builder.build(ctx),
        };

        // Wrap your widget in the type-agnostic wrapper so it can be placed in the UI.
        let node = UiNode::new(my_widget);

        ctx.add_node(node)
    }
}

pub fn cast<T>(&self) -> Option<&T>

where T: Control,

Tries to perform direct downcasting to a particular widget type. It is just a simple wrapper for Any::downcast_ref.

pub fn cast_mut<T>(&mut self) -> Option<&mut T>

where T: Control,

Tries to perform direct downcasting to a particular widget type. It is just a simple wrapper for Any::downcast_mut.

pub fn query_component<T>(&self) -> Option<&T>

where T: 'static,

Tries to fetch a component of the given type T. At very basis it mimics Self::cast behaviour, but also allows you to fetch components of other types as well. For example, your widget may be built on top of existing one (via composition) and you have it as a field inside your widget. In this case, you can fetch it by using this method with the appropriate type. See docs for fyrox_core::type_traits::ComponentProvider::query_component_ref for more info.

pub fn has_component<T>(&self) -> bool

where T: 'static,

This method checks if the widget has a component of the given type T. Internally, it queries the component of the given type and checks if it exists.

Trait Implementations

impl Clone for UiNode

fn clone(&self) -> UiNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentProvider for UiNode

fn query_component_ref(&self, type_id: TypeId) -> Option<&(dyn Any + 'static)>

Allows an object to provide access to inner components.

fn query_component_mut( &mut self, type_id: TypeId, ) -> Option<&mut (dyn Any + 'static)>

Allows an object to provide access to inner components.

impl ConstructorProvider<UiNode, UserInterface> for AbsmEventProvider

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for AlphaBar

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for AnimationBlendingStateMachine

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for AnimationPlayer

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl<T> ConstructorProvider<UiNode, UserInterface> for BitField<T>

where T: BitContainer,

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Border

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Button

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Canvas

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for CheckBox

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ColorField

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ColorGradientEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ColorGradientField

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ColorPicker

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ColorPoint

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ContextMenu

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for CurveEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Decorator

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for DockingManager

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for DropdownList

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Expander

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for FileBrowser

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for FileSelector

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for FileSelectorField

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Grid

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for HotKeyEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for HueBar

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Image

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Inspector

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for KeyBindingEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ListView

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ListViewItem

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Menu

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for MenuItem

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for MessageBox

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for NinePatch

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl<T> ConstructorProvider<UiNode, UserInterface> for NumericUpDown<T>

where T: NumericType,

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for PathEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Popup

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ProgressBar

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl<T> ConstructorProvider<UiNode, UserInterface> for RangeEditor<T>

where T: NumericType,

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl<T> ConstructorProvider<UiNode, UserInterface> for RectEditor<T>

where T: NumericType,

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for SaturationBrightnessField

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Screen

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ScrollBar

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ScrollPanel

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ScrollViewer

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for SearchBar

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Selector

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for StackPanel

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for TabControl

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Text

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for TextBox

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Thumb

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Tile

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for ToggleButton

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Tree

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for TreeRoot

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for UuidEditor

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl<T, const D: usize> ConstructorProvider<UiNode, UserInterface> for VecEditor<T, D>

where T: NumericType,

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for VectorImage

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for Window

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl ConstructorProvider<UiNode, UserInterface> for WrapPanel

fn constructor() -> GraphNodeConstructor<UiNode, UserInterface>

impl Debug for UiNode

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

Formats the value using the given formatter.

impl DerefMut for UiNode

fn deref_mut(&mut self) -> &mut <UiNode as Deref>::Target

Mutably dereferences the value.

impl<T> From<T> for UiNode

where T: Control,

fn from(value: T) -> UiNode

Converts to this type from the input type.

impl NameProvider for UiNode

fn name(&self) -> &str

Returns a reference to the name of the entity.

impl Reflect for UiNode

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

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

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl SceneGraphNode for UiNode

type Base = Widget

type SceneGraph = UserInterface

type ResourceData = UserInterface

fn base(&self) -> &<UiNode as SceneGraphNode>::Base

fn set_base(&mut self, base: <UiNode as SceneGraphNode>::Base)

fn is_resource_instance_root(&self) -> bool

fn original_handle_in_resource(&self) -> Handle<UiNode>

fn set_original_handle_in_resource(&mut self, handle: Handle<UiNode>)

fn resource(&self) -> Option<Resource<<UiNode as SceneGraphNode>::ResourceData>>

fn self_handle(&self) -> Handle<UiNode>

fn parent(&self) -> Handle<UiNode>

fn children(&self) -> &[Handle<UiNode>]

fn children_mut(&mut self) -> &mut [Handle<UiNode>]

fn swap_child_position( &mut self, child: Handle<Self>, pos: usize, ) -> Option<usize>

Puts the given child handle to the given position pos, by swapping positions.

fn set_child_position( &mut self, child: Handle<Self>, dest_pos: usize, ) -> Option<usize>

fn child_position(&self, child: Handle<Self>) -> Option<usize>

fn has_child(&self, child: Handle<Self>) -> bool

fn revert_inheritable_property( &mut self, path: &str, ) -> Option<Box<dyn Reflect>>

fn component_ref<T>(&self) -> Option<&T>

where T: Any,

Tries to borrow a component of given type.

fn component_mut<T>(&mut self) -> Option<&mut T>

where T: Any,

Tries to borrow a component of given type.

fn has_component<T>(&self) -> bool

where T: Any,

Checks if the node has a component of given type.

impl TypeUuidProvider for UiNode

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for UiNode

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Deref for UiNode

type Target = dyn Control<Target = Widget>

The resulting type after dereferencing.

fn deref(&self) -> &<UiNode as Deref>::Target

Dereferences the value.