engine.gui Functions

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Methods:

Name	Description View: Sort by:
getNumChildren	Returns the current number of widgets in the GUI.
setMouseGrab	Setter and Getter for value indicating if the mouse pointer is bound to the GUI.
getMouseGrab
setMouseCursor	Setter and Getter for mouse cursor value, one of the CURSOR_* pre-defined variables.
getMouseCursor
setMouseSprite	Setter and Getter for custom mouse pointer currently in use.
getMouseSprite
setMouseEnabled	Setter and Getter for value indicating if the mouse cursor is rendered.
isMouseEnabled
setToolTipTime	Setter and Getter for delay before tooltip appearing.
getToolTipTime	Setter and Getter for delay before tooltip appearing.
setToolTipAlpha	Setter and Getter for alpha value of a tooltip.
getToolTipAlpha	Setter and Getter for alpha value of a tooltip.
setToolTipColor	Setter and Getter for font color of a tooltip.
getToolTipColor	Setter and Getter for font color of a tooltip.
setToolTipWidth	Setter and Getter for width of the tooltip.
getToolTipWidth	Setter and Getter for width of the tooltip.
setToolTipSize	Setter and Getter for font size of a tooltip.
getToolTipSize	Setter and Getter for font size of a tooltip.
setToolTipEnabled	Setter and Getter for value indicating if tooltips are available.
isToolTipEnabled
setTransparentAlpha	Setter and Getter for alpha value of a transparent widget.
getTransparentAlpha	Setter and Getter for alpha value of a transparent widget.
setTransparentColor	Setter and Getter for font color of a transparent widget.
getTransparentColor	Setter and Getter for font color of a transparent widget.
setTransparentEnabled	Setter and Getter for value indicating if a widget can be rendered as transparent (i.e. change its color accordingly), when necessary. For example, it can indicate whether the drop-down list of combobox is transparent or not.
isTransparentEnabled
setDisabledAlpha	Setter and Getter for alpha value of a disabled widget.
getDisabledAlpha	Setter and Getter for alpha value of a disabled widget.
setDisabledColor	Setter and Getter for font color of a disabled widget.
getDisabledColor	Setter and Getter for font color of a disabled widget.
setDisabledEnabled	Setter and Getter for value indicating if a widget can be rendered as disabled (i.e. change its color accordingly), when necessary.
isDisabledEnabled
setFocusedAlpha	Setter and Getter for alpha value of a focused widget.
getFocusedAlpha	Setter and Getter for alpha value of a focused widget.
setFocusedColor	Setter and Getter for font color of a focused widget.
getFocusedColor	Setter and Getter for font color of a focused widget.
setFocusedPermanent	Setter and Getter for value indicating if the permanent color of the focused widget is changed.
isFocusedPermanent
setFocusedEnabled	Setter and Getter for value indicating if a widget can be rendered as focused on (i.e. change its color accordingly), when necessary.
isFocusedEnabled
setDefaultAlpha	Setter and Getter for standard alpha value of a widget.
getDefaultAlpha	Setter and Getter for standard alpha value of a widget.
setDefaultColor	Setter and Getter for standard font color of a widget.
getDefaultColor	Setter and Getter for standard font color of a widget.
setDefaultSize	Setter and Getter for standard font size of a widget.
getDefaultSize	Setter and Getter for standard font size of a widget.
setFadeOutSpeed	Setter and Getter for duration of fade-out animation played when a widget loses focus.
getFadeOutSpeed
setFadeInSpeed	Setter and Getter for duration of fade-in animation played when a widget gets focused.
getFadeInSpeed
setExposeSpeed	Setter and Getter for duration of animation played when a widget appears.
getExposeSpeed
setTransform	Setter and Getter for global GUI transformation matrix.
getTransform	Setter and Getter for global GUI transformation matrix.
setColor	Setter and Getter for color of the global color multiplier.
getColor	Setter and Getter for color of the global color multiplier.
getHeight	Returns the current screen height.
getWidth	Returns the current screen width.
setHidden	Setter and Getter for value indicating if a widget is rendered visible.
isHidden
setEnabled	Setter and Getter for value indicating if the GUI is enabled.
isEnabled
isActive	Returns the current value indicating if any widget in the GUI is in focus.
getVBox	Returns the current root widget of the GUI.
getPermanentFocus	Returns the current widget that is always in focus.
getOverlappedFocus	Returns the current widget placed under the currently focused widget.
getFocus	Returns the current widget that is currently in focus.
getMouseDY	Returns the current difference between the previous position of the mouse pointer and the current one along the Y axis.
getMouseDX	Returns the current difference between the previous position of the mouse pointer and the current one along the X axis.
getMouseY	Returns the current Y coordinate of the mouse pointer in the coordinate system of the application window.
getMouseX	Returns the current X coordinate of the mouse pointer in the coordinate system of the application window.
setToolTipY	Setter and Getter for tooltip position along the Y axis.
getToolTipY	Setter and Getter for tooltip position along the Y axis.
setToolTipX	Setter and Getter for tooltip position along the X axis.
getToolTipX	Setter and Getter for tooltip position along the X axis.
setToolTipText	Setter and Getter for GUI tooltip text.
getToolTipText	Setter and Getter for GUI tooltip text.
isUnderCursor	Returns the current value indicating if the GUI object is under cursor.
getMouseWheelHorizontal	Returns the current horizontal mouse scroll value.
getMouseWheel	Returns the current mouse scroll value.
setMouseShow	Setter and Getter for value indicating if the OS mouse pointer is displayed, or if the application cursor is used only.
isMouseShow
setMouseButtons	Setter and Getter for mouse buttons the input of which is received.
getMouseButtons
setWorldObject	Setter and Getter for value indicating if the GUI object is available in the hierarchy and rendered as a world object, or if it should have the window handle.
isWorldObject
setWinHandle	Setter and Getter for engine handle of the window.
getWinHandle	Setter and Getter for engine handle of the window.
setPosition	Setter and Getter for GUI object position (top left corner) in screen coordinates.
getPosition
setSize	Setter and Getter for GUI object size.
getSize	Setter and Getter for GUI object size.
setDpiScale	Setter and Getter for DPI scale applied to the GUI.
getDpiScale	Setter and Getter for DPI scale applied to the GUI.
getEventUpdate	The event triggered when GUI is updated.
getCurrent	Returns the current GUI instance.
getChild	Returns a child widget with a given number.
isChild	Checks if a given widget belongs to the GUI.
getKeyActivity	Checks if a given key already has a special purpose for the widget in focus.
setResource	Changes the resource file skin used for widgets in the current GUI.
setToolTip	Sets a tooltip to be displayed.
getToolTipHeight	Returns a height of the given tooltip.
getToolTipWidth	Returns the current width of the tooltip.
addChild	Adds a given widget to the GUI.
addDictionary	Adds a dictionary with required localization.
clearDictionaries	Unloads all loaded dictionaries.
clearTexture	Clears the specified GUI texture file cache.
create	GUI constructor.
hasTranslation	Returns a value indicating if there is translation for a given string in the localization dictionary.
parseColor	Converts a color string in the Web format (RRGGBB / #RRGGBB or RRGGBBAA / #RRGGBBAA) into its vec4 equivalent.
removeChild	Removes the specified widget from the GUI.
removeFocus	Removes the current focus.
replaceChild	Replaces a given widget in the GUI with another widget.
saveDictionary	Saves the dictionary with required localization.
translate	Returns the source string translated using the dictionary.
render	Renders the GUI.
isRenderingBootScreen	Returns a value indicating if the GUI currently renders the boot screen.
isRenderingSplashScreen	Returns a value indicating if the GUI currently renders the splash screen.
isRenderingLoadingScreen	Returns a value indicating if the GUI currently renders the loading screen.
focusGained	The focus is set on the GUI object.
focusLost	The focus is removed from the GUI.
isHover	Returns a value indicating if the cursor is hovering over the GUI object.
getWidgetIntersection	Returns the intersected widget that is visually perceptible (not empty, not transparent).
getUnderCursorWidget	Returns the visually perceptible widget, over which the cursor is currently hovering.
getFocusGui	Returns the GUI object that is currently in focus.
getGuiIntersection	Returns the intersected GUI object.
getUnderCursorGui	Returns the GUI object that is currently under cursor.
getWorldGuiInstances	Returns all GUI instances that are available in the scene hierarchy and rendered as world objects.
getAndClearMouseWheel	Returns the mouse scroll value and clears the mouse scroll state info.
forceSetMouseWheel	Sets the mouse scroll value.
getAndClearMouseWheelHorizontal	Returns the mouse horizontal scroll value and clears the mouse scroll state info.
forceSetMouseWheelHorizontal	Sets the mouse vertical scroll value.
getKey	Returns the value indicating if the specified key is pressed.
getAndClearKey	Returns the value indicating if the specified key is pressed and clears the key state info.
toRenderSize	Transforms the unit value to the pixel value.
toUnitSize	Transforms the pixel value to the unit value.
setFontPath	Changes the regular font used for widgets in the current GUI.
getFontPath	Returns the path to the regular font currently used for widgets in the current GUI.
setFontPaths	Changes the set of fonts — regular, bold, italic, and italic bold — used for widgets in the current GUI.
setFontRichBoldPath	Changes the bold font used for widgets in the current GUI.
getFontRichBoldPath	Returns the path to the bold font currently used for widgets in the current GUI.
setFontRichItalicPath	Changes the italic font used for widgets in the current GUI.
getFontRichItalicPath	Returns the path to the italic font currently used for widgets in the current GUI.
setFontRichBoldItalicPath	Changes the bold italic font used for widgets in the current GUI.
getFontRichBoldItalicPath	Returns the path to the bold italic font currently used for widgets in the current GUI.
setSkinPath	Changes the skin used for widgets in the current GUI.
getSkinPath	Returns the path to the current GUI skin.

Variables:

Name	Description
GUI_ALIGN_CENTER = 1 << 0	Widget is centered relative to its container.
GUI_ALIGN_LEFT = 1 << 1	Widget is aligned to the left side of its container.
GUI_ALIGN_RIGHT = 1 << 2	Widget is aligned to the right side of its container.
GUI_ALIGN_TOP = 1 << 3	Widget is aligned to the top of its container.
GUI_ALIGN_BOTTOM = 1 << 4	Widget is aligned to the bottom of its container.
GUI_ALIGN_EXPAND = 1 << 5	Widget occupies all available space inside its container.
GUI_ALIGN_OVERLAP = 1 << 6	Widget is rendered over other widgets, on the foreground (or over the contents of the parent container). Overlapping widgets are sorted between each other (i.e. pop up when focused on). This flag also makes the window movable.
GUI_ALIGN_BACKGROUND = 1 << 7	Widget is always placed under other widgets. If clicked on, it does not pop up. Use this flag together with ALIGN_OVERLAP one.
GUI_ALIGN_FIXED = 1 << 8	Widget in focus stays on the background or on the foreground (depending on where it was created). This flag is valid only if GUI_ALIGN_OVERLAP is also set. Non-fixed overlapping windows can pop over the fixed ones, while the latter cannot do it.
GUI_ATTACH_LOG10 = 1 << 0	Attached slider uses a logarithmic scale with the base ten.
GUI_ATTACH_MIN_EXPAND = 1 << 1	Minimum value of the attached slider can be lowered.
GUI_ATTACH_MAX_EXPAND = 1 << 2	Maximum value of the attached slider can be raised.
GUI_BLEND_NONE = 0	No blending is used for a widget.
GUI_BLEND_ZERO = 1	Components of each widget color are multiplied by zero.
GUI_BLEND_ONE = 2	Components of each widget color are multiplied by one.
GUI_BLEND_SRC_COLOR = 3	Components of each widget color are multiplied by these factors (per component): (wR, wG, wB, wA) .
GUI_BLEND_ONE_MINUS_SRC_COLOR = 4	Components of each widget color are multiplied by these factors (per component): (1 - wR, 1 - wG, 1 - wB, 1 - wA) .
GUI_BLEND_SRC_ALPHA = 5	Components of each widget color are multiplied by wA.
GUI_BLEND_ONE_MINUS_SRC_ALPHA = 6	Components of each widget color are multiplied by 1- wA.
GUI_BLEND_DEST_COLOR = 7	Components of each widget color are multiplied by these factors (per component): (bR, bG, bB, bA) .
GUI_BLEND_ONE_MINUS_DEST_COLOR = 8	Components of each widget color are multiplied by these factors (per component): (1 - bR, 1 - bG, 1 - bB, 1 - bA) .
GUI_BLEND_DEST_ALPHA = 9	Components of each widget color are multiplied by bA.
GUI_BLEND_ONE_MINUS_DEST_ALPHA = 10	Components of each widget color are multiplied by 1- bA.
GUI_BUFFER_ALL = (BUFFER_RED \| BUFFER_GREEN \| BUFFER_BLUE \| BUFFER_ALPHA)	Mask that specifies all channels.
GUI_BUFFER_RED = 1 << 0	Mask that specifies the red channel.
GUI_BUFFER_GREEN = 1 << 1	Mask that specifies the green channel.
GUI_BUFFER_BLUE = 1 << 2	Mask that specifies the blue channel.
GUI_BUFFER_ALPHA = 1 << 3	Mask that specifies the alpha channel.
GUI_CURSOR_NONE = 0	Mouse pointer is not displayed.
GUI_CURSOR_ARROW = 1	Default arrow pointer is displayed.
GUI_CURSOR_NA = 2	Pointer indicating that an operation is not available is displayed.
GUI_CURSOR_DND = 3	Pointer for a drag-and-drop operation is displayed.
GUI_CURSOR_WIDTH = 4	Pointer for horizontal resizing is displayed.
GUI_CURSOR_HEIGHT = 5	Pointer for vertical resizing is displayed.
GUI_CURSOR_NESW = 6	Pointer for top-right / bottom-left resizing is displayed.
GUI_CURSOR_NWSE = 7	Pointer for top-left / bottom-right resizing is displayed.
GUI_CURSOR_MOVE = 8	Pointer for move operation is displayed.
GUI_CURSOR_ROTATE = 9	Pointer for rotation operation is displayed.
GUI_CURSOR_SCALE = 10	Pointer for operation of object scaling is displayed.
GUI_NUM_CURSORS = 11	Number of cursors.
GUI_VALIDATOR_ANY = 0	Input control accepts any data.
GUI_VALIDATOR_INT = 1	Input control accepts only integer data.
GUI_VALIDATOR_UINT = 2	Input control accepts only unsigned integer data.
GUI_VALIDATOR_FLOAT = 3	Input control accepts only floating point data.
GUI_VALIDATOR_ASCII = 4	Input control accepts only ASCII based symbols.
GUI_VERTICAL = 0	Widget has vertical orientation.
GUI_HORIZONTAL = 1	Widget has horizontal orientation.
GUI_MOUSE_MASK_LEFT = 1 << 0	The bit mask value of the left mouse button.
GUI_MOUSE_MASK_MIDDLE = 1 << 1	The bit mask value of the middle mouse button.
GUI_MOUSE_MASK_RIGHT = 1 << 2	The bit mask value of the right mouse button.
GUI_MOUSE_MASK_DCLICK = 1 << 3	The bit mask value of the double click.
GUI_MOUSE_BUTTON_MASK = MOUSE_MASK_LEFT \| MOUSE_MASK_MIDDLE \| MOUSE_MASK_RIGHT

Gui Class

Members

int getNumChildren() const#

Returns the current

Return value

Current

void setMouseGrab ( int grab ) #

Sets a new value indicating if the mouse pointer is bound to the GUI.

Arguments

int grab - The value indicating if the mouse pointer is bound to the GUI: 1 if the mouse pointer cannot leave the GUI; otherwise, 0.

int getMouseGrab() const#

Returns the current value indicating if the mouse pointer is bound to the GUI.

Return value

Current value indicating if the mouse pointer is bound to the GUI: 1 if the mouse pointer cannot leave the GUI; otherwise, 0.

void setMouseCursor ( int cursor ) #

Sets a new mouse cursor value, one of the CURSOR_* pre-defined variables.

Arguments

int cursor - The mouse cursor value, one of the CURSOR_* pre-defined variables.

int getMouseCursor() const#

Returns the current mouse cursor value, one of the CURSOR_* pre-defined variables.

Return value

Current mouse cursor value, one of the CURSOR_* pre-defined variables.

void setMouseSprite ( WidgetSprite sprite ) #

Sets a new custom mouse pointer currently in use.

Arguments

WidgetSprite sprite - The sprite with a custom mouse pointer, or NULL if the standard mouse pointer is used.

WidgetSprite getMouseSprite() const#

Returns the current custom mouse pointer currently in use.

Return value

Current sprite with a custom mouse pointer, or NULL if the standard mouse pointer is used.

void setMouseEnabled ( ) #

Sets a new value indicating if the mouse cursor is rendered.

Arguments

enabled - The rendering of the mouse cursor

isMouseEnabled() const#

Returns the current value indicating if the mouse cursor is rendered.

Return value

Current rendering of the mouse cursor

void setToolTipTime ( float time ) #

Sets a new delay before tooltip appearing.

Arguments

float time - The delay before tooltip appearing, in cycles per second.

float getToolTipTime() const#

Returns the current delay before tooltip appearing.

Return value

Current delay before tooltip appearing, in cycles per second.

void setToolTipAlpha ( float alpha ) #

Sets a new alpha value of a tooltip.

Arguments

float alpha - The alpha value of a tooltip.

float getToolTipAlpha() const#

Returns the current alpha value of a tooltip.

Return value

Current alpha value of a tooltip.

void setToolTipColor ( vec4 color ) #

Sets a new font color of a tooltip.

Arguments

vec4 color - The font color of a tooltip. The default is equivalent to #000000 (black).

vec4 getToolTipColor() const#

Returns the current font color of a tooltip.

Return value

Current font color of a tooltip. The default is equivalent to #000000 (black).

void setToolTipWidth ( int width ) #

Sets a new width of the tooltip.

Arguments

int width - The width of the tooltip.

int getToolTipWidth() const#

Returns the current width of the tooltip.

Return value

Current width of the tooltip.

void setToolTipSize ( int size ) #

Sets a new font size of a tooltip.

Arguments

int size - The font size of a tooltip.

int getToolTipSize() const#

Returns the current font size of a tooltip.

Return value

Current font size of a tooltip.

void setToolTipEnabled ( ) #

Sets a new value indicating if tooltips are available.

Arguments

enabled - The tooltips display

isToolTipEnabled() const#

Returns the current value indicating if tooltips are available.

Return value

Current tooltips display

void setTransparentAlpha ( ) #

Sets a new alpha value of a transparent widget. A widget is transparent, if it uses blending.

Arguments

alpha - The alpha value of a transparent widget. 0 means completely transparent.

getTransparentAlpha() const#

Returns the current alpha value of a transparent widget. A widget is transparent, if it uses blending.

Return value

Current alpha value of a transparent widget. 0 means completely transparent.

void setTransparentColor ( vec4 color ) #

Sets a new font color of a transparent widget. A widget is transparent, if it uses blending.

Arguments

vec4 color - The font color of a transparent widget. The default is equivalent to #869caa (light bluish).

vec4 getTransparentColor() const#

Returns the current font color of a transparent widget. A widget is transparent, if it uses blending.

Return value

Current font color of a transparent widget. The default is equivalent to #869caa (light bluish).

void setTransparentEnabled ( ) #

Sets a new value indicating if a widget can be rendered as transparent (i.e. change its color accordingly), when necessary. For example, it can indicate whether the drop-down list of combobox is transparent or not.

Arguments

enabled - The rendering of a widget as transparent

isTransparentEnabled() const#

Returns the current value indicating if a widget can be rendered as transparent (i.e. change its color accordingly), when necessary. For example, it can indicate whether the drop-down list of combobox is transparent or not.

Return value

Current rendering of a widget as transparent

void setDisabledAlpha ( float alpha ) #

Sets a new alpha value of a disabled widget.

Arguments

float alpha - The alpha value of a disabled widget. 0 means completely transparent.

float getDisabledAlpha() const#

Returns the current alpha value of a disabled widget.

Return value

Current alpha value of a disabled widget. 0 means completely transparent.

void setDisabledColor ( vec4 color ) #

Sets a new font color of a disabled widget.

Arguments

vec4 color - The font color of a disabled widget. The default is equivalent to #869caa (light bluish).

vec4 getDisabledColor() const#

Returns the current font color of a disabled widget.

Return value

Current font color of a disabled widget. The default is equivalent to #869caa (light bluish).

void setDisabledEnabled ( bool enabled ) #

Sets a new value indicating if a widget can be rendered as disabled (i.e. change its color accordingly), when necessary.

Arguments

bool enabled - Set true to enable rendering of a widget as disabled; false - to disable it.

bool isDisabledEnabled() const#

Returns the current value indicating if a widget can be rendered as disabled (i.e. change its color accordingly), when necessary.

Return value

true if rendering of a widget as disabled is enabled; otherwise false.

void setFocusedAlpha ( float alpha ) #

Sets a new alpha value of a focused widget.

Arguments

float alpha - The alpha value of a focused widget. 0 means completely transparent.

float getFocusedAlpha() const#

Returns the current alpha value of a focused widget.

Return value

Current alpha value of a focused widget. 0 means completely transparent.

void setFocusedColor ( vec4 color ) #

Sets a new font color of a focused widget.

Arguments

vec4 color - The font color of a focused widget. The default is equivalent to #ffffff (white).

vec4 getFocusedColor() const#

Returns the current font color of a focused widget.

Return value

Current font color of a focused widget. The default is equivalent to #ffffff (white).

void setFocusedEnabled ( bool enabled ) #

Sets a new value indicating if a widget can be rendered as focused on (i.e. change its color accordingly), when necessary.

Arguments

bool enabled - Set true to enable rendering of a widget as focused on; false - to disable it.

bool isFocusedEnabled() const#

Returns the current value indicating if a widget can be rendered as focused on (i.e. change its color accordingly), when necessary.

Return value

true if rendering of a widget as focused on is enabled; otherwise false.

void setDefaultAlpha ( float alpha ) #

Sets a new standard alpha value of a widget.

Arguments

float alpha - The standard alpha value of a widget. 0 means completely transparent.

float getDefaultAlpha() const#

Returns the current standard alpha value of a widget.

Return value

Current standard alpha value of a widget. 0 means completely transparent.

void setDefaultColor ( vec4 color ) #

Sets a new standard font color of a widget.

Arguments

vec4 color - The standard font color of a widget. The default is equivalent to #ddddff (blue-white).

vec4 getDefaultColor() const#

Returns the current standard font color of a widget.

Return value

Current standard font color of a widget. The default is equivalent to #ddddff (blue-white).

void setDefaultSize ( int size ) #

Sets a new standard font size of a widget.

Arguments

int size - The standard font size of a widget.

int getDefaultSize() const#

Returns the current standard font size of a widget.

Return value

Current standard font size of a widget.

void setFadeOutSpeed ( float speed ) #

Sets a new duration of fade-out animation played when a widget loses focus.

Arguments

float speed - The duration in cycles per second, for example, 4 means that the duration is a 1/4 of a second.

float getFadeOutSpeed() const#

Returns the current duration of fade-out animation played when a widget loses focus.

Return value

Current duration in cycles per second, for example, 4 means that the duration is a 1/4 of a second.

void setFadeInSpeed ( float speed ) #

Sets a new duration of fade-in animation played when a widget gets focused.

Arguments

float speed - The duration in cycles per second, for example, 8 means that the duration is a 1/8 of a second.

float getFadeInSpeed() const#

Returns the current duration of fade-in animation played when a widget gets focused.

Return value

Current duration in cycles per second, for example, 8 means that the duration is a 1/8 of a second.

void setExposeSpeed ( float speed ) #

Sets a new duration of animation played when a widget appears.

Arguments

float speed - The duration in cycles per second, for example, 6 means that the duration is a 1/6 of a second.

float getExposeSpeed() const#

Returns the current duration of animation played when a widget appears.

Return value

Current duration in cycles per second, for example, 6 means that the duration is a 1/6 of a second.

void setTransform ( mat4 transform ) #

Sets a new global GUI transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.

Arguments

mat4 transform - The global GUI transformation matrix.

mat4 getTransform() const#

Returns the current global GUI transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.

Return value

Current global GUI transformation matrix.

void setColor ( vec4 color ) #

Sets a new color of the global color multiplier.

Arguments

vec4 color - The color of the global color multiplier. The default is equivalent to #ffffff (white).

vec4 getColor() const#

Returns the current color of the global color multiplier.

Return value

Current color of the global color multiplier. The default is equivalent to #ffffff (white).

int getHeight() const#

Returns the current screen height.

Return value

Current screen height, in pixels.

int getWidth() const#

Returns the current screen width.

Return value

Current screen width, in pixels.

void setHidden ( bool hidden ) #

Sets a new value indicating if a widget is rendered visible.

Arguments

bool hidden - Set true to enable the widget rendering as visible; false - to disable it.

bool isHidden() const#

Returns the current value indicating if a widget is rendered visible.

Return value

true if the widget rendering as visible is enabled; otherwise false.

void setEnabled ( bool enabled ) #

Sets a new

Arguments

bool enabled - Set true to enable the GUI; false - to disable it.

bool isEnabled() const#

Returns the current

Return value

true if the GUI is enabled; otherwise false.

bool isActive() const#

Returns the current value indicating if any widget in the GUI is in focus.

Return value

true if any widget in the GUI is in focus; otherwise false.

WidgetVBox getVBox() const#

Returns the current root widget of the GUI.

Return value

Current root widget of the GUI.

Widget getPermanentFocus() const#

Returns the current widget that is always in focus.

Return value

Current widget that is always in focus.

Widget getOverlappedFocus() const#

Returns the current

Return value

Current overlapped widget.

Widget getFocus() const#

Returns the current widget that is currently in focus.

Return value

Current widget that is currently in focus.

int getMouseDY() const#

Returns the current difference between the previous position of the mouse pointer and the current one along the Y axis.

Return value

Current difference between the previous position of the mouse pointer and the current one along the Y axis.

int getMouseDX() const#

Returns the current difference between the previous position of the mouse pointer and the current one along the X axis.

Return value

Current difference between the previous position of the mouse pointer and the current one along the X axis.

int getMouseY() const#

Returns the current Y coordinate of the mouse pointer in the coordinate system of the application window.

Return value

Current Y coordinate of the mouse pointer in the coordinate system of the application window.

int getMouseX() const#

Returns the current X coordinate of the mouse pointer in the coordinate system of the application window.

Return value

Current X coordinate of the mouse pointer in the coordinate system of the application window.

void setToolTipY ( int y ) #

Sets a new

Arguments

int y - The tooltip position along the Y axis.

int getToolTipY() const#

Returns the current

Return value

Current tooltip position along the Y axis.

void setToolTipX ( int x ) #

Sets a new

Arguments

int x - The tooltip position along the X axis.

int getToolTipX() const#

Returns the current

Return value

Current tooltip position along the X axis.

void setToolTipText ( string text ) #

Sets a new GUI tooltip text.

Arguments

string text - The GUI tooltip text.

string getToolTipText() const#

Returns the current GUI tooltip text.

Return value

Current GUI tooltip text.

bool isUnderCursor() const#

Returns the current value indicating if the GUI object is under cursor.

Return value

true if the GUI object is under cursor; otherwise false.

int getMouseWheelHorizontal() const#

Returns the current horizontal mouse scroll value.

Return value

Current horizontal mouse scroll value in the [-1;1] range.

int getMouseWheel() const#

Returns the current mouse scroll value. Negative values correspond to scrolling downwards; positive values correspond to scrolling upwards; the value is zero when the mouse wheel is not scrolled.

Return value

Current mouse scroll value in the [-1;1] range.

void setMouseShow ( bool show ) #

Sets a new value indicating if the OS mouse pointer is displayed, or if the application cursor is used only.

Arguments

bool show - Set true to enable displaying of OS mouse pointer; false - to disable it.

bool isMouseShow() const#

Returns the current value indicating if the OS mouse pointer is displayed, or if the application cursor is used only.

Return value

true if displaying of OS mouse pointer is enabled; otherwise false.

void setMouseButtons ( int buttons ) #

Sets a new mouse buttons the input of which is received.

Arguments

int buttons - The

int getMouseButtons() const#

Returns the current mouse buttons the input of which is received.

Return value

Current

void setWorldObject ( bool object ) #

Sets a new value indicating if the GUI object is available in the hierarchy and rendered as a world object, or if it should have the window handle.

Arguments

bool object - Set true to enable the GUI object is available in the hierarchy and rendered as a world object; false - to disable it.

bool isWorldObject() const#

Returns the current value indicating if the GUI object is available in the hierarchy and rendered as a world object, or if it should have the window handle.

Return value

true if the GUI object is available in the hierarchy and rendered as a world object; otherwise false.

void setWinHandle ( ) #

Sets a new engine handle of the window.

Arguments

handle - The window handle.

getWinHandle() const#

Returns the current engine handle of the window.

Return value

Current window handle.

void setPosition ( ) #

Sets a new GUI object position (top left corner) in screen coordinates.

Arguments

position - The GUI object position (top left corner) in screen coordinates.

getPosition() const#

Returns the current GUI object position (top left corner) in screen coordinates.

Return value

Current GUI object position (top left corner) in screen coordinates.

void setSize ( ) #

Sets a new GUI object size.

Arguments

size - The GUI object size (width and height).

getSize() const#

Returns the current GUI object size.

Return value

Current GUI object size (width and height).

void setDpiScale ( float scale ) #

Sets a new DPI scale applied to the GUI.

Arguments

float scale - The DPI scale applied to the GUI.

float getDpiScale() const#

Returns the current DPI scale applied to the GUI.

Return value

Current DPI scale applied to the GUI.

getEventUpdate() const#

The event handler signature is as follows: myhandler()

Usage Example

Source code

Return value

Event reference.

engine.gui.getCurrent ( ) #

Returns the current GUI instance.

Return value

Current GUI instance.

Widget engine.gui.getChild ( int num ) #

Returns a child widget with a given number.

Arguments

int num - Widget number.

Return value

Required widget.

int engine.gui.isChild ( Widget widget ) #

Checks if a given widget belongs to the GUI.

Arguments

Widget widget - Widget to check.

Return value

1 if the widget belongs to the GUI; otherwise, 0.

void engine.gui.setFocusedPermanent ( int permanent ) #

Changes the permanent color of the focused widget.

Arguments

int permanent - 1 - a font color is overridden with the global GUI focused color; 0 - a font color is unchanged.

int engine.gui.isFocusedPermanent ( ) #

Returns a value indicating if the permanent color of the focused widget is changed.

Return value

1 if the font color is overridden with the global GUI focused color; 0 if the font color is unchanged.

int engine.gui.getKeyActivity ( unsigned int key ) #

Checks if a given key already has a special purpose for the widget in focus.

Arguments

unsigned int key - One of the standard ASCII control codes or one of the KEY_* pre-defined variables.

Return value

1 if the key cannot be used; otherwise, 0.

int engine.gui.setResource ( string name ) #

Changes the resource file skin used for widgets in the current GUI.

Arguments

string name - Path to the *.rc file.

Return value

1 if the resource file is successfully changed; otherwise, 0.

void engine.gui.setToolTip ( int x, int y, string str ) #

Sets a tooltip to be displayed. The tooltip is positioned on the screen by its upper left corner. For the tooltip to be displayed, this function should be called each frame.

Arguments

int x - Screen position along the X axis.
int y - Screen position along the Y axis.
string str - Tooltip to display.

int engine.gui.getToolTipHeight ( string str ) #

Returns a height of the given tooltip.

Notice

Height of a single-line tooltip is equal to 21 pixels.

Arguments

string str - A tooltip text.

Return value

Height of the given tooltip (in pixels).

int engine.gui.getToolTipWidth ( string str ) #

Returns the current width of the tooltip.

Arguments

string str - A tooltip text.

Return value

Width of the tooltip.

void engine.gui.addChild ( Widget widget, int flags = 0 ) #

Adds a given widget to the GUI.

Arguments

Widget widget - Widget to add.
int flags - One of the GUI_ALIGN_* pre-defined variables. This is an optional parameter.

int engine.gui.addDictionary ( string name, string language = 0 ) #

Adds a dictionary with required localization. Dictionaries cannot be changed in real-time.

Arguments

string name - Path to the dictionary file.
string language - Name of the dictionary language.

Return value

1 if the dictionary is added successfully; otherwise, 0.

void engine.gui.clearDictionaries ( ) #

Unloads all loaded dictionaries.

int engine.gui.clearTexture ( string name ) #

Clears the specified GUI texture file cache.

Arguments

string name - Name of the texture.

Return value

1 if the texture is successfully cleared; otherwise, 0.

Gui engine.gui.create ( string name = 0 ) #

GUI constructor.

Arguments

string name - GUI skin name.

Return value

Pointer to the created GUI.

int engine.gui.hasTranslation ( string arg1 ) #

Returns a value indicating if there is translation for a given string in the localization dictionary.

Arguments

string arg1 - String to check.

Return value

1 if there is translation for the given string; otherwise, 0.

vec4 engine.gui.parseColor ( string str ) #

Converts a color string in the Web format (RRGGBB / #RRGGBB or RRGGBBAA / #RRGGBBAA) into its vec4 equivalent.

Arguments

string str - Color string in the Web format.

Return value

Color value as a vec4 vector (R, G, B, A).

void engine.gui.removeChild ( Widget widget ) #

Removes the specified widget from the GUI.

Arguments

Widget widget - Child widget to be removed.

void engine.gui.removeFocus ( ) #

Removes the current focus.

void engine.gui.replaceChild ( Widget widget, Widget old_widget, int flags = 0 ) #

Replaces a given widget in the GUI with another widget.

Arguments

Widget widget - Replacement widget.
Widget old_widget - Widget to be replaced.
int flags - One of the GUI_ALIGN_* pre-defined variables. This is an optional parameter.

int engine.gui.saveDictionary ( string name, string language = 0 ) #

Saves the dictionary with required localization. This function can be used to save the currently loaded dictionary into another file.

Arguments

string name - Path to a dictionary file.
string language - Name of the dictionary language.

Return value

1 if the dictionary is saved successfully; otherwise, 0.

string engine.gui.translate ( string str ) #

Returns the source string translated using the dictionary.

Arguments

string str - String to translate (source).

Return value

Target (translated) string if it is found in the localization dictionary; otherwise, the source string.

void engine.gui.render ( ) #

Renders the GUI.

void engine.gui.render ( int custom_mouse_buttons ) #

Renders the GUI.

Arguments

int custom_mouse_buttons - Pressed mouse button.

int engine.gui.isRenderingBootScreen ( ) #

Returns a value indicating if the GUI currently renders the boot screen.

Return value

1 if the GUI currently renders the boot screen; otherwise, 0.

int engine.gui.isRenderingSplashScreen ( ) #

Returns a value indicating if the GUI currently renders the splash screen.

Return value

1 if the GUI currently renders the splash screen; otherwise, 0.

int engine.gui.isRenderingLoadingScreen ( ) #

Returns a value indicating if the GUI currently renders the loading screen.

Return value

1 if the GUI currently renders the loading screen; otherwise, 0.

void engine.gui.focusGained ( ) #

The focus is set on the GUI object.

void engine.gui.focusLost ( ) #

The focus is removed from the GUI.

int engine.gui.isHover ( int global_pos_x, int global_pos_y ) #

Returns a value indicating if the cursor is hovering over the GUI object.

Arguments

int global_pos_x - The X coordinate of the cursor in global coordinates.
int global_pos_y - The Y coordinate of the cursor in global coordinates.

Return value

1 if the cursor is hovering over the GUI object; otherwise, 0.

Widget engine.gui.getWidgetIntersection ( int global_pos_x, int global_pos_y ) #

Returns the intersected widget that is visually perceptible (not empty, not transparent).

Arguments

int global_pos_x - The X coordinate of the cursor in global coordinates.
int global_pos_y - The Y coordinate of the cursor in global coordinates.

Return value

The intersected widget that is visually perceptible.

Widget engine.gui.getUnderCursorWidget ( ) #

Returns the visually perceptible widget, over which the cursor is currently hovering.

Return value

The widget, over which the cursor is currently hovering.

Gui engine.gui.getFocusGui ( ) #

Returns the GUI object that is currently in focus.

Return value

The GUI object currently in focus.

Gui engine.gui.getGuiIntersection ( int global_pos_x, int global_pos_y ) #

Returns the intersected GUI object.

NoticeThis method takes Z-ordering into consideration: if the GUI object is overlapped by any other window, the method returns null.

Arguments

int global_pos_x - The X coordinate of the intersection point in global coordinates.
int global_pos_y - The Y coordinate of the intersection point in global coordinates.

Return value

The intersected GUI object.

Gui engine.gui.getUnderCursorGui ( ) #

Returns the GUI object that is currently under cursor.

Notice

If case of dragging or resizing a window, this method returns null. To receive the intersected GUI in such a case, use getGuiIntersection().

Return value

GUI object currently under cursor.

void engine.gui.getWorldGuiInstances ( Vector<Gui>& OUT_ret_instances ) #

Returns all GUI instances that are available in the scene hierarchy and rendered as world objects.

Arguments

Vector<Gui>& OUT_ret_instances - All GUI instances that are available in the scene hierarchy and rendered as world objects.
Notice
This output buffer is to be filled by the Engine as a result of executing the method.

int engine.gui.getAndClearMouseWheel ( ) #

Returns the mouse scroll value and clears the mouse scroll state info.

Return value

The mouse scroll value in the [-1;1] range.

void engine.gui.forceSetMouseWheel ( int value ) #

Sets the mouse scroll value.

Arguments

int value - The mouse scroll value in the [-1;1] range.

int engine.gui.getAndClearMouseWheelHorizontal ( ) #

Returns the mouse horizontal scroll value and clears the mouse scroll state info.

Return value

The horizontal mouse scroll value in the [-1;1] range.

void engine.gui.forceSetMouseWheelHorizontal ( int value ) #

Sets the mouse vertical scroll value.

Arguments

int value - The horizontal mouse scroll value in the [-1;1] range.

int engine.gui.getKey ( int key ) #

Returns the value indicating if the specified key is pressed.

Arguments

int key - One of the standard ASCII control codes or one of the KEY_* pre-defined variables.

Return value

1 if the key is pressed; otherwise, 0.

int engine.gui.getAndClearKey ( int key ) #

Returns the value indicating if the specified key is pressed and clears the key state info.

Arguments

int key - One of the standard ASCII control codes or one of the KEY_* pre-defined variables.

Return value

1 if the key is pressed; otherwise, 0.

int engine.gui.toRenderSize ( int unit_size ) #

Transforms the unit value to the pixel value.

Arguments

int unit_size - Size in units.

Return value

Size in pixels.

int engine.gui.toUnitSize ( int render_size ) #

Transforms the pixel value to the unit value.

Arguments

int render_size - Size in pixels.

Return value

Size in units.

int engine.gui.setFontPath ( string path ) #

Changes the regular font used for widgets in the current GUI.

Arguments

string path - Path to the font file.

Return value

1 if the font is set successfully, otherwise 0.

string engine.gui.getFontPath ( ) #

Returns the path to the regular font currently used for widgets in the current GUI.

Return value

Path to the font file.

int engine.gui.setFontPaths ( string normal_path, string bold_path, string italic_path, string bold_italic_path ) #

Changes the set of fonts — regular, bold, italic, and italic bold — used for widgets in the current GUI.

Arguments

string normal_path - Path to the regular font file.
string bold_path - Path to the bold font file.
string italic_path - Path to the italic font file.
string bold_italic_path - Path to the bold italic font file.

Return value

1 if the fonts are set successfully, otherwise 0.

int engine.gui.setFontRichBoldPath ( string path ) #

Changes the bold font used for widgets in the current GUI.

Arguments

string path - Path to the bold font file.

Return value

1 if the fonts are set successfully, otherwise 0.

string engine.gui.getFontRichBoldPath ( ) #

Returns the path to the bold font currently used for widgets in the current GUI.

Return value

Path to the bold font file.

int engine.gui.setFontRichItalicPath ( string path ) #

Changes the italic font used for widgets in the current GUI.

Arguments

string path - Path to the italic font file.

Return value

1 if the font is set successfully, otherwise 0.

string engine.gui.getFontRichItalicPath ( ) #

Returns the path to the italic font currently used for widgets in the current GUI.

Return value

Path to the italic font file.

int engine.gui.setFontRichBoldItalicPath ( string path ) #

Changes the bold italic font used for widgets in the current GUI.

Arguments

string path - Path to the bold italic font file.

Return value

1 if the font is set successfully, otherwise 0.

string engine.gui.getFontRichBoldItalicPath ( ) #

Returns the path to the bold italic font currently used for widgets in the current GUI.

Return value

Path to the bold italic font file.

int engine.gui.setSkinPath ( string path ) #

Changes the skin used for widgets in the current GUI.

Arguments

string path - Path to the directory where the skin files (an RC file and textures) are stored.

Return value

1 if the skin is set successfully, otherwise 0.

string engine.gui.getSkinPath ( ) #

Returns the path to the current GUI skin.

Return value

Path to the directory where the skin files (an RC file and textures) are stored.

Last update: 2024-03-29

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

engine.gui Functions

In This Article:

Methods:

Variables:

Gui Class

Members

int getNumChildren() const#

Return value

void setMouseGrab ( int grab ) #

Arguments

int getMouseGrab() const#

Return value

void setMouseCursor ( int cursor ) #

Arguments

int getMouseCursor() const#

Return value

void setMouseSprite ( WidgetSprite sprite ) #

Arguments

WidgetSprite getMouseSprite() const#

Return value

void setMouseEnabled ( ) #

Arguments

isMouseEnabled() const#

Return value

void setToolTipTime ( float time ) #

Arguments

float getToolTipTime() const#

Return value

void setToolTipAlpha ( float alpha ) #

Arguments

float getToolTipAlpha() const#

Return value

void setToolTipColor ( vec4 color ) #

Arguments

vec4 getToolTipColor() const#

Return value

void setToolTipWidth ( int width ) #

Arguments

int getToolTipWidth() const#

Return value

void setToolTipSize ( int size ) #

Arguments

int getToolTipSize() const#

Return value

void setToolTipEnabled ( ) #

Arguments

isToolTipEnabled() const#

Return value

void setTransparentAlpha ( ) #

Arguments

getTransparentAlpha() const#

Return value

void setTransparentColor ( vec4 color ) #

Arguments

vec4 getTransparentColor() const#

Return value

void setTransparentEnabled ( ) #

Arguments

isTransparentEnabled() const#

Return value

void setDisabledAlpha ( float alpha ) #

Arguments

float getDisabledAlpha() const#

Return value

void setDisabledColor ( vec4 color ) #

Arguments

vec4 getDisabledColor() const#

Return value

void setDisabledEnabled ( bool enabled ) #

Arguments

bool isDisabledEnabled() const#

Return value

void setFocusedAlpha ( float alpha ) #

Arguments

float getFocusedAlpha() const#

Return value

void setFocusedColor ( vec4 color ) #

Arguments

vec4 getFocusedColor() const#

Return value