Component UiWidget
Properties
AbsoluteMinSize : real2
The minimum size this widget has to be when being laid out.
var AbsoluteMinSize : Real2
Active : boolean
Active getter / setter.
var Active : Boolean
CanTakeFocus : boolean
var CanTakeFocus : Boolean
ClipChildren : boolean
var ClipChildren : Boolean
DockMode : UiDockMode
Used in the dock layout.
var DockMode : UiDockMode
FlexSize : real2
Flex size used in conjunction with mSizePolicy (if FlexSize is set).
var FlexSize : Real2
HasFocus : boolean
read-only
var HasFocus : Boolean
HierarchyColor : real4
Color that cascades down to children.
var HierarchyColor : Real4
HierarchyHasFocus : boolean
read-only
var HierarchyHasFocus : Boolean
HorizontalAlignment : UiHorizontalAlignment
Alignments used to shift widgets when in a layout.
var HorizontalAlignment : UiHorizontalAlignment
InLayout : boolean
If true, we will be ignored when our parent updates the layout. Disable this if you want to manually place this widget.
var InLayout : Boolean
Interactive : boolean
var Interactive : Boolean
LocalBottom : real
var LocalBottom : Real
LocalBottomCenter : real2
var LocalBottomCenter : Real2
LocalBottomLeft : real2
var LocalBottomLeft : Real2
LocalBottomRight : real2
var LocalBottomRight : Real2
LocalCenter : real2
var LocalCenter : Real2
LocalCenterLeft : real2
var LocalCenterLeft : Real2
LocalCenterRight : real2
var LocalCenterRight : Real2
LocalColor : real4
Color that does not cascade to children. It is, however, affected by the parents color.
var LocalColor : Real4
LocalLeft : real
var LocalLeft : Real
LocalRectangle : rectangle
Returns our rect relative to parent. The origin of this Rect is bottom left.
var LocalRectangle : Rectangle
LocalRight : real
var LocalRight : Real
LocalTop : real
var LocalTop : Real
LocalTopCenter : real2
var LocalTopCenter : Real2
LocalTopLeft : real2
var LocalTopLeft : Real2
LocalTopRight : real2
var LocalTopRight : Real2
LocalTranslation : real2
Local Translation relative to parent.
var LocalTranslation : Real2
MarginBottom : real
var MarginBottom : Real
MarginLeft : real
var MarginLeft : Real
MarginRight : real
var MarginRight : Real
MarginTop : real
var MarginTop : Real
MouseOver : boolean
read-only
var MouseOver : Boolean
MouseOverHierarchy : boolean
read-only
var MouseOverHierarchy : Boolean
OnTop : boolean
var OnTop : Boolean
Root : uirootwidget
read-only
Hide the ComponentHierarchy with a more specific root type.
var Root : UiRootWidget
Size : real2
Size getter / setter. This acts as a shortcut to the Area Component.
var Size : Real2
SizePolicyX : UiSizePolicy
var SizePolicyX : UiSizePolicy
SizePolicyY : UiSizePolicy
var SizePolicyY : UiSizePolicy
VerticalAlignment : UiVerticalAlignment
Alignments used to shift widgets when in a layout.
var VerticalAlignment : UiVerticalAlignment
Visible : boolean
var Visible : Boolean
WorldBottom : real
var WorldBottom : Real
WorldBottomCenter : real2
var WorldBottomCenter : Real2
WorldBottomLeft : real2
var WorldBottomLeft : Real2
WorldBottomRight : real2
var WorldBottomRight : Real2
WorldCenter : real2
var WorldCenter : Real2
WorldCenterLeft : real2
var WorldCenterLeft : Real2
WorldCenterRight : real2
var WorldCenterRight : Real2
WorldLeft : real
var WorldLeft : Real
WorldRectangle : rectangle
Returns our world rect. The origin of this Rect is bottom left.
var WorldRectangle : Rectangle
WorldRight : real
var WorldRight : Real
WorldTop : real
var WorldTop : Real
WorldTopCenter : real2
var WorldTopCenter : Real2
WorldTopLeft : real2
var WorldTopLeft : Real2
WorldTopRight : real2
var WorldTopRight : Real2
WorldTranslation : real2
Translation in world space.
var WorldTranslation : Real2
Methods
CastPoint : uiwidget
Finds the Widget at the given point. All Widgets bellow and including the 'ignore' widget will not be included. The ignore was added for trying to find the widget underneath a dragging window. The window is directly under the mouse, so we want to ignore it. |Name|Type|Description| |---|---|---| |worldPoint|real2| | |ignore|uiwidget| | |interactiveOnly|boolean| |
function CastPoint(worldPoint : Real2, ignore : UiWidget, interactiveOnly : Boolean) : UiWidget
CastRect : uiwidgetcastresultsrange
Name Type Description worldRect rectangle ignore uiwidget interactiveOnly boolean function CastRect(worldRect : Rectangle, ignore : UiWidget, interactiveOnly : Boolean) : UiWidgetCastResultsRange
LoseFocus : Void
Gives focus back to the root widget. |Name|Type|Description| |---|---|---|
function LoseFocus()
MarkAsNeedsUpdate : Void
Lets the Widget system know that this object has been modified and needs to be re-laid out. |Name|Type|Description| |---|---|---|
function MarkAsNeedsUpdate()
SetLocalLocation : Void
Name Type Description location Location localTranslation real2 function SetLocalLocation(location : Location, localTranslation : Real2)
SetWorldLocation : Void
Name Type Description location Location worldTranslation real2 function SetWorldLocation(location : Location, worldTranslation : Real2)
SizeToContents : Void
Name Type Description function SizeToContents()
TabJump : boolean
Changes focus to the next applicable widget in the direction based on the key pressed in the given keyboard event. |Name|Type|Description| |---|---|---| |e|keyboardevent| |
function TabJump(e : KeyboardEvent) : Boolean
TabJumpDirection : Void
Changes focus to the next applicable widget in the given direction. |Name|Type|Description| |---|---|---| |direction|UiFocusDirection| |
function TabJumpDirection(direction : UiFocusDirection)
TakeFocus : Void
Focus control. |Name|Type|Description| |---|---|---|
function TakeFocus()
TransformPoint : real2
Transforms a local point into world space. |Name|Type|Description| |---|---|---| |localPosition|real2| |
function TransformPoint(localPosition : Real2) : Real2
TransformPointInverse : real2
Transforms a world point into this Widget's local space. Note, this is not the same space as LocalTranslation. LocalTranslation is in this Widget's parent space. |Name|Type|Description| |---|---|---| |worldPosition|real2| |
function TransformPointInverse(worldPosition : Real2) : Real2
UiWidget : Void
constructor
Name Type Description function UiWidget()
Update : Void
Handles the updating of this Widget and the child Widgets. Once called, it will update the internal TransformUpdateState. |Name|Type|Description| |---|---|---| |e|uitransformupdateevent| |
function Update(e : UiTransformUpdateEvent)