This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
专业(SIM)
UnigineEditor
界面概述
资源工作流程
版本控制
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
材质和着色器
Rebuilding the Engine Tools
GUI
VR Development
双精度坐标
应用程序接口
Animations-Related Classes
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
VR-Related Classes
创建内容
内容优化
材质
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

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: 2023-12-19
Build: ()