Unigine.EngineWindow Class

// create an engine window of the specified size with the specified name
EngineWindow window = new EngineWindow(name, 580, 300);

// set an icon and a title for the window 
window.SetIcon(icon);
window.Title = "Vertical Group";

// set the window as the main one
window.Main = true;

// enable the console, profiler and visualizer for the window
window.ConsoleUsage = true;
window.ProfilerUsage = true;
window.VisualizerUsage = true;

// add widgets to the client area of the engine window
window.AddChild(new WidgetLabel(window.SelfGui,  String.Format("This is {0} window.", name)));
window.AddChild(new WidgetButton(window.SelfGui, name), Gui.ALIGN_CENTER);

// separate windows
EngineWindow settings = new EngineWindow("Settings", 512, 256);
EngineWindow parameters = new EngineWindow("Parameters", 512, 256);

// grouped windows
EngineWindow settings_and_parameters = WindowManager.StackWindows(settings, parameters, EngineWindow.GROUP_TYPE.TAB);

EngineWindow Class

Enums

HITTEST#

Name	Description
INVALID = -1
NORMAL = 0	Client area of the window.
DRAGGABLE = 1	Area of the window, by clicking onto which the window can be moved.
RESIZE_TOPLEFT = 2	Area of the window that can be dragged to resize the window to the top and/or left direction.
RESIZE_TOP = 3	Area of the window that can be dragged to resize the window to the top direction.
RESIZE_TOPRIGHT = 4	Area of the window that can be dragged to resize the window to the top and/or right direction.
RESIZE_RIGHT = 5	Area of the window that can be dragged to resize the window to the right direction.
RESIZE_BOTTOMRIGHT = 6	Area of the window that can be dragged to resize the window to the bottom and/or right direction.
RESIZE_BOTTOM = 7	Area of the window that can be dragged to resize the window to the bottom direction.
RESIZE_BOTTOMLEFT = 8	Area of the window that can be dragged to resize the window to the bottom and/or left direction.
RESIZE_LEFT = 9	Area of the window that can be dragged to resize the window to the left direction.

STATE#

Name	Description
SEPARATE_WINDOW = 0	Separate system window.
SEPARATE_GROUP = 1	Separate system window group.
NESTED_WINDOW = 2	Nested window, a part of a window group.
NESTED_GROUP = 3	Nested group of windows, a part of a window group.

GROUP_TYPE#

Name	Description
NONE = 0	A separate window inside the group.
TAB = 1	Windows are arranged into a group of tabs with a selected window displayed atop the others in the group.
HORIZONTAL = 2	Windows are arranged into a horizontally displayed group.
VERTICAL = 3	Windows are arranged into a vertically displayed group.

CALLBACK_INDEX#

Name	Description
WINDOW_EVENT = 0	Callback on the window event.
FUNC_UPDATE = 1	Callback after the window update.
FUNC_BEGIN_RENDER = 2	Callback after the window rendering has begun.
FUNC_RENDER = 3	Callback after the window rendering function.
FUNC_BEGIN_RENDER_GUI = 4	Callback after the GUI rendering has begun.
FUNC_END_RENDER_GUI = 5	Callback after the GUI rendering has ended.
FUNC_END_RENDER = 6	Callback after the window rendering has ended.
FUNC_SWAP = 7	Callback before calling the window swap.
NUM_CALLBACKS = 8	Callback counter.

FLAGS#

Name	Description
MAIN = 1 << 0	Main window.
CONSOLE_USAGE = 1 << 1	Usage of the console for the window is enabled.
PROFILER_USAGE = 1 << 2	Usage of the profiler for the window is enabled.
VISUALIZER_USAGE = 1 << 3	Usage of the visualizer for the window is enabled.
SHOWN = 1 << 4	Window is rendered.
FIXED_SIZE = 1 << 5	Window size is fixed.
HOLD_ENGINE = 1 << 6	Engine can't stop operating while this window is open.

Properties

bool Main#

Camera Camera#

Gui Gui#

int DisplayIndex#

bool IsSeparateWindow#

bool IsSeparateGroup#

bool IsNestedWindow#

bool IsNestedGroup#

bool IsWindow#

bool IsGroup#

bool IsNested#

bool IsSeparate#

EngineWindow.STATE State#

EngineWindow.GROUP_TYPE GroupType#

Gui SelfGui#

ivec2 Position#

ivec2 ClientPosition#

ivec2 ClientLocalPosition#

ivec2 Size#

ivec2 ClientSize#

ivec2 MinSize#

ivec2 MaxSize#

string Title#

float Opacity#

bool BordersEnabled#

int BorderSize#

bool ConsoleUsage#

bool ProfilerUsage#

bool VisualizerUsage#

bool Resizable#

int ResizeBorderSize#

int DraggableHeight#

bool IsFullscreen#

bool IsShown#

bool IsHidden#

bool IsFocused#

bool IsMinimized#

bool IsMaximized#

int Order#

bool GroupUsage#

bool NestedUsage#

int NumNestedWindows#

EngineWindow ParentGroup#

EngineWindow GlobalParentGroup#

int CurrentTab#

int NumDroppedItems#

int NumModalWindows#

EngineWindow ModalParent#

bool IsModalParent#

bool IsModal#

bool IgnoreSystemClose#

bool HoldEngine#

string VideoModeName#

ulong ID#

Members

---

EngineWindow ( string title, int width, int height, int flags = 0 ) #

Constructor. Creates the engine window of the specified size with the specified name using the specified flags.

Arguments

• string title - The title of the window, in UTF-8 encoding.
• int width - Window width.
• int height - Window height.
• int flags - Mask containing window flags.

EngineWindow ( int width, int height, int flags = 0 ) #

Constructor. Creates the engine window of the specified size using the specified flags.

Arguments

• int width - Window width.
• int height - Window height.
• int flags - Mask containing window flags.

EngineWindow ( ivec2 size, int flags = 0 ) #

Constructor. Creates the engine window of the specified size using the specified flags.

Arguments

• ivec2 size - Window size.
• int flags - Mask containing window flags.

void MoveToCenter ( ) #

Moves the engine window to the center of the current screen.

bool SetIcon ( Image icon ) #

Sets the icon for the engine window.

Arguments

• Image icon - The icon for the engine window.

Return value

true if the specified icon is successfully set for the engine window, otherwise false.

Image GetIcon ( ) #

Returns the icon for the engine window.

Return value

The icon for the engine window.

void Show ( ) #

Enables rendering of the engine window.

void Hide ( ) #

Disables rendering of the engine window.

void SetFocus ( ) #

Sets the focus to the engine window.

void Minimize ( ) #

Minimizes the engine window to an iconic representation.

void Maximize ( ) #

Makes the engine window as large as possible.

void Restore ( ) #

Restores the size and position of the minimized or maximized engine window.

void SetMouseGrab ( bool value ) #

Sets a value indicating if the mouse pointer is bound to the engine window.

Arguments

• bool value - true if the pointer cannot leave the engine window, otherwise false.

EngineWindow.HITTEST GetHitTestResult ( ) #

Returns a value indicating in which area of the engine window the mouse is located.

Return value

Value indicating the window area, one of the HITTEST.* values.

void ToTop ( ) #

Makes the window appear on top of all other windows.

void AddChild ( Widget widget, int flags = -1 ) #

Adds the specified widget as a child to the client area of the engine window.

Arguments

• Widget widget - Child widget to be added.
• int flags - Widget flags: one of the ALIGN_* pre-defined variables. This is an optional parameter.

void RemoveChild ( Widget widget ) #

Removes the specified widget from the engine window.

Arguments

• Widget widget - Child widget to be removed.

Widget GetChild ( int index ) #

Returns the child widget by its index.

Arguments

• int index - Widget index.

Return value

Child widget.

int GetNumChildren ( ) #

Returns the total number of children widgets of the engine window.

Return value

The total number of children widgets.

EngineWindow GetNestedWindow ( int index ) #

Returns the nested engine window by its index.

Arguments

• int index - Index of the nested window.

Return value

Nested engine window.

int GetNestedWindowIndex ( EngineWindow window ) #

Returns the index of the specified nested engine window.

Arguments

• EngineWindow window - Nested engine window.

Return value

Index of the nested window.

bool ContainsNestedWindow ( EngineWindow window ) #

Returns the value indicating if the specified window is a direct child of the current window.

Arguments

• EngineWindow window - Window to be checked.

Return value

true if the specified window is a direct child of the current one, otherwise false.

bool ContainsNestedWindowGlobal ( EngineWindow window ) #

Returns the value indicating if the specified window is a child of the current window or any of its children.

Arguments

• EngineWindow window - Window to be checked.

Return value

true if the specified window is a child of the current one, otherwise false.

bool IsGlobalChildOf ( EngineWindow window ) #

Returns the value specifying if the current window is a part of a hierarchy of the specified window.

Arguments

• EngineWindow window - Window to be checked.

Return value

true if the current window is globally a child of the specified one, otherwise false.

int GetTabWidth ( int index ) #

Returns the width of the tab.

Arguments

• int index - The index of the tab.

Return value

The width of the the tab.

int GetTabHeight ( int index ) #

Returns the height of the tab.

Arguments

• int index - The index of the tab.

Return value

The height of the tab.

int GetTabBarWidth ( int index ) #

Returns the width of the tab bar.

Arguments

• int index - The index of the tab.

Return value

The width of the tab bar.

int GetTabBarHeight ( int index ) #

Returns the height of the tab bar.

Arguments

• int index - The index of the tab.

Return value

The height of the tab bar.

ivec2 GetTabLocalPosition ( int index ) #

Returns the screen position of the tab relatively to the parent group (global window). The coordinates represent the displacement from the top left corner of the parent group (global window).

Arguments

• int index - The index of the tab.

Return value

The screen position of the tab relatively to the parent group (global window).

ivec2 GetTabBarLocalPosition ( int index ) #

Returns the screen position of the tab bar relatively to the parent group (global window). The coordinates represent the displacement from the top left corner of the parent group (global window).

Arguments

• int index - The index of the tab.

Return value

The screen position of the tab bar relatively to the parent group (global window).

void SetHorizontalTabWidth ( int index, int width ) #

Sets the width of the tab in the group of tabs arranged horizontally.

Arguments

• int index - The index of the tab.
• int width - The width of the tab in the group of tabs arranged horizontally.

void SetVerticalTabHeight ( int index, int height ) #

Sets the height of the tab in the group of tabs arranged vertically.

Arguments

• int index - The index of the tab.
• int height - The height of the tab in the group of tabs arranged vertically.

void SetSeparatorPosition ( int index, int pos ) #

Sets the position of the line separating a tab group from the rest of the area. The separator line can be horizontal or vertical depending on the group type.

Arguments

• int index - Index of the tab.
• int pos - Position of the separation line, in pixels, from the top-left corner of the window.

int GetSeparatorPosition ( int index ) #

Returns the position of the line separating a tab group from the rest of the area. The separator line can be horizontal or vertical depending on the group type.

Arguments

• int index - Index of the tab.

Return value

Position of the separation line, in pixels, from the top-left corner of the window.

void SetSeparatorValue ( int index, float value ) #

Sets the size of the tab separator.

Arguments

• int index - Index of the tab.
• float value - Size of the tab separator.

float GetSeparatorValue ( int index ) #

Returns the size of the tab separator.

Arguments

• int index - Index of the tab.

Return value

Size of the tab separator.

void SwapTabs ( int first, int second ) #

Swaps the specified tabs.

Arguments

• int first - Index of the first tab.
• int second - Index of the second tab.

bool IsHover ( ivec2 global_mouse_pos ) #

Returns the value indicating if the mouse is hovering over the window.

Arguments

• ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.

Return value

true if the mouse hovers over the current window, otherwise false.

bool IsClientHover ( ivec2 global_mouse_pos ) #

Returns the value indicating if the mouse is hovering over the client area of the window.

Arguments

• ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.

Return value

true if the mouse hovers over the client area of the window, otherwise false.

int GetHoverTabBar ( ivec2 global_mouse_pos, out ivec2 out_bar_pos, out ivec2 out_bar_size ) #

Returns the index of the tab over the bar of which the mouse hovers.

Arguments

• ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.
• out ivec2 out_bar_pos - Position of the tab bar.
• out ivec2 out_bar_size - Size of the tab bar.

Return value

Index of the tab.

int GetHoverTabBarArea ( ivec2 global_mouse_pos, out ivec2 out_area_pos, out ivec2 out_area_size ) #

Returns the index of the tab over the bar area of which the mouse hovers.

Arguments

• ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.
• out ivec2 out_area_pos
• out ivec2 out_area_size

Return value

Index of the tab.

string GetDroppedItem ( int index ) #

Returns the absolute path to the file or folder dropped to the window.

Arguments

• int index - Index of the dropped file or folder.

Return value

Absolute path to the dropped file or folder.

ulong GetID ( ) #

Returns the ID of the engine window, if the window is external, i.e. not nested in any window and can be moved independently on the desktop.

Return value

ID of the engine window, if the window is external.

string GetVideoModeName ( ) #

Returns the window size and name of the current video mode.

Return value

The window size and name of the current video mode: fullscreen or windowed.

void Screenshot ( string path ) #

Creates a screenshot after the rendering stage is completed.

Arguments

• string path - Path to save the screenshot.

void SetHoldEngine ( bool engine ) #

Sets the value indicating if the engine can stop operating (quit automatically) while this window is open.

Arguments

• bool engine - true if the engine can't stop operating while this window is open, otherwise false.

bool IsHoldEngine ( ) #

Sets the value indicating if the engine can stop operating (quit automatically) while this window is open.

Return value

true if the engine can't stop operating while this window is open, otherwise false.

void SetIgnoreSystemClose ( bool close ) #

Sets the value indicating if this window can be closed using the OS methods (ALT+F4 or cross in the top-right corner of the window).

Arguments

• bool close - If true, the window can't be closed using the OS methods.

bool IsIgnoreSystemClose ( ) #

Returns the value indicating if this window can be closed using the OS methods (ALT+F4 or cross in the top-right corner of the window).

Return value

If true, the window can't be closed using the OS methods.

void DisableFullscreen ( ) #

Disables the fullscreen mode for the window in the fullscreen mode and sets the focus to this window.

bool EnableFullscreen ( int display = -1, int mode = -1 ) #

Enables the specified fullscreen mode for the specified display.

Arguments

• int display - Display index.
• int mode - Index of the mode supported by the display.

Return value

true if the specified fullscreen mode has been enabled for the specified display; otherwise, false.

void SetModal ( EngineWindow parent_window ) #

Sets this window modal to the specified parent window.

Arguments

• EngineWindow parent_window - Parent window.

bool IsModal ( ) #

Checks if the window is modal.

Return value

true if the window is modal; otherwise, false.

bool IsModalParent ( ) #

Checks if this window is parent for any modal window.

Return value

true if the window is parent for any modal window; otherwise, false.

EngineWindow GetModalParent ( ) #

Returns the modal parent of the window.

Return value

The modal parent of the window.

void AddModalWindow ( EngineWindow window ) #

Adds the argument window as modal to the current window.

Arguments

• EngineWindow window - Window to be added as modal.

void RemoveModalWindow ( EngineWindow window ) #

Removes the argument modal window from this window.

Arguments

• EngineWindow window - Engine window.

int GetNumModalWindows ( ) #

Returns the total number of modal windows for this window.

Return value

The total number of modal windows.

EngineWindow GetModalWindow ( int index ) #

Returns the modal window for this window by its index.

Arguments

• int index - Index of the modal window.

Return value

Modal window.

bool IsChild ( Widget widget ) #

Checks if the argument widget is the child of the current window.

Arguments

• Widget widget - Widget.

Return value

true if the widget is the child of the current window; otherwise, false.

void Unstack ( ) #

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