This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

WidgetExternBase Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits: Base

The base class, from which custom user-defined widgets are inherited.

See Also#

  • C++ API sample <UnigineSDK>/source/samples/Api/Widgets/WidgetExtern

WidgetExternBase Class

Members


int getClassID ( ) #

Returns a unique class ID.

Return value

Unique class ID.

Gui getGui ( ) #

Returns the Gui smart pointer.

Return value

Gui smart pointer.

int getKeyActivity ( unsigned int key ) #

Checks the keyboard key.

Arguments

  • unsigned int key - Key code.

Return value

Returns 1 if the key is used by widget.

Widget getWidget ( ) #

Returns the Widget smart pointer.

Return value

Widget smart pointer.

WidgetExtern getWidgetExtern ( ) #

Returns the WidgetExtern smart pointer.

Return value

WidgetExtern smart pointer.

void arrange ( ) #

Calculates the widget size.

void checkCallbacks ( int x, int y ) #

Checks widget callbacks.

Arguments

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

void destroy ( ) #

Destroys the widget resources.

void expand ( int width, int height ) #

Expands the widget size.

Arguments

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

void keyPress ( unsigned int key ) #

Keyboard press event.

Arguments

  • unsigned int key - Key code.

void render ( ) #

Renders the widget.

void update ( float ifps ) #

Widget update function.

Arguments

  • float ifps - Inverse FPS value.
Last update: 2020-07-31
Build: ()