Unigine::EngineWindowViewport Class

// create an engine window of the specified size with the specified name
EngineWindowViewportPtr window = EngineWindowViewport::create("New window", 580, 300);

// set the window viewport as the main one
window->setMain(true);

// enable the console, profiler and visualizer for the window viewport
window->setConsoleUsage(true);
window->setProfilerUsage(true);
window->setVisualizerUsage(true);

// add widgets to the client area
window->addChild(WidgetLabel::create(window->getSelfGui(), String::format("This is %s window.", window->getTitle())));
window->addChild(WidgetButton::create(window->getSelfGui(), window->getTitle()), Gui::ALIGN_CENTER);

EngineWindowViewport Class

Members

Ptr<Viewport> getViewport() const#

Return value

Current window viewport.

void setCamera ( const Ptr<Camera>& camera ) #

Arguments

• const Ptr<Camera>& camera - The camera the image from which is rendered to the engine window.

Ptr<Camera> getCamera() const#

Return value

Current camera the image from which is rendered to the engine window.

void setMain ( bool main ) #

Arguments

• bool main - Set true to enable the window as the main window; false - to disable it.

bool isMain() const#

Return value

true if the window as the main window; otherwise false.

void setConsoleUsage ( bool usage ) #

Arguments

• bool usage - Set true to enable the console display for the window currently in focus; false - to disable it.

bool isConsoleUsage() const#

Return value

true if the console display for the window currently in focus is enabled; otherwise false.

void setProfilerUsage ( bool usage ) #

Arguments

• bool usage - Set true to enable the profiler display for the window currently in focus; false - to disable it.

bool isProfilerUsage() const#

Return value

true if the profiler display for the window currently in focus is enabled; otherwise false.

void setVisualizerUsage ( bool usage ) #

Arguments

• bool usage - Set true to enable the visualizer display for the window currently in focus; false - to disable it.

bool isVisualizerUsage() const#

Return value

true if the visualizer display for the window currently in focus is enabled; otherwise false.

void setSkipRenderEngine ( bool engine ) #

Arguments

• bool engine - true to disable Engine rendering; false to enable it.

bool isSkipRenderEngine() const#

Return value

true to disable Engine rendering; false to enable it.

bool isFullscreen() const#

Return value

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

void setMouseGrab ( bool grab ) #

Arguments

• bool grab - Set true to enable the pointer cannot leave the engine window viewport; false - to disable it.

bool isMouseGrab() const#

Return value

true if the pointer cannot leave the engine window viewport; otherwise false.

int getNumChildren() const#

Return value

Current total number of children widgets of the engine window.

Event<const Ptr<EngineWindowViewport> &> getEventCustomRender() const#

The event handler signature is as follows: myhandler(const Ptr<EngineWindowViewport> & viewport)

Return value

Event reference.

void setAspectCorrection ( bool correction ) #

Arguments

• bool correction - Set true to enable the aspect correction; false - to disable it.

bool isAspectCorrection() const#

Return value

true if the aspect correction is enabled; otherwise false.

---

static EngineWindowViewportPtr create ( const Math::ivec2 & size, int flags = 0 ) #

Constructor. Creates the window viewport of the specified size with the specified flags.

Arguments

• const Math::ivec2 & size - Window size (width and height).
• int flags - Mask containing window flags.

static EngineWindowViewportPtr create ( int width, int height, int flags = 0 ) #

Constructor. Creates the window viewport of the specified size with the specified flags.

Arguments

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

static EngineWindowViewportPtr create ( const char * window_title, int width, int height, int flags = 0 ) #

Constructor. Creates the window viewport of the specified size with the specified title and flags.

Arguments

• const char * 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 disableFullscreen ( ) #

Disables the fullscreen mode for the window in the fullscreen mode and sets the focus to this window. States and positions of other windows are restored.

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

Enables the specified fullscreen mode for the specified display. The states of other displayed windows are stored in order to restore their states and positions when the fullscreen mode is disabled. A nested window will be withdrawn from the group if set to fullscreen.

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 addChild ( const Ptr<Widget> & widget, int flags = -1 ) #

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

Arguments

• const Ptr<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 ( const Ptr<Widget> & widget ) #

Removes the specified widget from the engine window.

Arguments

• const Ptr<Widget> & widget - Child widget to be removed.

Ptr<Widget> getChild ( int index ) #

Returns the child widget by its index.

Arguments

• int index - Widget index.

Return value

Child widget.

bool isChild ( const Ptr<Widget> & widget ) #

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

Arguments

• const Ptr<Widget> & widget - Widget.

Return value

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