Unigine::WidgetHitTestArea Class
| Header: | #include <UnigineWidgets.h> |
| 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.
AppSystemLogic.cpp
Source code (C++)
#include "AppSystemLogic.h"
#include <UnigineWindowManager.h>
using namespace Unigine;
int AppSystemLogic::init()
{
// borderless main window
EngineWindowViewportPtr main_window = WindowManager::getMainWindow();
if (main_window)
{
// disable system borders
main_window->setBordersEnabled(false);
GuiPtr gui = main_window->getSelfGui();
// add a drag area similar to title bar
WidgetVBoxPtr top_drag_container = WidgetVBox::create(gui);
main_window->addChild(top_drag_container);
WidgetHitTestAreaPtr top_drag_area = WidgetHitTestArea::create(gui, EngineWindow::HITTEST_DRAGGABLE);
top_drag_area->setHeight(25);
top_drag_container->addChild(top_drag_area, Gui::ALIGN_EXPAND);
top_drag_area->setBackground(1);
top_drag_area->setBackgroundColor(Math::vec4_red);
// add an extra drag area
WidgetHitTestAreaPtr drag_area = WidgetHitTestArea::create(gui, EngineWindow::HITTEST_DRAGGABLE);
drag_area->setWidth(512);
drag_area->setHeight(256);
main_window->addChild(drag_area, Gui::ALIGN_CENTER);
drag_area->setBackground(1);
drag_area->setBackgroundColor(Math::vec4_blue);
}
return 1;
}WidgetHitTestArea Class
Members
WidgetHitTestArea ( const Ptr<Gui> & gui, int hit_test ) #
Constructor. Creates a hit test area widget and adds it to the specified GUI.Arguments
WidgetHitTestArea ( int hit_test ) #
Constructor. Creates a hit test area widget of the specified type.Arguments
- int hit_test - Hit test area type, one of the HITTEST_* values.
int getHitTestResult ( ) const#
Returns the current hit test area type.Return value
The hit test area type, one of the HITTEST_* values.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 ( ) const#
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 ( const Math::vec4 & color ) #
Sets a color for the background of the drag area for debug purposes.Arguments
- const Math::vec4 & color - Background color.
Math::vec4 getBackgroundColor ( ) const#
Returns the color of the drag area background.Return value
Background color.Last update:
2023-12-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)