Unigine::WindowManager Class

Accessing Windows#

An application window can be accessed via the getWindow() function. There are also some functions (like getMainWindow()) that allow accessing the specific windows (a focused window, a fullscreen window and so on).

Source code (C++)

// get the main window
EngineWindowPtr main_window = WindowManager::getMainWindow();
// change its position and size
if (main_window)
{
	main_window->setPosition(Math::ivec2(1020, 60));
	main_window->setSize(Math::ivec2(305, 670));
}

Grouping Windows#

The engine windows created via the EngineWindow class can be grouped. There are three types of the window groups:

Vertical
Horizontal
Group of tabs

The number of windows in the group is unlimited.

The WindowManager class provides two main functions for grouping windows:

stack() creates a group of two windows.
stackGroups() creates a group of two window groups.

Source code (C++)

// create separate windows
EngineWindowPtr horizontal_1 = EngineWindowViewport::create("Horizontal 1", 512, 256);
EngineWindowPtr horizontal_2 = EngineWindowViewport::create("Horizontal 2", 512, 256);
EngineWindowPtr horizontal_3 = EngineWindowViewport::create("Horizontal 3", 512, 256);
EngineWindowPtr horizontal_4 = EngineWindowViewport::create("Horizontal 4", 512, 256);

// create 2 horizontal window groups 
EngineWindowGroupPtr horizontal_group_1 = WindowManager::stack(horizontal_1, horizontal_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
EngineWindowGroupPtr horizontal_group_2 = WindowManager::stack(horizontal_3, horizontal_4, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);

// create a vertical group of 2 horizontal groups
EngineWindowGroupPtr vertical_group = WindowManager::stackGroups(horizontal_group_1, horizontal_group_2, EngineWindowGroup::GROUP_TYPE_VERTICAL);

// specify position, size, title of the verical window group
vertical_group->setPosition(Math::ivec2(50, 60));
vertical_group->setSize(Math::ivec2(565, 310));
vertical_group->setTitle("Horizontal Group");

// render the window group
vertical_group->show();

Each window or window group has a state, so it changes after stacking.

There are also functions based on the stack() function that should be used in specific cases to avoid additional checking of arguments:

stackToParentGroup() stacks the second window to the parent group of the first window. In the result, both windows passed as arguments will be on the same level in the group hierarchy.
stackWindows() creates a group of the separate/nested windows. The windows are stacked in the default order.
stack() stacks the window to the other window. If the first argument is the separate window, a new window group is returned. If the first argument is the nested window, the window is added to its group.
stackToGroup() stacks the window or window group to another window group.

Follow the links to see the code examples.

For ungrouping, the unstack() function is used: it removes the window or the window group from the parent group.

Creating Dialog Windows#

To create a dialog window, use the corresponding functions of the class. For example:

Source code (C++)

// event handler function
int AppSystemLogic::onButtonClicked()
{
	// show the message dialog
	WindowManager::dialogMessage("Message", "Button has been clicked");

	return 1;

}

int AppSystemLogic::init()
{

	// create a window with widgets in the client area
	auto create_window = [](const char* name)
	{
		EngineWindowViewportPtr window = EngineWindowViewport::create(name, 512, 256);

		window->addChild(WidgetLabel::create(window->getSelfGui(), String::format("This is %s window.", name)), Gui::ALIGN_TOP);
		window->addChild(WidgetButton::create(window->getSelfGui(), name), Gui::ALIGN_CENTER);
		return window;

	};

	{
		// create a window
		EngineWindowViewportPtr window = create_window("Window");
		// get the child widget of the window
		WidgetPtr button = window->getChild(1);
		// add a callback for this widget
		button->addCallback(Gui::CLICKED, MakeCallback(this, &AppSystemLogic::onButtonClicked));
		// show the window
		window->setPosition(Math::ivec2(50, 60));
		window->show();

	}

	return 1;
}

Methods:

Name	Description View: Sort by:
getMainWindow	Returns the window viewport that is set as the main window by default.
getNumWindows	Returns the number of windows.
isMultipleWindowsSupported	Returns the value indicating if the engine can create more than one window.
isFullscreenMode	Returns the value indicating if at least one engine window is in a fullscreen state.
getFullscreenWindow	Returns the first engine window viewport that is in the fullscreen state.
getUnderCursorWindow	Returns the window which is currently under cursor.
getWindow	Returns the window by its index.
getWindowIndex	Returns the index of the specified window.
stack	Stacks the window to the other window.
stackToParentGroup	Stacks the second window to the parent window group of the first window.
stackWindows	Returns a newly created group of the separate and/or nested windows.
stackWithWindow	Returns a newly created group of the engine window viewport and any other engine window — another viewport or a window group.
stackGroups	Returns the group of window groups.
stackToGroup	Stacks the window or window group to another window group.
unstack	Removes a window or a group from a parent group.
isFullscreenWindow	Returns the value indicating if the specified window is in a fullscreen state.
getWindowByID	Returns the window by its ID.
dialogMessage	Displays a message dialog with the specified title and text.
dialogWarning	Displays a warning dialog with the specified title and text.
dialogError	Displays an error dialog with the specified title and text.
showSystemDialog	Displays a custom system dialog with an arbitrary set of buttons.
dialogOpenFolder	Opens a common dialog enabling the user to specify a folder to open.
dialogOpenFiles	Opens a common dialog enabling the user to specify a list of filenames to open multiple files.
dialogOpenFile	Opens a common dialog enabling the user to specify a filename to open a file.
dialogSaveFile	Opens a common dialog enabling the user to specify a filename to save a file as.
getFocusedWindow	Returns the window viewport which is currently in focus.
getSystemFocusedWindow	Returns the engine window viewport that has the isSystemFocused() flag enabled, either a window itself or its parent group with the system focus is enabled.
getIntersection	Returns the window the intersection with which is detected.
forceUpdateWindowOrders	Updates the Z order of all windows.
setEventsFilter	Sets a callback function to be executed on receiving input events.
getDpiAwareness	Returns the DPI awareness mode, the value indicating how the application processes the DPI scaling.
getCurrentDpiAwareness	Returns the current actual DPI awareness mode, the value indicating how the application processes the DPI scaling.
isAutoDpiScaling	Returns the value specifying if automatic DPI scaling is applied to the window.

WindowManager Class

Enums

CALLBACKS#

Name	Description
CALLBACKS_WINDOW_CREATED = 0	Callback after the window has been created.
CALLBACKS_WINDOW_REMOVED = 1	Callback after the window has been removed.
CALLBACKS_WINDOW_STACKED = 2	Callback after the window has been stacked.
CALLBACKS_WINDOW_UNSTACKED = 3	Callback after the window has been unstacked.
CALLBACKS_NUM = 4	Callback counter.

DPI_AWARENESS#

Name	Description
DPI_AWARENESS_CUSTOM = -1	The DPI awareness is set not on the engine side. For example, when the application is integrated via CustomSystemProxy, the user sets the required mode.
DPI_AWARENESS_UNAWARE = CUSTOM + 1	Scaling is not taken into account. Windows are displayed with the default DPI level of 96 (100%). The operating system will stretch the raster part of the window and it will look blurry.
DPI_AWARENESS_SYSTEM_AWARE = UNAWARE + 1	The DPI level of the main system display is obtained. Only with this DPI level the image is displayed clearly. Displays with another DPI level of changing of the DPI value on the main system display while running the application will cause the image blurring.
DPI_AWARENESS_PER_MONITOR_AWARE = SYSTEM_AWARE + 1	Windows get the DPI level from each display individually. Notice Not available on Linux.

Members

Ptr<EngineWindowViewport> getMainWindow ( ) const#

Returns the window viewport that is set as the main window by default.

NoticeThere may be several windows that are set as main, or no main windows at all.

Return value

Engine window viewport.

int getNumWindows ( ) const#

Returns the number of windows.

Return value

The number of windows.

Ptr<EngineWindow> getWindow ( int index ) #

Returns the window by its index.

Arguments

int index - Index of the window.

Return value

Engine window.

int getWindowIndex ( const Ptr<EngineWindow> & window ) const#

Returns the index of the specified window.

Arguments

const Ptr<EngineWindow> & window - Engine window.

Return value

Index of the window.

Ptr<EngineWindowGroup> stack ( const Ptr<EngineWindow> & first_window, const Ptr<EngineWindow> & second_window, EngineWindowGroup::GROUP_TYPE group_type, int index = -1, bool decompose_second = false ) #

Stacks the window to the other window. If the first argument is the separate window, a new window group is returned. If the first argument is the nested window, the window is added to its group.

Source code (C++)

EngineWindowPtr window_1 = EngineWindowViewport::create("Window 1", 512, 256);
EngineWindowPtr window_2 = EngineWindowViewport::create("Window 2", 512, 256);
EngineWindowPtr window_3 = EngineWindowViewport::create("Window 3", 512, 256);

// create a group of 2 windows
EngineWindowGroupPtr group_1 = WindowManager::stack(window_1, window_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
// stack a separate window to the window from the window group
WindowManager::stack(window_1, window_3, EngineWindowGroup::GROUP_TYPE_VERTICAL);

In the result, group_1 will consist of 3 windows: window_1 and window_3 stacked vertically and window_2 stacked horizontally.

Arguments

const Ptr<EngineWindow> & first_window - The parent window to which another window is stacked.
const Ptr<EngineWindow> & second_window - The window to be stacked.
EngineWindowGroup::GROUP_TYPE group_type - Type of a group to be created.
int index
bool decompose_second - Flag to decompose the second argument of the merge, if it is a group, and combine with the first group.

Return value

Group of stacked windows.

Ptr<EngineWindowGroup> stackToParentGroup ( const Ptr<EngineWindow> & window_in_group, const Ptr<EngineWindow> & window, int index = -1, bool decompose_second = false ) #

Stacks the second window to the parent window group of the first window. In the result, both windows passed as arguments will be on the same level in the group hierarchy. If the first window has no parent group, the function will return it as is.

Source code (C++)

EngineWindowPtr window_1 = EngineWindowViewport::create("Window 1", 512, 256);
EngineWindowPtr window_2 = EngineWindowViewport::create("Window 2", 512, 256);
EngineWindowPtr window_3 = EngineWindowViewport::create("Window 3", 512, 256);

// stack 2 separate windows
EngineWindowGroupPtr group_0 = WindowManager::stack(window_1, window_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
// stack a separate window to the parent group of "window_1"
WindowManager::stackToParentGroup(window_1, window_3);

Arguments

const Ptr<EngineWindow> & window_in_group - The window into the parent group of which the other window is stacked.
const Ptr<EngineWindow> & window - The window to be stacked.
int index - A place where a window or a group should be placed in a group.
bool decompose_second - Flag to decompose the second argument of the merge, if it is a group, and combine with the first window or a group.

Return value

Group of windows.

Ptr<EngineWindowGroup> stackWindows ( const Ptr<EngineWindowViewport> & first_viewport, const Ptr<EngineWindowViewport> & second_viewport, EngineWindowGroup::GROUP_TYPE group_type = Enum.EngineWindowGroup.GROUP_TYPE.TAB ) #

Returns a newly created group of the separate and/or nested windows. You cannot stack the window group to the separate window, however, you can stack a window nested in the window group: in this case, the window will be unstacked from its parent group and added to the new one. The windows are stacked in the default order. For example:

Source code (C++)

EngineWindowViewportPtr window_1 = EngineWindowViewport::create("Window 1", 512, 256);
EngineWindowViewportPtr window_2 = EngineWindowViewport::create("Window 2", 512, 256);
EngineWindowViewportPtr window_3 = EngineWindowViewport::create("Window 3", 512, 256);

// stack 2 separate windows
EngineWindowGroupPtr group_0 = WindowManager::stack(window_1, window_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);

// stack a window from the window group to a separate window
EngineWindowGroupPtr group_1 = WindowManager::stackWindows(window_3, window_1, EngineWindowGroup::GROUP_TYPE_VERTICAL);

In the result, group_1 will be a vertical group of window_3 and window_1.

Arguments

const Ptr<EngineWindowViewport> & first_viewport - The window to be stacked.
const Ptr<EngineWindowViewport> & second_viewport - The window to be stacked.
EngineWindowGroup::GROUP_TYPE group_type - Type of a group to be created.

Return value

Group of windows.

Ptr<EngineWindowGroup> stackWithWindow ( const Ptr<EngineWindowViewport> & window_viewport, const Ptr<EngineWindow> & window, EngineWindowGroup::GROUP_TYPE group_type, bool decompose_second = false ) #

Returns a newly created group of the engine window viewport and any other engine window — another viewport or a window group.

Arguments

const Ptr<EngineWindowViewport> & window_viewport - The window viewport to be stacked.
const Ptr<EngineWindow> & window - The window to be stacked.
EngineWindowGroup::GROUP_TYPE group_type - Type of a window group to be created.
bool decompose_second - Flag to decompose the second argument of the merge, if it is a group, and combine with the first group.

Return value

Group of windows.

Ptr<EngineWindowGroup> stackGroups ( const Ptr<EngineWindowGroup> & first_group, const Ptr<EngineWindowGroup> & second_group, EngineWindowGroup::GROUP_TYPE group_type ) #

Returns the group of window groups. The second group is added to the first group. To combine two windows or a group and a window, use the stack() method.

Source code (C++)

EngineWindowPtr window_1 = EngineWindowViewport::create("Window 1", 512, 256);
EngineWindowPtr window_2 = EngineWindowViewport::create("Window 2", 512, 256);
EngineWindowPtr window_3 = EngineWindowViewport::create("Window 3", 512, 256);
EngineWindowPtr window_4 = EngineWindowViewport::create("Window 4", 512, 256);

// create 2 horizontal groups of windows
EngineWindowGroupPtr group_1 = WindowManager::stack(window_1, window_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
EngineWindowGroupPtr group_2 = WindowManager::stack(window_3, window_4, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
// stack one group to another to create a new vertical group
EngineWindowGroupPtr group_3 = WindowManager::stackGroups(group_1, group_2, EngineWindowGroup::GROUP_TYPE_VERTICAL);

Arguments

const Ptr<EngineWindowGroup> & first_group - The first window group for merging.
const Ptr<EngineWindowGroup> & second_group - The second window group for merging.
EngineWindowGroup::GROUP_TYPE group_type - Type of a group to be created.

Return value

Group of windows.

Ptr<EngineWindowGroup> stackToGroup ( const Ptr<EngineWindowGroup> & destination_group, const Ptr<EngineWindow> & group, int index = -1, bool decompose_second = false ) #

Stacks the window or window group to another window group. The updated group of windows is returned.

Source code (C++)

EngineWindowPtr window_1 = EngineWindowViewport::create("Window 1", 512, 256);
EngineWindowPtr window_2 = EngineWindowViewport::create("Window 2", 512, 256);
EngineWindowPtr window_3 = EngineWindowViewport::create("Window 3", 512, 256);
EngineWindowPtr window_4 = EngineWindowViewport::create("Window 4", 512, 256);

// create 2 horizontal groups of windows
EngineWindowGroupPtr group_1 = WindowManager::stack(window_1, window_2, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);
EngineWindowGroupPtr group_2 = WindowManager::stack(window_3, window_4, EngineWindowGroup::GROUP_TYPE_HORIZONTAL);

// stack one group to another
WindowManager::stackToGroup(group_1, group_2);

Arguments

const Ptr<EngineWindowGroup> & destination_group - The parent group to which another group is stacked.
const Ptr<EngineWindow> & group - The window or window group to be stacked.
int index - A place where a window or a group should be placed in a group.
bool decompose_second - Flag to decompose the second argument of the merge and combine with the first group.

Return value

Group of stacked windows.

void unstack ( const Ptr<EngineWindow> & unstacked ) #

Removes a window or a group from a parent group. If there is only one window left, the group is automatically deleted after removing the window from it.

Arguments

const Ptr<EngineWindow> & unstacked - A window or a group to be removed from a parent group.

bool isMultipleWindowsSupported ( ) const#

Returns the value indicating if the engine can create more than one window. In addition to the settings defined by the user, it is currently impossible to create more than one window using Vulkan and DirectX 12. GL and DirectX 11, however, allow creating multiple windows.

Return value

true if multiple windows are supported, otherwise false.

bool isFullscreenMode ( ) const#

Returns the value indicating if at least one engine window is in a fullscreen state.

Return value

true if the window is the fullscreen state, false if it's in the window mode.

bool isFullscreenWindow ( const Ptr<EngineWindow> & window ) #

Returns the value indicating if the specified window is in a fullscreen state.

Arguments

const Ptr<EngineWindow> & window - The window to be checked.

Return value

true if the engine window is the fullscreen state, false if it is in the window mode.

Ptr<EngineWindowViewport> getFullscreenWindow ( ) const#

Returns the first engine window viewport that is in the fullscreen state.

Return value

The viewport in the fullscreen state, or nullptr if no window is found.

Ptr<EngineWindow> getWindowByID ( unsigned long long win_id ) const#

Returns the window by its ID.

Arguments

unsigned long long win_id - Window ID.

Return value

Window with the specified ID, or nullptr if the window is not found.

bool dialogMessage ( const char * title, const char * message ) #

Displays a message dialog with the specified title and text.

Arguments

const char * title - Title of the message dialog to be displayed.
const char * message - Message text to be displayed.

Return value

true if the message is displayed successfully; otherwise, false.

bool dialogWarning ( const char * title, const char * warning ) #

Displays a warning dialog with the specified title and text.

Arguments

const char * title - Title of the warning dialog to be displayed.
const char * warning - Warning message text to be displayed.

Return value

true if the message is displayed successfully; otherwise, false.

bool dialogError ( const char * title, const char * error ) #

Displays an error dialog with the specified title and text.

Arguments

const char * title - Title of the error dialog to be displayed.
const char * error - Error message text to be displayed.

Return value

true if the message is displayed successfully; otherwise, false.

int showSystemDialog ( const Ptr<SystemDialog> & dialog ) #

Displays a custom system dialog with an arbitrary set of buttons.

Arguments

const Ptr<SystemDialog> & dialog - SystemDialog class instance representing the custom system dialog to be shown.

Return value

Number of the dialog button clicked by the user; or -1 if an error has occurred.

const char * dialogOpenFolder ( const char * path ) #

Opens a common dialog enabling the user to specify a folder to open. When the dialog opens the specified default path shall be set displaying the corresponding elements.

Arguments

const char * path - Path to be set by default when the dialog opens.

Return value

Resulting folder name specified by the user.

const char * dialogOpenFolder ( ) #

Opens a common dialog enabling the user to specify a folder to open.

Return value

Resulting folder name specified by the user.

Vector<String> dialogOpenFiles ( const char * path, const char * filter ) #

Opens a common dialog enabling the user to specify a list of filenames to open multiple files. When the dialog opens the specified default path and file filter shall be set displaying the corresponding elements.

Arguments

const char * path - Path to be set by default when the dialog opens.
const char * filter - File name filter string to be set by default when the dialog opens. This filter string determines file type choices to be displayed in the Files of type box.

Return value

Resulting list of filenames specified by the user.

Vector<String> dialogOpenFiles ( const char * path ) #

Opens a common dialog enabling the user to specify a list of filenames to open multiple files. When the dialog opens the specified default path shall be set displaying the corresponding elements.

Arguments

const char * path - Path to be set by default when the dialog opens.

Return value

Resulting list of filenames specified by the user.

Vector<String> dialogOpenFiles ( ) #

Opens a common dialog enabling the user to specify a list of filenames to open multiple files.

Return value

Resulting list of filenames specified by the user.

const char * dialogOpenFile ( const char * path, const char * filter ) #

Opens a common dialog enabling the user to specify a filename to open a file. When the dialog opens the specified default path and file filter shall be set displaying the corresponding elements.