This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
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
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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.

Unigine::WidgetDragArea Class

Header: #include <UnigineWidgets.h>
Inherits from: Widget

This class creates a custom drag area.

A window can have system borders or be borderless. The first one can be dragged by the window title bar. And the borderless window requires the special drag area created by means of the WidgetDragArea class: when the mouse cursor is in this area, the window can be dragged.

Also this widget is a part of the WidgetWindow: it is added to the window title by default and can be resized if necessary.

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
	EngineWindowPtr 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);

		WidgetDragAreaPtr top_drag_area = WidgetDragArea::create(gui);
		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
		WidgetDragAreaPtr drag_area = WidgetDragArea::create(gui);
		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;
}

WidgetDragArea Class

Members


WidgetDragArea ( const Ptr<Gui> & gui ) #

Constructor. Creates a drag area and adds it to the specified GUI.

Arguments

  • const Ptr<Gui> & gui - GUI, to which the drag area will belong.

WidgetDragArea ( ) #

Default constructor.

void setBackground ( int background ) #

Enables/disables rendering of the background for the drag area.

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.

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: 2022-12-14
Build: ()