This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

WidgetHitTestArea 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 UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits from: Widget

This class is used to define the widget area in engine-style windows and borderless system windows intersected by a user-controlled cursor. If the hit test area type is "resize", the system automatically changes the cursor shape, if the hit test area is draggable, the window can be dragged by clicking and dragging this area.

In the following example, the system borders of the main window are disabled and 2 custom drag areas are added. The first area is located at the top of the window and the second area is in its center. For demonstration purposes, the background is enabled for both areas.

WidgetHitTestArea Class

Members


WidgetHitTestArea ( Gui gui, int hit_test ) #

Constructor. Creates a hit test area widget and adds it to the specified GUI.

Arguments

  • Gui gui - GUI, to which the hit test area widget belongs.
  • int hit_test

WidgetHitTestArea ( int hit_test ) #

Constructor. Creates a hit test area widget of the specified type.

Arguments

  • int hit_test

int getHitTestResult ( ) #

Returns the current hit test area type.

Return value

void setBackground ( int background ) #

Enables rendering of the background for the drag area for debug purposes.

Arguments

  • int background - 1 to enable background rendering, 0 to disable it.

int getBackground ( ) #

Returns the flag indicating if background rendering is enabled or disabled for the drag area.

Return value

1 if background rendering is enabled; otherwise, 0.

void setBackgroundColor ( vec4 color ) #

Sets a color for the background of the drag area for debug purposes.

Arguments

  • vec4 color - Background color.

vec4 getBackgroundColor ( ) #

Returns the color of the drag area background.

Return value

Background color.
Last update: 2023-05-25
Build: ()