Unigine.EngineWindowGroup Class
| Inherits from: | EngineWindow |
The class to create and manage window groups: arrangement of multiple windows of a group into tabs, defining the parameters of such elements as tabs and window separators, detecting intersections with nested windows.
EngineWindowGroup Class
Enums
GROUP_TYPE#
AUTO_DELETE_MODE#
Properties
EngineWindowGroup.GROUP_TYPE GroupType#
The window group type.
bool Fixed#
The value indicating if this group is protected from adding/removing windows.
EngineWindowGroup.AUTO_DELETE_MODE AutoDeleteMode#
The automatic window deletion mode.
int NumNestedWindows#
The total number of nested windows in the group.
int CurrentTab#
The index of the currently active tab.
int SeparatorWidth#
The width of the separation line, in pixels.
int SeparatorHeight#
The height of the separation line, in pixels.
ivec2 IntersectedItemPosition#
The screen position of the intersected item — coordinates of the left top corner.
ivec2 IntersectedItemSize#
The size of the intersected item, in pixels.
Members
EngineWindowGroup ( EngineWindowGroup.GROUP_TYPE group_type, ivec2 size, int flags = 0 ) #
Constructor. Creates the window group of the specified type and size with the specified flags.Arguments
- EngineWindowGroup.GROUP_TYPE group_type - The type of the group.
- ivec2 size - The size of the window group.
- int flags - Mask containing window flags.
EngineWindowGroup ( EngineWindowGroup.GROUP_TYPE group_type, int width, int height, int flags = 0 ) #
Constructor. Creates the window group of the specified type and size with the specified flags.Arguments
- EngineWindowGroup.GROUP_TYPE group_type - The type of the group.
- int width - Window width.
- int height - Window height.
- int flags - Mask containing window flags.
EngineWindowGroup ( EngineWindowGroup.GROUP_TYPE group_type, string window_title, int width, int height, int flags = 0 ) #
Constructor. Creates the window group of the specified type and size with the specified title and flags.Arguments
- EngineWindowGroup.GROUP_TYPE group_type - The type of the group.
- string window_title - The title of the window, in UTF-8 encoding.
- int width - Window width.
- int height - Window height.
- int flags - Mask containing window flags.
void Add ( EngineWindow window, int target_index = -1 ) #
Adds a window at a specified index. The window becomes nested (i.e. its borders, style, title bar, etc. are disabled).Notice
If the group is fixed, a window won't be added to the group and the console will display a corresponding warning.
Arguments
- EngineWindow window - Window to be added.
- int target_index - The window order. If no index is set, the window is added as the last one.
void Remove ( EngineWindow window ) #
Removes the specified window from the group. The window's settings are the same as before adding it to the group.Notice
If the group is fixed, a window won't be removed from the group and the console will display a corresponding warning.
Arguments
- EngineWindow window - Window to be removed.
void RemoveByIndex ( int index ) #
Removes the window at a specified index from the group. The window's settings are the same as before adding it to the group.Notice
If the group is fixed, a window won't be removed from the group and the console will display a corresponding warning.
Arguments
- int index - The index of the window to be removed.
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 group.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 ContainsNestedWindowInHierarchy ( EngineWindow window ) #
Returns the value indicating if the specified window is a child of the current group 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.void SetTabTitle ( int index, string title ) #
Adds the title to the specified tab and the window itself.Arguments
- int index - Index of the tab.
- string title - Title to be added.
void SetTabIcon ( int index, Image image ) #
Adds the image to the specified tab and the window itself.Arguments
- int index - Index of the tab.
- Image image - Image to be added.
int GetTabWidth ( int index ) #
Returns the width of the tab. Available for horizontal groups only.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. Available for vertical groups only.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 relative position of the tab separator.Arguments
- int index - Index of the tab.
- float value - Position of the tab separator, the value from 0 to 1 that is recalculated to pixels.
float GetSeparatorValue ( int index ) #
Returns the relative position of the tab separator.Arguments
- int index - Index of the tab.
Return value
Position of the tab separator, the value from 0 to 1.void SwapTabs ( int first, int second ) #
Swaps the specified tabs.Notice
If the group is fixed, tabs won't be swapped and the console will display a corresponding warning.
Arguments
- int first - Index of the first tab.
- int second - Index of the second tab.
int GetIntersectionTabBar ( ivec2 global_mouse_pos ) #
Returns the value indicating if the mouse is hovering over the window tab bar.Arguments
- ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.
Return value
1 if the mouse hovers over the window tab bar, otherwise 0.int GetIntersectionTabBarArea ( ivec2 global_mouse_pos ) #
Returns the value indicating if the mouse is hovering over the window tab bar area.Arguments
- ivec2 global_mouse_pos - Global screen coordinates of the mouse relative to the main display.
Return value
1 if the mouse hovers over the window tab bar area, otherwise 0.Last update:
2023-06-23
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)