Struct UserInterface

Source

pub struct UserInterface {
    pub drawing_context: DrawingContext,
    pub style: Resource<Style>,
    pub default_font: Resource<Font>,
    pub double_click_time_slice: f32,
    pub tooltip_appear_delay: f32,
    pub standard_material: WidgetMaterial,
    pub render_target: Option<Resource<Texture>>,
    pub render_mode: RenderMode,
    pub need_render: bool,
    pub user_data: DynTypeContainer,
    /* private fields */
}

Fields§

§drawing_context: DrawingContext§style: Resource<Style>§default_font: Resource§double_click_time_slice: f32§tooltip_appear_delay: f32§standard_material: WidgetMaterial§render_target: Option<Resource<Texture>>

Optional render target of the user interface. The UI will be rendered in such target with and the target size will be set to the screen size of the user interface.

§render_mode: RenderMode

Render mode of the user interface. See RenderMode docs for more info.

§need_render: bool

A flag that indicates that the UI should be rendered. It is only taken into account if the render mode is set to RenderMode::OnChanges.

§user_data: DynTypeContainer

Struct UserInterface Copy item path

Fields§

Implementations§

impl UserInterface

pub const SCREEN_SIZE: &'static str = "screen_size"

pub const NODES: &'static str = "nodes"

pub const VISUAL_DEBUG: &'static str = "visual_debug"

pub const ROOT_CANVAS: &'static str = "root_canvas"

pub const PICKED_NODE: &'static str = "picked_node"

pub const PREV_PICKED_NODE: &'static str = "prev_picked_node"

pub const CAPTURED_NODE: &'static str = "captured_node"

pub const KEYBOARD_FOCUS_NODE: &'static str = "keyboard_focus_node"

pub const CURSOR_POSITION: &'static str = "cursor_position"

pub const STYLE: &'static str = "style"

pub const STACK: &'static str = "stack"

pub const PICKING_STACK: &'static str = "picking_stack"

pub const DRAG_CONTEXT: &'static str = "drag_context"

pub const MOUSE_STATE: &'static str = "mouse_state"

pub const KEYBOARD_MODIFIERS: &'static str = "keyboard_modifiers"

pub const CURSOR_ICON: &'static str = "cursor_icon"

pub const DOUBLE_CLICK_TIME_SLICE: &'static str = "double_click_time_slice"

pub const TOOLTIP_APPEAR_DELAY: &'static str = "tooltip_appear_delay"

pub const STANDARD_MATERIAL: &'static str = "standard_material"

pub const RENDER_TARGET: &'static str = "render_target"

pub const RENDER_MODE: &'static str = "render_mode"

pub const NEED_RENDER: &'static str = "need_render"

pub const USER_DATA: &'static str = "user_data"

impl UserInterface

pub fn new( screen_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> UserInterface

pub fn new_with_channel( sender: Sender<UiMessage>, receiver: Receiver<UiMessage>, screen_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> UserInterface

pub fn set_tooltip_appear_delay(&mut self, appear_delay: f32)

pub fn tooltip_appear_delay(&self) -> f32

pub fn active_tooltip(&self) -> Option<&TooltipEntry>

pub fn keyboard_modifiers(&self) -> KeyboardModifiers

pub fn build_ctx(&mut self) -> BuildContext<'_>

pub fn capture_mouse( &mut self, node: Handle<impl ObjectOrVariant<UiNode>>, ) -> bool

pub fn release_mouse_capture(&mut self)

pub fn is_node_enabled(&self, handle: Handle<UiNode>) -> bool

pub fn screen_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn set_screen_size( &mut self, screen_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, )

pub fn invalidate_layout(&mut self)

pub fn update_layout( &mut self, screen_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, )

pub fn update( &mut self, screen_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, dt: f32, switches: &UiUpdateSwitches, )

pub fn style(&self) -> &Resource<Style> ⓘ

pub fn set_style(&mut self, style: Resource<Style>)

pub fn cursor(&self) -> CursorIcon

pub fn set_time(&mut self, elapsed_time: f32)

pub fn clipboard(&self) -> Option<Ref<'_, X11ClipboardContext>>

pub fn clipboard_mut(&self) -> Option<RefMut<'_, X11ClipboardContext>>

pub fn arrange_node( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, final_rect: &Rect<f32>, ) -> bool

pub fn measure_node( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, available_size: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> bool

pub fn cursor_position( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn hit_test_unrestricted( &self, pt: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> Handle<UiNode>

pub fn hit_test( &self, pt: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> Handle<UiNode>

pub fn is_node_child_of( &self, node_handle: Handle<impl ObjectOrVariant<UiNode>>, root_handle: Handle<impl ObjectOrVariant<UiNode>>, ) -> bool

pub fn has_descendant_or_equal( &self, node_handle: Handle<impl ObjectOrVariant<UiNode>>, root_handle: Handle<impl ObjectOrVariant<UiNode>>, ) -> bool

pub fn sender(&self) -> Sender<UiMessage>

pub fn send_message(&self, message: UiMessage)

pub fn send_messages<const N: usize>(&self, messages: [UiMessage; N])

pub fn send( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, data: impl MessageData, )

pub fn send_handled( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, data: impl MessageData, )

pub fn send_sync( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, data: impl MessageData, )

pub fn send_with_flags<T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, flags: u64, data: T, )where T: MessageData,

pub fn send_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )where T: MessageData,

pub fn send_sync_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )where T: MessageData,

pub fn post<T>(&self, handle: Handle<impl ObjectOrVariant<UiNode>>, data: T)where T: MessageData,

pub fn post_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )where T: MessageData,

pub fn poll_message_queue(&mut self) -> PollResult

§Routing Scheme

§Returns

pub fn poll_message(&mut self) -> Option<UiMessage>

pub fn screen_to_root_canvas_space( &self, position: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn captured_node(&self) -> Handle<UiNode>

pub fn process_os_event(&mut self, event: &OsEvent) -> bool

pub fn nodes(&self) -> &Pool<UiNode, WidgetContainer>

pub fn root(&self) -> Handle<UiNode>

pub fn take_reserve( &mut self, handle: Handle<UiNode>, ) -> (Ticket<UiNode>, UiNode)

pub fn put_back( &mut self, ticket: Ticket<UiNode>, node: UiNode, ) -> Handle<UiNode>

pub fn forget_ticket(&mut self, ticket: Ticket<UiNode>, node: UiNode) -> UiNode

pub fn take_reserve_sub_graph(&mut self, root: Handle<UiNode>) -> SubGraph

Struct UserInterface

pub fn send_with_flags<T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, flags: u64, data: T, )
where T: MessageData,

pub fn send_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )
where T: MessageData,

pub fn send_sync_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )
where T: MessageData,

pub fn post<T>(&self, handle: Handle<impl ObjectOrVariant<UiNode>>, data: T)
where T: MessageData,

pub fn post_many<const N: usize, T>( &self, handle: Handle<impl ObjectOrVariant<UiNode>>, payload: [T; N], )
where T: MessageData,

pub fn copy_node_to<Post>( &self, node: Handle<UiNode>, dest: &mut UserInterface, post_process_callback: &mut Post, ) -> (Handle<UiNode>, NodeHandleMap<UiNode>)
where Post: FnMut(Handle<UiNode>, Handle<UiNode>, &mut UiNode),

pub async fn load_from_file<P>( path: P, constructors: Arc<GraphNodeConstructorContainer<UiNode, UserInterface>>, dyn_type_constructors: Arc<DynTypeConstructorContainer>, resource_manager: ResourceManager, ) -> Result<UserInterface, VisitError>
where P: AsRef<Path>,

impl<T> ConstructorProvider<UiNode, UserInterface> for BitField<T>
where T: BitContainer,