Unigine::WidgetExternBase Class
Header: | #include <UnigineWidgets.h> |
Inherits from: | 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.Ptr<Gui> getGui ( ) const#
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.Ptr<Widget> getWidget ( ) const#
Returns the Widget smart pointer.Return value
Widget smart pointer.Ptr<WidgetExtern> getWidgetExtern ( ) const#
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 (scan code).Arguments
- unsigned int key - Key code.
void textPress ( unsigned int unicode ) #
Keyboard press event (virtual key).Arguments
- unsigned int unicode - Virtual key code.
void update ( float ifps ) #
Widget update function.Arguments
- float ifps - Inverse FPS value.
void preRender ( ) #
Widget pre-render function executed after the update() and before the render() function. This method is used to make necessary preparations for rendering (e.g. prepare a texture) after the update() and is called automatically for WidgetSpriteViewport and WidgetSpriteNode to ensure proper rendering of the widgets during render(). In case you implement a custom GUI or widgets using the WidgetExtern class you should put all such rendering preparations to this method and call Gui::preRender()preRender() manually after update().void render ( ) #
Renders the widget.void updatePositions ( ) #
Updates the widget's screen coordinates. This function is called after the arrange() and expand() functions.Last update:
2024-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)