This page has been translated automatically.
Setting Up Development Environment
High-Level Systems
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Core Library
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes
This version of documentation is OUTDATED! Please switch to the latest one.

WidgetExternBase Class

Unigine Base WidgetExtern class.

To use this class, include the UnigineWidgetExtern.h file.

WidgetExternBase Class


int isOwner ()

Returns the owner flag of the pointer. If the pointer is owner, on its deletion the object also will be deleted.

Return value

The owner flag.

void grab ()

Sets the owner flag to 1 for the widget pointer. The widget should not be handled by the class after this function is called.

Ptr<Gui> getGui ()

Returns the Gui smart pointer.

Return value

Gui smart pointer.

void update (float ifps)

Widget update function.


  • float ifps - Inverse FPS value.

void render ()

Renders the widget.

void destroy ()

Destroys the widget resources.

void arrange ()

Calculates the widget size.

Ptr<Widget> getWidget ()

Returns the Widget smart pointer.

Return value

Widget smart pointer.

void keyPress (unsigned int key)

Keyboard press event.


  • unsigned int key - Key code.

int getKeyActivity (unsigned int key)

Checks the keyboard key.


  • unsigned int key - Key code.

Return value

Returns 1 if the key is used by widget.

int getClassID ()

Returns a unique class ID.

Return value

Unique class ID.

void release ()

Sets the owner flag to 0 for the widget pointer. The widget should be handled by the class after this function is called.

void checkCallbacks (int x, int y)

Checks widget callbacks.


  • int x - Mouse X coordinate.
  • int y - Mouse Y coordinate.

void expand (int width, int height)

Expands the widget size.


  • int width - Maximum available width.
  • int height - Maximum available height.

Ptr<WidgetExtern> getWidgetExtern ()

Returns the WidgetExtern smart pointer.

Return value

WidgetExtern smart pointer.
Last update: 2017-07-03
Build: ()