This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.WidgetWindow Class

Inherits: Widget

This class creates a titled window.

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

Properties

string Text#

The current window title.
set
Sets a window title.
set value - Window title.

int TextAlign#

The alignment of the window title.
set
Sets alignment of the window title.
set value - One of the ALIGN_* pre-defined variables.

int PaddingBottom#

The current bottom padding for the widget content.

int PaddingTop#

The current top padding for the widget content.

int PaddingRight#

The current right-side padding for the widget content.

int PaddingLeft#

The current left-side padding for the widget content.

int SpaceY#

The vertical space between the widgets in the window and between them and the window border.

int SpaceX#

The horizontal space between the widgets in the window and between them and the window border.

int MaxHeight#

The maximum height value of the window.
set
Sets the maximum height value for the window.
set value - Maximum height value.

int MaxWidth#

The maximum width value of the window.
set
Sets the maximum width value for the window.
set value - Maximum width value.

mat4 Transform#

The global widget transformation matrix.
set
Sets the global widget transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.
set value - Transformation matrix.

vec4 Color#

A color of the global color multiplier.
set
Sets a color for the global color multiplier. The default is equivalent to vec4(1,1,1,1) (white).
set value - Multiplier color.

int SnapDistance#

The distance, at which the window snaps to another window or screen edge. the default is 0 (do not snap).
set
Sets a distance, at which the window snaps to another window or screen edge.
set value - Distance in pixels.

bool IsFloatable#

A value indicating if the window is animated when changing to the minimized state and back. the default is 0.
set
Sets a value indicating if the window is animated when changing to the minimized state and back.
set value - 1 to allow animating the window, 0 not to make it.

bool IsBlendable#

A value indicating if the window can fade in and out when changing to the minimized state and back. the default is 0.
set
Sets a value indicating if the window can fade in and out when changing to the minimized state and back.
set value - 1 to allow fading in and out, 0 to disallow it.

bool IsTitleable#

A value indicating if the window is minimized when double-clicking on it. the default is 0.
set
Sets a value indicating if the window is minimized when double-clicking on it. The default is 0.
set value - 1 to allow minimization, 0 to disallow it.

bool IsSizeable#

A value indicating if the window is resizeable. the default is 0.
set
Sets a value indicating if the window is resizeable.
set value - 1 to allow resizing the window, 0 to disallow it.

bool IsMoveable#

A value indicating if the window is movable. the default is 1.
set
Sets a value indicating if the window is movable.
set value - 1 to set the window as movable; otherwise, 0.

vec4 BorderColor#

Returns the current border color for the widget.
set
Sets the border color for the widget.
set value - Four-component vector specifying the color in the RGBA format.

vec4 BackgroundColor#

Returns the current background color used for the widget.
set
Sets the background color to be used for the widget.
set value - Four-component vector specifying the color in the RGBA format.

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 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.

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.
Last update: 2020-07-31
Build: ()