Urho
1.0.0.0
Urho.UrhoObject
UI subsystem. Manages the graphical user interface.
Urho3D implements a simple, hierarchical user interface system based on rectangular elements. The elements provided are:
-
: a texture image with an optional border
-
: a pushbutton
-
: a button that can be toggled on/off
-
: a mouse cursor
-
: shows a vertical list of items (optionally scrollable) as a popup
-
: a single-line text editor
-
: shows a scrollable vertical list of items
-
: a button which can show a popup element
-
: a slider with back and forward buttons
-
: a scrollable view of child elements
-
: a horizontal or vertical slider bar
-
: a texture image which supports subpixel positioning, scaling and rotating.
-
: static text that can be multiline
-
: a popup which automatically displays itself when the cursor hovers on its parent element.
-
: container for other elements, renders nothing by itself
-
: a window that renders a 3D viewport
-
: a movable and resizable window
The root UI element can be queried from the UI subsystem. It is an empty canvas () as large as the application window, into which other elements can be added.
Elements are added into each other similarly as scene nodes, using the and .
To allow the elements react to mouse input, either a mouse cursor element must be defined using the property or the operating system mouse cursor must be set visible from the subsystem.
Constructor
1.0.0.0
Constructs a new instance of Urho.Gui.UI which is tied to the .
Constructor
1.0.0.0
Pointer to the raw unmanaged Urho object.
Constructs a new instance of Urho.Gui.UI, given a raw pointer to an unmanaged object
This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.
Objects that are created in this fashion get registered with the UrhoSharp runtime.
This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.
Constructor
1.0.0.0
The context that this object will be attached to.
Constructs a new instance of Urho.Gui.UI linked to a specific .
Constructor
1.0.0.0
Pass UrhoObjectFlag.Empty.
Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.
This constructor should be invoked by your code if you provide your own constructor that sets the handle field.
This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.
You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.
Method
1.0.0.0
System.Void
Clear the UI (excluding the cursor.)
To be added.
Property
1.0.0.0
System.String
Return clipboard text.
Or
Set clipboard text.
To be added.
To be added.
Property
1.0.0.0
Urho.Gui.Cursor
Return cursor.
Or
Set cursor UI element.
To be added.
To be added.
Property
1.0.0.0
Urho.IntVector2
Return cursor position.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
Debug draw a UI element.
To be added.
Property
1.0.0.0
System.Single
Return tooltip default display delay in seconds.
Or
Set tooltip default display delay in seconds.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return UI element double click interval in seconds.
Or
Set UI element double click interval in seconds.
To be added.
To be added.
Property
1.0.0.0
System.Int32
Return UI drag start event distance threshold in pixels.
Or
Set UI drag event start distance threshold in pixels.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return UI drag start event interval in seconds.
Or
Set UI drag event start interval in seconds.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether a drag is in progress.
To be added.
To be added.
Event
1.0.0.0
System.Action<Urho.Gui.FocusChangedEventArgs>
To be added.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Property
1.0.0.0
Urho.Gui.UIElement
Return focused element.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether is using forced autohinting.
Or
Set whether to force font autohinting instead of using FreeType's TTF bytecode interpreter.
To be added.
To be added.
Property
1.0.0.0
Urho.Gui.UIElement
Return topmost enabled root-level non-modal element.
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.UIElement
To be added.
Return the drag element at index.
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.UIElement
To be added.
To be added.
Return UI element at screen coordinates. By default returns only input-enabled elements.
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.UIElement
To be added.
To be added.
To be added.
Return UI element at screen coordinates. By default returns only input-enabled elements.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
Return true when UI has modal element(s).
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.UIElement
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.UIElement
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
To be added.
To be added.
Property
1.0.0.0
System.Int32
Return font texture maximum size.
Or
Set maximum font face texture size. Must be a power of two. Default is 2048.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Determines whether mouse wheel can control also a non-focused element..
To be added.
To be added.
Property
1.0.0.0
System.UInt32
Return the number of currently dragged elements.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
Render the UI. If resetRenderTargets is true, is assumed to be the default UI render to backbuffer called by Engine, and will be performed only once. Additional UI renders to a different rendertarget may be triggered from the renderpath.
To be added.
Method
1.0.0.0
System.Void
Update the UI for rendering. Called by HandleRenderUpdate().
To be added.
Property
1.0.0.0
Urho.Gui.UIElement
Return root UI element.
To be added.
To be added.
Property
1.0.0.0
Urho.Gui.UIElement
Return root modal element.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
To be added.
To be added.
To be added.
Property
1.0.0.0
System.Single
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
Set focused UI element.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
Set modal element. Until all the modal elements are dismissed, all the inputs and events are only sent to them. Return true when successful.
Only the modal element can clear its modal status or when it is being destructed.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the FocusChanged event raised by the UI.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the UIDropFile event raised by the UI.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the UIMouseClick event raised by the UI.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the UIMouseClickEnd event raised by the UI.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Property
1.0.0.0
Urho.StringHash
Urho's type system type.
StringHash representing the type for this C# type.
This returns the Urho's type and is surfaced for low-level Urho code.
Property
1.0.0.0
System.String
Urho's low-level type name.
Stringified low-level type name.
Property
1.0.0.0
System.String
Urho's low-level type name, accessible as a static method.
Stringified low-level type name.
Property
1.0.0.0
Urho.StringHash
Urho's low-level type, accessible as a static method.
This returns the Urho's type and is surface for the low-level Urho code.
Event
1.0.0.0
System.Action<Urho.Gui.UIDropFileEventArgs>
To be added.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Event
1.0.0.0
System.Action<Urho.Gui.UIMouseClickEventArgs>
To be added.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Event
1.0.0.0
System.Action<Urho.Gui.UIMouseClickEndEventArgs>
To be added.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Method
1.0.0.0
System.Void
To be added.
Update the UI logic. Called by HandlePostUpdate().
To be added.
Property
1.0.0.0
System.Boolean
Return whether is using mutable (eraseable) glyphs for fonts.
Or
Set whether to use mutable (eraseable) glyphs to ensure a font face never expands to more than one texture. Default false.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether focusing a %LineEdit will show the on-screen keyboard.
Or
Set whether to show the on-screen keyboard (if supported) when a %LineEdit is focused. Default true on mobile devices.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether is using the system clipboard.
Or
Set whether to use system clipboard. Default false.
To be added.
To be added.