WidgetWindow Class
Warning
The 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.
| Inherits from: | Widget |
This class creates a titled window.
By default, the window created by means of this class consists of a single vertical column container and a drag area at the top.
The WidgetWindow class provides methods that allow editing the drag area. For example:
The window will be rendered as follows:
See Also#
- UnigineScript API sample <UnigineSDK>/data/samples/widgets/window_00
- C++ API sample <UnigineSDK>/source/samples/Api/Widgets/WidgetWindow
- C# API sample <UnigineSDK>/source/csharp/samples/Api/Widgets/WidgetWindow
WidgetWindow Class
Members
static WidgetWindow ( Gui gui, string str = 0, int x = 0, int y = 0 ) #
Constructor. Creates a window with given parameters and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the new window will belong.
- string str - Window title. This is an optional parameter.
- int x - Horizontal space between the widgets in the window and between them and the window border. This is an optional parameter.
- int y - Vertical space between the widgets in the window and between them and the window border. This is an optional parameter.
static WidgetWindow ( string str = 0, int x = 0, int y = 0 ) #
Constructor. Creates a window with given parameters and adds it to the Engine GUI.Arguments
- string str - Window title. This is an optional parameter.
- int x - Horizontal space between the widgets in the window and between them and the window border. This is an optional parameter.
- int y - Vertical space between the widgets in the window and between them and the window border. This is an optional parameter.
void setBlendable ( int blendable ) #
Sets a value indicating if the window can fade in and out when changing to the minimized state and back. By default, this option is disabled.Arguments
- int blendable - 1 to enable fading in and out, 0 to disable it.
int isBlendable ( ) #
Returns a value indicating if the window can fade in and out when changing to the minimized state and back.Return value
1 if the window can fade in and out; otherwise, 0.void setColor ( vec4 color ) #
Sets a color for the global color multiplier. The default is equivalent to #ffffff (white).Arguments
- vec4 color - Multiplier color.
vec4 getColor ( ) #
Returns a color of the global color multiplier.Return value
Multiplier color.void setFloatable ( int floatable ) #
Sets a value indicating if the window is animated when changing to the minimized state and back.Arguments
- int floatable - 1 to allow animating the window, 0 not to make it.
int isFloatable ( ) #
Returns a value indicating if the window is animated when changing to the minimized state and back. By default this option is disabled.Return value
1 if the window is animated; otherwise, 0.void setMaxHeight ( int height ) #
Sets the maximum height value for the window.Arguments
- int height - Maximum height value.
int getMaxHeight ( ) #
Returns the maximum height value of the window.Return value
Maximum height value.void setMaxWidth ( int width ) #
Sets the maximum width value for the window.Arguments
- int width - Maximum width value.
int getMaxWidth ( ) #
Returns the maximum width value of the window.Return value
Maximum width value.void setMoveable ( int moveable ) #
Sets a value indicating if the window is movable.Arguments
- int moveable - 1 to set the window as movable; otherwise, 0.
int isMoveable ( ) #
Returns a value indicating if the window is movable. By default this option is enabled.Return value
1 if the window is movable; otherwise, 0.void setPadding ( int l, int r, int t, int b ) #
Sets widget paddings for all sides. Padding clears an area around the content of a widget (inside of it).Arguments
- int l - Left-side padding in pixels.
- int r - Right-side padding in pixels.
- int t - Top padding in pixels.
- int b - Bottom padding in pixels.
int getPaddingBottom ( ) #
Returns the current bottom padding for the widget content.Return value
Bottom padding in pixels.int getPaddingLeft ( ) #
Returns the current left-side padding for the widget content.Return value
Left-side padding in pixels.int getPaddingRight ( ) #
Returns the current right-side padding for the widget content.Return value
Right-side padding in pixels.int getPaddingTop ( ) #
Returns the current top padding for the widget content.Return value
Top padding in pixels.void setSizeable ( int sizeable ) #
Sets a value indicating if the window is resizeable. Resizing is disabled by default.Arguments
- int sizeable - 1 to enable resizing the window, 0 to disable it.
int isSizeable ( ) #
Returns a value indicating if the window is resizeable.Return value
1 if the window is resizeable; otherwise, 0.void setSnapDistance ( int distance ) #
Sets a distance, at which the window snaps to another window or screen edge.Arguments
- int distance - Distance in pixels.
int getSnapDistance ( ) #
Returns the distance, at which the window snaps to another window or screen edge. The default is 0 (do not snap).Return value
Distance in pixels.void setSpace ( int x, int y ) #
Sets a space between the widgets in the window and between them and the window border.Arguments
- int x - Horizontal space. If a negative value is provided, 0 will be used instead.
- int y - Vertical space. If a negative value is provided, 0 will be used instead.
int getSpaceX ( ) #
Returns the horizontal space between the widgets in the window and between them and the window border.Return value
Horizontal space.int getSpaceY ( ) #
Returns the vertical space between the widgets in the window and between them and the window border.Return value
Vertical space.void setText ( string text ) #
Sets a window title.Arguments
- string text - Window title.
string getText ( ) #
Returns the current window title.Return value
Window title.void setTextAlign ( int align ) #
Sets alignment of the window title.Arguments
- int align - One of the GUI_ALIGN_* pre-defined variables.
int getTextAlign ( ) #
Returns the alignment of the window title.Return value
One of the GUI_ALIGN_* pre-defined variables.void setTitleable ( int titleable ) #
Sets a value indicating if the window is minimized when double-clicking on it. By default this option is disabled.Arguments
- int titleable - 1 to enable minimization, 0 to disable it.
int isTitleable ( ) #
Returns a value indicating if the window is minimized when double-clicking on it. By default this option is disabled.Return value
1 if the window is minimized when double-clicking on it; otherwise, 0.void setTransform ( mat4 transform ) #
Sets the global widget transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.Arguments
- mat4 transform - Transformation matrix.
mat4 getTransform ( ) #
Returns the global widget transformation matrix.Return value
Transformation matrix.void setBackgroundColor ( vec4 color ) #
Sets the background color to be used for the widget.Arguments
- vec4 color - The four-component vector specifying the color in the RGBA format.
vec4 getBackgroundColor ( ) #
Returns the current background color used for the widget.Return value
The four-component vector specifying the color in the RGBA format.void setBorderColor ( vec4 color ) #
Sets the border color for the widget.Arguments
- vec4 color - The four-component vector specifying the color in the RGBA format.
vec4 getBorderColor ( ) #
Returns the current border color for the widget.Return value
The four-component vector specifying the color in the RGBA format.void setDragAreaEnabled ( int enabled ) #
Sets a value indicating if the drag area of the window is enabled.Arguments
- int enabled - 1 to enable the drag area, 0 to disable it.
int isDragAreaEnabled ( ) #
Returns the value indicating if the drag area of the window is enabled.Return value
Value indicating if the drag area of the window is enabled: 1 if the drag area is enabled; otherwise, 0.void setDragAreaBackground ( int background ) #
Enables/disables rendering of the background for the drag area.Arguments
- int background - 1 to enable background rendering, 0 to disable it.
int getDragAreaBackground ( ) #
Returns the value indicating if background rendering is enabled or disabled for the drag area.Return value
Value indicating if rendering of the background is enabled: 1 if background rendering is enabled; otherwise, 0.void setDragAreaBackgroundColor ( vec4 color ) #
Sets a color for the background of the drag area.Arguments
- vec4 color - Background color.
vec4 getDragAreaBackgroundColor ( ) #
Returns the color of the drag area background.Return value
Background color.void setDragAreaPadding ( int l, int r, int t, int b ) #
Sets paddings for all sides of the drag area.Arguments
- int l - Left-side padding in pixels.
- int r - Right-side padding in pixels.
- int t - Top padding in pixels.
- int b - Bottom padding in pixels.
int getDragAreaPaddingLeft ( ) #
Returns the current left-side padding for the drag area.Return value
Left-side padding in pixels.int getDragAreaPaddingRight ( ) #
Returns the current right-side padding for the drag area.Return value
Right-side padding in pixels.int getDragAreaPaddingTop ( ) #
Returns the current top padding for the drag area.Return value
Top padding in pixels.int getDragAreaPaddingBottom ( ) #
Returns the current bottom padding for the drag area.Return value
Bottom padding in pixels.void setOutBoundsCallbacksEnabled ( int enabled ) #
Toggles callback processing for the window child widgets if the cursor is outside the window. By default, all callbacks are processed.Arguments
- int enabled - 1 to enable callback processing for the child widgets if the cursor is outside the window, otherwise 0.
int isOutBoundsCallbacksEnabled ( ) #
Returns the value specifying if the callback processing for the window child widgets is enabled when the cursor is outside the window.Return value
1 if callback processing for the child widgets is enabled, otherwise 0.void setGlobalMovement ( int movement ) #
Toggles moving the window using the mouse cursor across the whole GUI, i.e. not limited by the parent widget. By default, this option is set to false, and the window can be moved only relevant to its parent.Arguments
- int movement - 1 to enable moving the window across the whole GUI, 0 to limit the window movement by the parent widget.
int isGlobalMovement ( ) #
Returns the value specifying if the window can be moved across the whole GUI or only within the parent widget.Return value
1 if the window can be moved across the whole GUI, 0 if the window can be moved only within the parent widget.int getMinTextureWidth ( ) #
Returns the minimum width of the window render — the width of the window texture from the GUI skin.Return value
The minimum width of the window render, in pixels.int getMinTextureHeight ( ) #
Returns the minimum height of the window render — the height of the window texture from the GUI skin.Return value
The minimum height of the window render, in pixels.int getTextWidth ( ) #
Returns the window header width.Return value
The window header width, in pixels.int getTextHeight ( ) #
Returns the window header height.Return value
The window header height, in pixels.void setStencil ( int stencil ) #
Sets a value indicating if a widget cuts off its children along its bounds. Everything that lies outside of them, is not rendered. The default is 0.Arguments
- int stencil - 1 to enable cutting, 0 to disable it.
int getStencil ( ) #
Returns a value indicating if a widget cuts off its children along its set bounds. Everything that lies outside of them, is not rendered. This option works only if children have GUI_ALIGN_OVERLAP flag set (otherwise, they will expand the box widget bounds and no cutting will be done).Return value
1 if cutting is enabled; otherwise, 0.Last update:
2024-01-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)