Table of Contents

Component UiWidget

Methods Properties Base Classes Derived Classes
Render DebugMouseInteraction uiwidget
Constructor DebugSelected
Update DepthSeparation
DoubleClickTime
FocusWidget
MouseDownWidget
MouseHoldTime
MouseHoverTime
MouseOverWidget

Properties


DebugMouseInteraction : boolean

Whether or not to print out debug information to the console about what the mouse is currently doing.

var DebugMouseInteraction : Boolean

DebugSelected : cog

var DebugSelected : Cog

DepthSeparation : real

Used for debugging.

var DepthSeparation : Real

DoubleClickTime : real

The amount of time between clicks to send the 'DoubleClick' event.

var DoubleClickTime : Real

FocusWidget : uiwidget

The widget that currently has focus.

var FocusWidget : UiWidget

MouseDownWidget : uiwidget

read-only

The widget that the mouse was pressed down on.

var MouseDownWidget : UiWidget

MouseHoldTime : real

Only send the 'MouseHold' event when the mouse has been holding on a single widget for this amount of time.

var MouseHoldTime : Real

MouseHoverTime : real

Only send the MouseHover event when the mouse has been over a single widget for this amount of time.

var MouseHoverTime : Real

MouseOverWidget : uiwidget

read-only

The widget that the mouse is currently over.

var MouseOverWidget : UiWidget

Methods


Render : Void

Renders the Ui to the given color render target. The depth render target must have stencil. |Name|Type|Description| |---|---|---| |e|rendertasksevent| | |color|rendertarget| | |depth|rendertarget| | |renderPass|materialblock| |

function Render(e : RenderTasksEvent, color : RenderTarget, depth : RenderTarget, renderPass : MaterialBlock)

UiRootWidget : Void

constructor

Name Type Description
function UiRootWidget()

Update : Void

Updates all widgets and layouts that need to be updated. This should be called right before rendering. |Name|Type|Description| |---|---|---|

function Update()