Управление окнами
UNIGINE provides an advanced toolkit simplifying development of various visual tools, with a large number of widgets and capabilities.UNIGINE предоставляет расширенный набор инструментов, упрощающий разработку различных визуальных инструментов, с большим количеством виджетов и возможностей.
You can easily create and adjust window viewports and window groups, control their behavior and rendering order, stack them, handle events, check window intersections, and so on via API:Вы можете легко создавать и настраивать видовые экраны и группы окон, управлять их поведением и порядком рендеринга, стыковать их, обрабатывать события, проверять пересечения окон и так далее с помощью API:
- All window management operations are performed via the WindowManager class, enabling you to access any application window, group or stack windows, create various dialogs, and so on.Все операции по управлению окнами выполняются с помощью класса WindowManager, что позволяет вам получать доступ к любому окну приложения, группировать окна или стекировать их, создавать различные диалоговые окна и так далее.
- Window components, relations with other windows, size, position, order, window events and intersections are managed by the base EngineWindow class.Компоненты окна, взаимосвязь с другими окнами, размер, положение, порядок, события окна и пересечения управляются базовым классом EngineWindow.
- For window viewport creation, the EngineWindowViewport class is used. It inherits from EngineWindow class and allows managing window viewports: setting cameras, specifying engine tools available (console, profiler, visualizer, etc.), adding widgets to the client area.Для создания видового экрана окна используется класс EngineWindowViewport. Он наследуется от класса EngineWindow и позволяет управлять видовыми экранами окон: настраивать камеры, указывать доступные инструменты движка (консоль, профилировщик, визуализатор и т. д.), добавлять виджеты в клиентскую область.
- For window groups, there is the EngineWindowGroup class. It also inherits from EngineWindow class and allows implementing custom grouping logic.Для групп окон существует класс EngineWindowGroup. Он также наследуется от класса EngineWindow и позволяет реализовать пользовательскую логику группировки.
- Both a window viewport and a window group are engine windows.Как окно просмотра, так и группа окон являются окнами движка.
- Usually the engine windows stay available during the whole UNIGINE Engine runtime, so their creation and management should be implemented as a part of the System Logic.Обычно окна движка остаются доступными в течение всего времени выполнения UNIGINE Engine, поэтому их создание и управление должны быть реализованы как часть системной логики.
Creating a Window ViewportСоздание видового экрана окна#
To create the engine window viewport, one of the EngineWindowViewport class constructors is used.Для создания окна просмотра движка используется один из конструкторов класса EngineWindowViewport.
// create an engine window of the specified size with the specified name
EngineWindowViewport window = new EngineWindowViewport("Window", 580, 300);
When the window viewport is created, you can change its settings: specify the engine tools available, set the viewport as the main one, specify the camera the image from which is rendered into the viewport, and so on. All these operations are provided by the EngineWindowViewport class. For example:Когда окно просмотра создано, вы можете изменить его настройки: указать доступные инструменты движка, установить окно просмотра в качестве основного, указать камеру, изображение с которой выводится в окно просмотра, и так далее. Все эти операции предоставляются классом EngineWindowViewport. Например:
// set the window viewport as the main one
window.Main = true;
// enable the console, profiler and visualizer for the window viewport
window.ConsoleUsage = true;
window.ProfilerUsage = true;
window.VisualizerUsage = true;
You can also add widgets to the client area of the window:Вы также можете добавить виджеты в клиентскую область окна:
// add widgets to the client area
window.AddChild(new WidgetLabel(window.SelfGui, String.Format("This is {0} window.", window.Title)));
window.AddChild(new WidgetButton(window.SelfGui, window.Title), Gui.ALIGN_CENTER);
To control window components, its behaviour, visual representaion, and style, use the EngineWindow class functionality. The corresponding article contains short samples that cover most of the available functions.Чтобы управлять компонентами окна, его поведением, визуальным представлением и стилем, используйте функциональность класса EngineWindow. Соответствующая статья содержит краткие примеры, которые охватывают большинство доступных функций.
Creating a Window GroupСоздание группы окон#
When the engine windows are grouped, a new window containing these windows is created. This new window is called a group, and the windows in the group - nested. The number of windows in the group is unlimited. Moreover, you can group both the separate engine windows and the existing window groups.Когда окна движка сгруппированы, создается новое окно, содержащее эти окна. Это новое окно называется группой, а окна в группе — вложенными. Количество окон в группе не ограничено. Более того, вы можете сгруппировать как отдельные окна движка, так и существующие группы окон.
There are three types of the window groups:Существует три типа групп окон:
- VerticalВертикальный
- HorizontalГоризонтальный
- Group of tabsГруппа вкладок
Within the group, all windows are stacked according to one of these types.Внутри группы все окна сгруппированы в соответствии с одним из этих типов.
Grouping via CodeГруппировка с помощью кода#
A window group is an instance of the EngineWindowGroup class that can be created in one of the following ways:Группа окон — это экземпляр класса EngineWindowGroup, который может быть создан одним из следующих способов:
-
You can create an empty group using one of the EngineWindowGroup class constructors and then add windows or other groups to it.Вы можете создать пустую группу, используя один из конструкторов класса EngineWindowGroup, а затем добавить в нее windows или другие группы.
// create separate windows that will be grouped EngineWindowViewport horizontal_1 = new EngineWindowViewport("Horizontal 1", 512, 256); EngineWindowViewport horizontal_2 = new EngineWindowViewport("Horizontal 2", 512, 256); EngineWindowViewport horizontal_3 = new EngineWindowViewport("Horizontal 3", 512, 256); // create a horizontal group EngineWindowGroup horizontal_group = new EngineWindowGroup(EngineWindowGroup.GROUP_TYPE.HORIZONTAL, "Horizontal Group", 800, 256); // add windows to the group horizontal_group.Add(horizontal_1); horizontal_group.Add(horizontal_2); horizontal_group.Add(horizontal_3); // set a position of the group horizontal_group.Position = new ivec2(50, 60);
This approach implies that you implement custom grouping and ungrouping logic: check if the windows can be nested or produce a group, set the automatic deletion mode, and so on. The EngineWindow and EngineWindowGroup classes provide the required funtionality for controlling the engine windows stacking.Этот подход подразумевает, что вы реализуете пользовательскую логику группировки и разгруппировки: проверяете, могут ли окна быть вложенными или создавать группу, устанавливаете режим автоматического удаления и так далее. Классы EngineWindow и EngineWindowGroup обеспечивают необходимую функциональность для управления стекированием окон движка. - You can stack windows using WindowManager class functionality. In this case, the manager will automatically validate windows before adding them to the group and manage the group after removing a window from it.Вы можете стыковать окна, используя функциональность класса WindowManager. В этом случае менеджер автоматически проверит окна перед добавлением их в группу и будет управлять группой после удаления из нее окна.
When the window group is created, you can adjust its elements: set titles and icons for tabs, change its width or height, adjust separators. All these operations are provided by the EngineWindowGroup class.Когда группа окон создана, вы можете настроить ее элементы: установить заголовки и значки для вкладок, изменить ее ширину или высоту, настроить разделители. Все эти операции предоставляются классом EngineWindowGroup.
For example, to change the first tab in the group, you can do the following:Например, чтобы изменить первую вкладку в группе, вы можете выполнить следующее:
// update a hierarchy in self gui of the group
horizontal_group.UpdateGuiHierarchy();
int position_offset = 100;
float value_offset = 0.2f;
for (int i = 0; i < horizontal_group.NumNestedWindows; i++)
{
// change a tab
horizontal_group.SetTabTitle(i, "New name " + i.ToString());
if (i == 0) horizontal_group.SetHorizontalTabWidth(i, position_offset);
// change a separator
horizontal_group.SetSeparatorValue(i, horizontal_group.GetSeparatorValue(i) + value_offset);
}
UNIGINE SDK provides several samples (source/samples/Api/WindowManager) on the window groups: you can check different group types in the GroupTypes sample or create a new window group and try to adjust it in the WindowSandbox sample. Also the article on the EngineWindowGroup class contains short samples demonstrating the available functions.UNIGINE SDK предоставляет несколько примеров (source/samples/Api/WindowManager) для групп окон: вы можете проверить различные типы групп в примере GroupTypes или создать новую группу окон и попытаться настроить ее в примере WindowSandbox. Также статья о классе EngineWindowGroup содержит краткие примеры, демонстрирующие доступные функции.
Grouping Using the MouseГруппировка с помощью мыши#
While the application is running, you can group and ungroup the existing windows by using the mouse.Пока приложение запущено, вы можете группировать и разгруппировывать существующие окна с помощью мыши.
To group two separate windows, do the following:Чтобы сгруппировать два отдельных окна, выполните следующие действия:
- Hold the mouse button while moving the window to the destination one. The destination window will be divided into 9 sectors.Удерживая нажатой кнопку мыши, перемещайте окно в нужное место. Окно назначения будет разделено на 9 секторов.
- Choose the required sector and release the mouse button — the windows will be grouped.Выберите нужный сектор и отпустите кнопку мыши — окна будут сгруппированы.
To add the window to the existing group, you should hold the mouse button while moving the window and release it in one of the following areas:Чтобы добавить окно в существующую группу, вам следует удерживать кнопку мыши при перемещении окна и отпустить ее в одной из следующих областей:
-
For the horizontal group:Для горизонтальной группы:
-
For the vertical group:Для вертикальной группы:
-
For the group of tabs:Для группы вкладок:
To ungroup the window, move it outside the group by dragging the title bar.Чтобы разгруппировать окно, переместите его за пределы группы, перетащив строку заголовка.
Accessing WindowsДоступ к окнам#
The engine window can be accessed via the WindowManager.GetWindow() function.Доступ к окну движка можно получить с помощью функции WindowManager.GetWindow().
// get the number of windows
int num = WindowManager.NumWindows;
// check each window
for (int i = 0; i < num; i++)
{
// get the window with the current index
EngineWindow window = WindowManager.GetWindow(i);
// change its position and size if it is main
if (window == WindowManager.MainWindow)
{
window.Position = new ivec2(1020, 60);
window.Size = new ivec2(305, 670);
}
}
There are also some functions (like WindowManager.MainWindow) that allow accessing the specific windows (the main, focused, fullscreen window and so on). For example:Существуют также некоторые функции (например, WindowManager.MainWindow), которые позволяют получать доступ к определенным окнам (основное окно, окно в фокусе, полноэкранное окно и так далее). Например:
// get the main window
EngineWindow main_window = WindowManager.MainWindow;
// change its position and size
if (main_window)
{
main_window.Position = new ivec2(1020, 60);
main_window.Size = new ivec2(305, 670);
}
Managing Window GroupsУправление группами окон#
As it was mentioned above, you can implement custom logic for grouping and ungrouping windows or use functionality provided by the WindowManager class. Here we will consider the latter.Как было упомянуто выше, вы можете реализовать пользовательскую логику для группировки и разгруппировки окон или использовать функциональность, предоставляемую классом WindowManager. Здесь мы рассмотрим последнее.
In the WindowManager class, there are two main functions for grouping windows:В классе WindowManager есть две основные функции для группировки окон:
- WindowManager.Stack() creates a group of two windows.WindowManager.Stack() создает группу из двух окон.
- WindowManager.StackGroups() creates a group of two window groups.WindowManager.StackGroups() создает группу из двух групп окон.
// create separate windows
EngineWindowViewport horizontal_1 = new EngineWindowViewport("Horizontal 1", 512, 256);
EngineWindowViewport horizontal_2 = new EngineWindowViewport("Horizontal 2", 512, 256);
EngineWindowViewport horizontal_3 = new EngineWindowViewport("Horizontal 3", 512, 256);
EngineWindowViewport horizontal_4 = new EngineWindowViewport("Horizontal 4", 512, 256);
// create 2 horizontal window groups
EngineWindowGroup horizontal_group_1 = WindowManager.Stack(horizontal_1, horizontal_2, EngineWindowGroup.GROUP_TYPE.HORIZONTAL);
EngineWindowGroup horizontal_group_2 = WindowManager.Stack(horizontal_3, horizontal_4, EngineWindowGroup.GROUP_TYPE.HORIZONTAL);
// create a vertical group of 2 horizontal groups
EngineWindowGroup 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.Position = new ivec2(50, 60);
vertical_group.Size = new ivec2(565, 310);
vertical_group.Title = "Vertical 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 WindowManager.Stack() function that should be used in specific cases to avoid additional checking of arguments:Существуют также функции, основанные на функции WindowManager.Stack(), которые следует использовать в конкретных случаях, чтобы избежать дополнительной проверки аргументов:
-
WindowManager.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.WindowManager.StackToParentGroup() помещает второе окно в родительскую группу первого окна. В результате оба окна, переданные в качестве аргументов, будут находиться на одном уровне в иерархии группы.
// create separate windows EngineWindowViewport window_1 = new EngineWindowViewport("Window 1", 512, 256); EngineWindowViewport window_2 = new EngineWindowViewport("Window 2", 512, 256); EngineWindowViewport window_3 = new EngineWindowViewport("Window 3", 512, 256); // stack 2 separate windows EngineWindowGroup group_0 = WindowManager.StackWindows(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);
-
WindowManager.StackWithWindow() 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.WindowManager.StackWithWindow() складывает окно в другое окно. Если первым аргументом является отдельное окно, возвращается новая группа окон. Если первым аргументом является вложенное окно, то окно добавляется в свою группу.
// create a group of 2 windows EngineWindowGroup group_1 = WindowManager.Stack(window_1, window_2, EngineWindowGroup.GROUP_TYPE.HORIZONTAL); // stack a separate window to the window from the window group WindowManager.StackWithWindow(window_1, window_3, EngineWindowGroup.GROUP_TYPE.VERTICAL);
- WindowManager.StackWindows() creates a group of the separate/nested windows. The windows are stacked in the default order.WindowManager.StackWindows() создает группу отдельных/вложенных окон. Окна расположены в порядке, установленном по умолчанию.
- WindowManager.StackToGroup() stacks the window or window group to another window group.WindowManager.StackToGroup() помещает окно или группу окон в другую группу окон.
For ungrouping, the WindowManager.Unstack() function is used: it removes the window or the window group from the parent group. If only one window remains in the group, it is automatically removed from the group and the group is deleted.Для разгруппировки используется функция WindowManager.Unstack(): она удаляет окно или группу окон из родительской группы. Если в группе остается только одно окно, оно автоматически удаляется из группы, а сама группа удаляется.
Working with DialogsРабота с диалоговыми окнами#
To create a dialog window, use the corresponding functions of the class. For example:Чтобы создать диалоговое окно, используйте соответствующие функции класса. Например:
// create a window with widgets in the client area
private EngineWindowViewport create_window (string name)
{
EngineWindowViewport window = new EngineWindowViewport(name, 512, 256);
window.AddChild(new WidgetLabel(window.SelfGui, String.Format("This is a {0}.", name)), Gui.ALIGN_TOP);
window.AddChild(new WidgetButton(window.SelfGui, name), Gui.ALIGN_CENTER);
return window;
}
private void Init()
{
// create a window
EngineWindowViewport window = create_window("Window");
// get the child widget of the window
Widget button = window.GetChild(1);
// subscribe for the Click event for this widget
button.EventClicked.Connect(() => WindowManager.DialogMessage("Message", "The button has been pressed."));
// show the window
window.Position = new ivec2(50, 60);
window.Show();
}
If you press the button in the client area of the created window, the following dialog will be shown:Если вы нажмете кнопку в клиентской области созданного окна, будет показано следующее диалоговое окно: