Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

engine.interface Functions

This set of functions is available when the Interface plugin is loaded.

int INTERFACE_WINDOW_CLOSE

Description

An Interface window has a close button.

int INTERFACE_WINDOW_DROP

Description

A file is dragged and dropped to the interface window.

int INTERFACE_WINDOW_FRAME

Description

An Interface window has only a frame (no title bar).

int INTERFACE_WINDOW_MAXIMIZE

Description

An Interface window has a maximize button.

int INTERFACE_WINDOW_MINIMIZE

Description

An Interface window has a minimize button.

int INTERFACE_WINDOW_TITLE

Description

An Interface window has a title bar.

int engine.interface.findWindow (Unigine::Ptr<Unigine::Gui> gui)

Returns the number of the Interface window rendered by the given gui instance.

Arguments

  • Unigine::Ptr<Unigine::Gui> gui - Pointer to the gui instance.

Return value

The window number, if it exists; otherwise, -1.

int engine.interface.getCenterPositionX (int width)

Returns the coordinate along the X axis, at which the window of the given width will be positioned in the center of the screen.
Notice
The function won't return a value in the following cases:
  • If the parent flag of the interface window is set to 0.
  • If the window is hidden.
  • If the window is not focused.
  • If the window is not an instance of the WidgetWindow class.

Arguments

  • int width - Window width.

Return value

X coordinate of the window.

int engine.interface.getCenterPositionY (int height)

Returns the coordinate along the Y axis, at which the window of the given height will be positioned in the center of the screen.
Notice
The function won't return a value in the following cases:
  • If the parent flag of the interface window is set to 0.
  • If the window is hidden.
  • If the window is not focused.
  • If the window is not an instance of the WidgetWindow class.

Arguments

  • int height - Window height.

Return value

Y coordinate of the window.

int engine.interface.getHeight ()

Returns the screen space hight. If there are two monitors arranged vertically, the height of two monitors is returned.

Return value

Screen height.

int engine.interface.getMouseX ()

Returns the X-coordinate (in the screen space) of the mouse cursor.

Return value

X-coordinate of the mouse cursor.

int engine.interface.getMouseY ()

Returns the Y-coordinate (in the screen space) of the mouse cursor.

Return value

Y-coordinate of the mouse cursor.

int engine.interface.getNumScreens ()

Returns the number of available screens (monitors).

Return value

The number of screens.

int engine.interface.getNumWindows ()

Returns the number of Interface windows.

Return value

The number of Interface windows.

int engine.interface.getPositionX ()

Returns the X coordinate of the Interface window.

Return value

X coordinate of the window.

int engine.interface.getPositionY ()

Returns the Y coordinate of the Interface window.

Return value

Y coordinate of the window.

int engine.interface.getScreenHeight (int num)

Returns the height of the given screen (monitor).

Arguments

  • int num - Screen number.

Return value

Height of the screen.

int engine.interface.getScreenPositionX (int num)

Returns the position of the given screen (monitor) in a horizontal row in the screen space. If there are two monitors arranged horizontally, the X-coordinate position of the first monitor is 0 and of the second one, for example, 1280.

Arguments

  • int num - Screen number.

Return value

X-coordinate position of the screen.

int engine.interface.getScreenPositionY (int num)

Returns the position of the given screen (monitor) in a vertical column in the screen space. If there are two monitors arranged vertically, the Y-coordinate position of the first monitor is 0 and of the second one, for example, 1024.

Arguments

  • int num - Screen number.

Return value

Y-coordinate position of the screen.

int engine.interface.getScreenWidth (int num)

Returns the width of the given screen (monitor).

Arguments

  • int num - Screen number.

Return value

Width of the screen.

int engine.interface.getVisiblePositionX (int x, int width, int border_x)

Checks if the window of the given width is visible on a screen with the specified border at the given coordinate. If the window is visible, its position will remain the same. Otherwise, it will be updated in order to make the window visible (taking into account the size of the vertical border).

Arguments

  • int x - X coordinate in the screen space.
  • int width - Window width.
  • int border_x - Horizontal border size.

Return value

The given X coordinate if the window is visible; otherwise, the X coordinate, at which the window will be visible.

int engine.interface.getVisiblePositionY (int y, int height, int border_y)

Checks if the window of the given height is visible on a screen with the specified border at the given coordinate. If the window is visible, its position will remain the same. Otherwise, it will be updated in order to make the window visible (taking into account the size of the vertical border).

Arguments

  • int y - Y coordinate in the screen space.
  • int height - Window height.
  • int border_y - Vertical border size.

Return value

The given Y coordinate if the window is visible; otherwise, the Y coordinate, at which the window will be visible.

int engine.interface.getWidth ()

Returns the screen space width. If there are two monitors arranged horizontally, the width of two monitors is returned.

Return value

Screen width.

InterfaceWindow engine.interface.getWindow (int num)

Returns an Interface window by its number.

Arguments

  • int num - Interface window number.

Return value

Interface window.

void engine.interface.setMouse (int x, int y)

Sets position (in screen space coordinates) of the mouse.

Arguments

  • int x - X-coordinate of the mouse cursor.
  • int y - Y-coordinate of the mouse cursor.
Last update: 2017-07-03