Unigine::Widget Class

Header:

#include <UnigineWidgets.h>

This base class is used to create graphical user interface widgets of different types.

Methods:

Name	Description View: Sort by:
setData	Sets user data associated with the widget.
getData	Returns user data associated with the widget.
setEnabled	Enables or disables the widget.
isEnabled	Returns a value indicating if the widget is enabled.
setFlags	Sets widget flags.
getFlags	Returns widget flags.
setFontColor	Sets a font color that will be used to render text on the widget.
getFontColor	Returns the color of the font used by the widget.
setFontHOffset	Sets the horizontal offset of the font used by the widget.
getFontHOffset	Returns the horizontal offset of the font used by the widget.
setFontHSpacing	Sets the spacing (in pixels) between widget text characters.
getFontHSpacing	Returns the spacing (in pixels) between widget text characters.
setFontOutline	Sets a value indicating if widget text should be rendered casting a shadow.
getFontOutline	Returns a value indicating if widget text is rendered casting a shadow.
setFontPermanent	Sets a flag to prevent color change for the widget text (for example, when the widget becomes non-active or loses focus).
getFontPermanent	Returns a flag indicating if color of the widget text is not changed (for example, when the widget becomes non-active or loses focus).
setFontRich	Sets a value indicating if rich text formatting should be used.
getFontRich	Returns a value indicating if rich text formatting is used.
setFontSize	Sets a font size that will be used to render text on the widget.
getFontSize	Returns the size of the font used by the widget.
setFontVOffset	Sets the vertical offset of the font used by the widget.
getFontVOffset	Returns the vertical offset of the font, used by the widget.
setFontVSpacing	Sets the spacing (in pixels) between widget text lines.
getFontVSpacing	Returns the spacing (in pixels) between widget text lines.
setFontWrap	Enables or disables text wrapping to widget width.
getFontWrap	Returns a value indicating if text wrapping to widget width is enabled.
getGui	Returns a Gui instance that currently renders the widget.
setHeight	Sets the minimal height of the widget, in pixels.
getHeight	Returns the current widget height ,in pixels.
setHidden	Hides or shows the widget.
isHidden	Returns a value indicating if the widget is hidden.
setMouseCursor	Sets a mouse pointer to display over a widget.
getMouseCursor	Returns the type of mouse pointer displayed over a widget.
getMouseX	Returns the X coordinate of the mouse pointer position on the screen.
getMouseY	Returns the Y coordinate of the mouse pointer position on the screen.
setNextFocus	Sets a widget which will be focused next if the user presses TAB.
getNextFocus	Returns a widget which will be focused next if the user presses TAB.
getNumChildren	Returns the number of children of the widget.
setOrder	Sets rendering order (Z-order) for the widget.
getOrder	Returns rendering order (Z-order) for the widget.
setParent	Sets a parent widget for the current one.
getParent	Returns the pointer to the parent widget.
getParentGui	Returns a Gui instance that currently renders the widget's parent, if the widget has a parent.
getPositionX	Returns the X coordinate of the widget position relative to its parent.
getPositionY	Returns the Y coordinate of the widget position relative to its parent.
getScreenPositionX	Returns the screen position of the widget (its top left corner) on the screen along the X axis.
getScreenPositionY	Returns the screen position of the widget (its top left corner) on the screen along the Y axis.
getType	Returns the type of the widget.
getTypeName	Returns the name of the widget type.
setWidth	Sets the minimal width of the widget, in pixels.
getWidth	Returns the current widget width, in pixels.
setIntersectionEnabled	Sets a value indicating if intersection detection is enabled for the widget.
isIntersectionEnabled	Returns a value indicating if intersection detection is enabled for the widget.
isCallback	Returns a value indicating if there are any callbacks of the specified type set for the widget.
addCallback	Adds a callback function of the specified type for the widget.
removeCallback	Removes the specified callback from the list of callbacks of the specified type added for the widget.
clearCallbacks	Clears all callbacks of the specified type added for the widget.
setCallbackAccel	Assigns a hot key combination to a given callback function.
getCallbackAccel	Gets the current hot key combination for a given callback function.
isCallbackAccel	Checks if the given key in combination with CTRL, ALT, or/and SHIFT buttons is assigned as a widget callback.
setCallbackEnabled	Enables or disables a given callback function.
isCallbackEnabled	Returns a value indicating if a given callback is enabled.
getChild	Returns the widget child by its number.
isChild	Checks if a given widget is a child of the current widget.
setFocus	Sets focus on the widget.
isFocused	Returns a value indicating if the widget is in focus.
setFont	Sets a font that will be used to render text on the widget.
getIntersection	Checks for an intersection with the widget's bounds for the given point.
getKeyActivity	Checks if a given key already has a special purpose for the widget.
setPermanentFocus	Sets permanent focus on the widget (it means that the widget is always in focus).
setPosition	Sets a position of the widget relative to its parent.
setToolTip	Sets a tooltip for the widget.
getToolTip	Returns the widget's tooltip text.
addAttach	Attaches a given widget to the current one.
addChild	Adds a child to the widget.
arrange	Rearranges the widget and its children to lay them out neatly.
raise	Brings a given widget to the top.
removeAttach	Detaches a given widget from the current one.
removeChild	Removes a child widget from the list of the widget's children.
removeFocus	Removes focus from the widget.
replaceChild	Replaces one child widget with another.
runCallback	Runs a given callback function.

Widget Class

Enums

TYPE#

Name	Description
WIDGET_VBOX = 0	Vertical box. See also: WidgetVBox.
WIDGET_HBOX = 1	Horizontal box. See also: WidgetHBox.
WIDGET_VPANED = 3	Vertical box that allows resizing of its children. See also: WidgetVPaned.
WIDGET_HPANED = 4	Horizontal box that allows resizing of its children. See also: WidgetHPaned.
WIDGET_LABEL = 5	Text label. See also: WidgetLabel.
WIDGET_BUTTON = 6	Simple button. See also: WidgetButton.
WIDGET_EDIT_LINE = 7	Text field. See also: WidgetEditline.
WIDGET_EDIT_TEXT = 8	Multiline text field. See also: WidgetEdittext.
WIDGET_CHECK_BOX = 9	Checkbox. See also: WidgetCheckbox.
WIDGET_COMBO_BOX = 10	Combobox. See also: WidgetCombobox.
WIDGET_CANVAS = 11	Canvas widget for drawing text, lines and polygons. See also: WidgetCanvas.
WIDGET_GROUP_BOX = 12	Group box. See also: WidgetGroupBox.
WIDGET_GRID_BOX = 2	Grid box. See also: WidgetGridBox.
WIDGET_LIST_BOX = 13	List box. See also: WidgetListBox.
WIDGET_TREE_BOX = 14	Tree box. See also: WidgetTreeBox.
WIDGET_TAB_BOX = 15	Tabbed box. See also: WidgetTabBox.
WIDGET_SCROLL = 16	A scrollbar: horizontal or vertical one. See also: WidgetScroll.
WIDGET_SCROLL_BOX = 17	Box with scrolling. See also: WidgetScrollBox.
WIDGET_SPACER = 18	Spacer: horizontal or vertical one. See also: WidgetSpacer.
WIDGET_SLIDER = 19	A slider: horizontal or vertical one. See also: WidgetSlider.
WIDGET_SPIN_BOX = 20	Spinbox. See also: WidgetSpinBox.
WIDGET_SPIN_BOX_DOUBLE = 21	Spinbox with double values. See also: WidgetSpinBoxDouble.
WIDGET_ICON = 22	Icon. See also: WidgetIcon.
WIDGET_SPRITE = 23	Sprite. See also: WidgetSprite.
WIDGET_SPRITE_VIDEO = 24	Video Sprite. See also: WidgetSpriteVideo.
WIDGET_SPRITE_SHADER = 25	Shader Sprite. See also: WidgetSpriteShader.
WIDGET_SPRITE_VIEWPORT = 26	Viewport Sprite. See also: WidgetSpriteViewport.
WIDGET_SPRITE_NODE = 27	Node Sprite. See also: WidgetSpriteNode.
WIDGET_MENU_BAR = 28	Menu bar. See also: WidgetMenuBar.
WIDGET_MENU_BOX = 29	Menu. See also: WidgetMenuBox.
WIDGET_WINDOW = 30	Window. See also: WidgetWindow.
WIDGET_DIALOG = 31	Dialog window. See also: WidgetDialog.
WIDGET_DIALOG_MESSAGE = 32	Message Dialog. See also: WidgetDialogMessage.
WIDGET_DIALOG_FILE = 33	File Dialog. See also: WidgetDialogFile.
WIDGET_DIALOG_COLOR = 34	Color Dialog. See also: WidgetDialogColor.
WIDGET_DIALOG_IMAGE = 35	Image Dialog. See also: WidgetDialogImage.
WIDGET_MANIPULATOR = 36	Manipulator widget. See also: WidgetManipulator.
WIDGET_MANIPULATOR_TRANSLATOR = 37	Translator Manipulator. See also: WidgetManipulatorTranslator.
WIDGET_MANIPULATOR_ROTATOR = 38	Rotator Manipulator. See also: WidgetManipulatorRotator.
WIDGET_MANIPULATOR_SCALER = 39	Scaler Manipulator. See also: WidgetManipulatorScaler.
WIDGET_EXTERN = 40	External widget.
WIDGET_ENGINE = 41	Engine-specific widget (manipulator). See also: WidgetManipulator.
NUM_WIDGETS = 42	Total number of widget types.

Members

bool isCallback ( int callback ) const#

Returns a value indicating if there are any callbacks of the specified type set for the widget.

Arguments

int callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

Return value

true if at least one callback of the specified type is set for the widget; otherwise, false.

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase * func ) #

Adds a callback function of the specified type for the widget.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name();

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase1< Ptr<Widget> > * func ) #

Adds a callback function of the specified type for the widget.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr sender);

sender - the widget that caused the callback function to be called, i.e. the one on which the action took place (e.g. a button, that was clicked).

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase1< Ptr<Widget> > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func ) #

Adds a callback function of the specified type for the widget.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr sender, WidgetPtr pointer);

sender - the widget that caused the callback function to be called, i.e. the one on which the action took place (e.g. a button, that was clicked).
pointer - this parameter is used to identify a target widget of a Drag-and-Drop operation. You can find an example in the widgets/sprite_03 UnigineScript sample included in the SDK.

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func ) #

Adds a callback function of the specified type for the widget.The signature of the callback function must be as follows:

Source code (C++)

void callback_function_name(WidgetPtr sender, WidgetPtr pointer, int data);

sender - the widget that caused the callback function to be called, i.e. the one on which the action took place (e.g. a button, that was clicked).
pointer - this parameter is used to identify a target widget of a Drag-and-Drop operation. You can find an example in the widgets/sprite_03 UnigineScript sample included in the SDK.
data - this parameter is used for getting mouse or keyboard button state, when a widget is clicked or pressed (callbacks: CLICKED, PRESSED, KEY_PRESSED).

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func - Callback pointer.

Return value

ID of the last added callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

bool removeCallback ( Gui::CALLBACK_INDEX callback, void * id ) #

Removes the specified callback from the list of callbacks of the specified type added for the widget.

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).
void * id - Callback ID obtained when adding it.

Return value

True if the callback with the given ID was removed successfully; otherwise false.

void clearCallbacks ( Gui::CALLBACK_INDEX callback ) #

Clears all callbacks of the specified type added for the widget.

Arguments

Gui::CALLBACK_INDEX callback - Callback type number. One of the callbacks defined in the Gui class (for example, CLICK, SHOW, HIDE, etc).

void setCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int key, int ctrl, int alt, int shift ) #

Assigns a hot key combination to a given callback function.

Arguments

Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
unsigned int key - ASCII key code: one of the App:: Enumeration with KEY_* prefixes.
int ctrl - CTRL key modifier.
int alt - ALT key modifier.
int shift - SHIFT key modifier.

bool getCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int & key, int & ctrl, int & alt, int & shift ) const#

Gets the current hot key combination for a given callback function.

Arguments

Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
unsigned int & key - ASCII key code: one of the App:: Enumeration with KEY_* prefixes.
int & ctrl - CTRL key modifier.
int & alt - ALT key modifier.
int & shift - SHIFT key modifier.

Return value

true if the specified callback type exists; otherwise, false.

int isCallbackAccel ( unsigned int key, int ctrl, int alt, int shift ) const#

Checks if the given key in combination with CTRL, ALT, or/and SHIFT buttons is assigned as a widget callback.

Arguments

unsigned int key - One of the standard ASCII keycodes or one of the APP_KEY_* pre-defined variables.
int ctrl - 1 if the CTRL key modifier is used; otherwise, 0.
int alt - 1 if the ALT key modifier is used; otherwise, 0.
int shift - 1 if the SHIFT key modifier is used; otherwise, 0.

Return value

1 if it is used in combinations; otherwise, 0.

void setCallbackEnabled ( Gui::CALLBACK_INDEX callback, bool enabled ) #

Enables or disables a given callback function.

Arguments

Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).
bool enabled - 1 to enable the callback, 0 to disable it.

int isCallbackEnabled ( Gui::CALLBACK_INDEX callback ) const#

Returns a value indicating if a given callback is enabled.

Arguments

Gui::CALLBACK_INDEX callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

Return value

Returns 1 if the callback is disabled; otherwise, 0.

Ptr<Widget> getChild ( int num ) const#

Returns the widget child by its number.

Arguments

int num - Number of the child widget.

Return value

Pointer to the child widget.

int isChild ( const Ptr<Widget> & w ) const#

Checks if a given widget is a child of the current widget.

Arguments

const Ptr<Widget> & w - Widget to check.

Return value

Returns 1 if the given widget is a child; otherwise, 0.

void setData ( const char * data ) #

Sets user data associated with the widget.

Arguments

const char * data - string data. Data can be an xml formatted string.

const char * getData ( ) const#

Returns user data associated with the widget.

Return value

User string data. Data can be an xml formatted string.

void setEnabled ( bool enabled ) #

Enables or disables the widget.

Arguments

bool enabled - 1 to enable the widget, 0 to disable it.

bool isEnabled ( ) const#

Returns a value indicating if the widget is enabled.

Return value

Returns 1 if the widget is disabled; otherwise, 0.

void setFlags ( int flags ) #

Sets widget flags.

Arguments

int flags - flags.

int getFlags ( ) const#

Returns widget flags.

Return value

Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void setFocus ( ) #

Sets focus on the widget.

int isFocused ( ) const#

Returns a value indicating if the widget is in focus.

Return value

1 if the widget is in focus; otherwise, 0.

void setFont ( const char * name ) #

Sets a font that will be used to render text on the widget.

Arguments

const char * name - Path to the font file (*.ttf).

void setFontColor ( const Math::vec4 & color ) #

Sets a font color that will be used to render text on the widget.

Arguments

const Math::vec4 & color - Font color.

Math::vec4 getFontColor ( ) const#

Returns the color of the font used by the widget.

Return value

Font color.

void setFontHOffset ( int hoffset ) #

Sets the horizontal offset of the font used by the widget.

Arguments

int hoffset - Horizontal offset value in pixels.

int getFontHOffset ( ) const#

Returns the horizontal offset of the font used by the widget.

Return value

Horizontal offset value in pixels.

void setFontHSpacing ( int hspacing ) #

Sets the spacing (in pixels) between widget text characters.

Arguments

int hspacing - Horizontal spacing value.

int getFontHSpacing ( ) const#

Returns the spacing (in pixels) between widget text characters.

Return value

Horizontal spacing value.

void setFontOutline ( int outline ) #

Sets a value indicating if widget text should be rendered casting a shadow. Positive or negative values set the distance in pixels to offset the font outline. The default is 0 (no outlining).

Arguments

int outline - Outline offset:
- Positive values set offset in the bottom-right corner direction.
- Negative values set offset in the top-left corner direction (the outline will overlap widget text).
- 0 is not to use font outlining.

int getFontOutline ( ) const#

Returns a value indicating if widget text is rendered casting a shadow. Positive or negative values determine the distance in pixels used to offset the font outline.

Return value

Positive value if outline is offset in the bottom-right corner direction. Negative value if outline is offset in the top-left corner direction. 0 if font is not outlined.

void setFontPermanent ( int permanent ) #

Sets a flag to prevent color change for the widget text (for example, when the widget becomes non-active or loses focus).

Arguments

int permanent - 1 not to change text color; 0 to change it.

int getFontPermanent ( ) const#

Returns a flag indicating if color of the widget text is not changed (for example, when the widget becomes non-active or loses focus).

Return value

1 if color of the widget text is not changed; otherwise, 0.

void setFontRich ( int rich ) #

Sets a value indicating if rich text formatting should be used. The default is 0.

Arguments

int rich - 1 to use rich text formatting, 0 to use plain text formatting.

int getFontRich ( ) const#

Returns a value indicating if rich text formatting is used.

Return value

1 if rich text formatting is used; otherwise, 0.

void setFontSize ( int size ) #

Sets a font size that will be used to render text on the widget.

Arguments

int size - Font size in pixels.

int getFontSize ( ) const#

Returns the size of the font used by the widget.

Return value

Font size.

void setFontVOffset ( int voffset ) #

Sets the vertical offset of the font used by the widget.

Arguments

int voffset - Vertical offset value, in pixels.

int getFontVOffset ( ) const#

Returns the vertical offset of the font, used by the widget.

Return value

Vertical offset value, in pixels.

void setFontVSpacing ( int vspacing ) #

Sets the spacing (in pixels) between widget text lines.

Arguments

int vspacing - Vertical spacing value.

int getFontVSpacing ( ) const#

Returns the spacing (in pixels) between widget text lines.

Return value

Vertical spacing value.

void setFontWrap ( int wrap ) #

Enables or disables text wrapping to widget width.

Arguments

int wrap - 1 to enable text wrapping, 0 to disable it. The default is 0.

int getFontWrap ( ) const#

Returns a value indicating if text wrapping to widget width is enabled.

Return value

1 if text wrapping is enabled; otherwise, 0.

Ptr<Gui> getGui ( ) const#

Returns a Gui instance that currently renders the widget. (This function can be used if the widget is created and used in two different GUIs, for example, in case of the Interface plugin.) It can be called only by root widgets. For child widgets, see getParentGui().

Return value

Current GUI instance used for the widget.

void setHeight ( int height ) #

Sets the minimal height of the widget, in pixels.

Notice

The widget cannot be smaller than its content (the texture, video, etc.). With setHeight() and setWidth() functions, it is only possible to make the widget bigger then the size of its content. For example, WidgetButton can be made bigger than its texture, but it cannot be made any smaller than the texture dimensions.

Arguments

int height - Widget's minimal height. If a negative value is provided, the 0 will be used instead.

int getHeight ( ) const#

Returns the current widget height ,in pixels.

Notice

You may need to call arrange() first, if you have added a new widget and want to get its height in the same frame. Otherwise, zero will be returned.

Return value

Widget's height, in pixels.

void setHidden ( bool hidden ) #

Hides or shows the widget. When a widget is hidden, space occupied by it is left empty, and other widgets are not re-arranged.

Arguments

bool hidden - true to hide the widget, false to render it.

bool isHidden ( ) const#

Returns a value indicating if the widget is hidden. When a widget is hidden, space occupied by it is left empty, and other widgets are not re-arranged.

Return value

true if the widget is hidden; otherwise, false.

int getIntersection ( int x, int y ) const#

Checks for an intersection with the widget's bounds for the given point.

Arguments

int x - Local X coordinate.
int y - Local Y coordinate.

Return value

1 if the input coordinate is inside the widget; otherwise, 0.

int getKeyActivity ( unsigned int key ) const#

Checks if a given key already has a special purpose for the widget.

Arguments

unsigned int key - ASCII key code: one of the KEY_* pre-defined variables.

Return value

1 if the key cannot be used; otherwise, 0.

void setMouseCursor ( int cursor ) #

Sets a mouse pointer to display over a widget.

Arguments

int cursor - Mouse pointer. See the list of available pointers with CURSOR_* prefixes in the article on Gui class functions.

int getMouseCursor ( ) const#

Returns the type of mouse pointer displayed over a widget.

Return value

Mouse pointer. One of the available pointers with CURSOR_* prefixes described in the article on Gui class functions.

int getMouseX ( ) const#

Returns the X coordinate of the mouse pointer position on the screen.

Return value

X coordinate of the mouse pointer position.

int getMouseY ( ) const#

Returns the Y coordinate of the mouse pointer position on the screen.

Return value

Y coordinate of the mouse pointer position.

void setNextFocus ( const Ptr<Widget> & focus ) #

Sets a widget which will be focused next if the user presses TAB.

Arguments

const Ptr<Widget> & focus - Next widget.

Ptr<Widget> getNextFocus ( ) const#

Returns a widget which will be focused next if the user presses TAB.

Return value

Next widget.

int getNumChildren ( ) const#

Returns the number of children of the widget.

Return value

Number of child widgets.

void setOrder ( int order ) #

Sets rendering order (Z-order) for the widget. The higher the value, the higher the order of the widget will be.

Notice

Works only for widgets added to GUI via the Gui::addChild() function with the Gui::ALIGN_OVERLAP flag specified (should not be Gui::ALIGN_FIXED).

Source code (C++)

Unigine::Vector<Unigine::WidgetSpritePtr> sprites;

int AppWorldLogic::init()
{
	// create 3 squares with different colors
	for (int i = 0; i < 3; i++)
	{
		WidgetSpritePtr &sprite = sprites.append();
		sprite = WidgetSprite::create(Gui::get(), "white.dds");
		sprite->setPosition(i * 40 + 50, i * 40 + 50);
		sprite->setWidth(100);
		sprite->setHeight(100);
		Gui::get()->addChild(sprite, Gui::ALIGN_OVERLAP);
	}

	sprites[0]->setColor(vec4(1, 0.3f, 0.3f, 1));
	sprites[1]->setColor(vec4(0.3f, 1, 0.3f, 1));
	sprites[2]->setColor(vec4(0.3f, 0.3f, 1, 1));

	return 1;
}

int AppWorldLogic::update()
{
	// press space key to random reorder squares
	if (App::clearKeyState(' '))
	{
		for (int i = 0; i < 3; i++)
		{
			sprites[i]->setOrder(Game::getRandomInt(0, 10));
			
			Gui::get()->removeChild(sprites[i]);
			Gui::get()->addChild(sprites[i]);

			Log::message("%d ", sprites[i]->getOrder());
		}
		Log::message("\n");
	}
	return 1;
}

Arguments

int order - Rendering order (Z-order) of the widget, in the range [-128;127]. (126 for the Profiler, 127 for the Console).

int getOrder ( ) const#

Returns rendering order (Z-order) for the widget.

Return value

Rendering order (Z-order) of the widget, in the range [-128;127]. (126 for the Profiler, 127 for the Console).

void setParent ( const Ptr<Widget> & parent ) #

Sets a parent widget for the current one.

Arguments

const Ptr<Widget> & parent - Parent widget to set.

Ptr<Widget> getParent ( ) const#

Returns the pointer to the parent widget.

Return value

Parent widget smart pointer.

Ptr<Gui> getParentGui ( ) const#

Returns a Gui instance that currently renders the widget's parent, if the widget has a parent. (This function can be used if the widget is created and used in two different GUIs, for example, in case of the Interface plugin.)

Return value

Current GUI instance used for the widget's parent.

void setPermanentFocus ( ) #

Sets permanent focus on the widget (it means that the widget is always in focus).

void setPosition ( int x, int y ) #

Sets a position of the widget relative to its parent.

Arguments

int x - X coordinate of the upper left corner of the widget.
int y - Y coordinate of the upper left corner of the widget.

int getPositionX ( ) const#

Returns the X coordinate of the widget position relative to its parent.

Return value

Relative X coordinate.

int getPositionY ( ) const#

Returns the Y coordinate of the widget position relative to its parent.

Return value

Relative Y coordinate.

int getScreenPositionX ( ) const#

Returns the screen position of the widget (its top left corner) on the screen along the X axis.

Return value

Screen position along the X axis in pixels.

int getScreenPositionY ( ) const#

Returns the screen position of the widget (its top left corner) on the screen along the Y axis.

Return value

Screen position along the Y axis in pixels.

void setToolTip ( const char * str, int reset = 0 ) #

Sets a tooltip for the widget.

Arguments

const char * str - Tooltip text.
int reset - 1 to recalculate a tooltip location if the mouse cursor was relocated; otherwise - 0(by default).

const char * getToolTip ( ) const#

Returns the widget's tooltip text.

Return value

Tooltip text.

Widget::TYPE getType ( ) const#

Returns the type of the widget.

Return value

Widget type identifier.

const char * getTypeName ( ) const#

Returns the name of the widget type.

Return value

Widget type name.

void setWidth ( int width ) #

Sets the minimal width of the widget, in pixels.

Notice

Arguments

int width - Widget's minimal width. If a negative value is provided, the 0 will be used instead.

int getWidth ( ) const#

Returns the current widget width, in pixels.

Notice

You may need to call arrange() first, if you have added a new widget and want to get its width in the same frame. Otherwise, zero will be returned.

Return value

Widget width, in pixels.

void addAttach ( const Ptr<Widget> & w, const char * format = 0, int multiplier = 1, int flags = 0 ) #

Attaches a given widget to the current one. When applied to checkboxes, converts them into a group of radio buttons. A horizontal/vertical slider can be attached to a label or a text field. The text field can be attached to any of the sliders.

Arguments

const Ptr<Widget> & w - Widget to attach.
const char * format - Format string or values entered into the attached widget. If none specified, "%d" is implied. This is an optional parameter.
int multiplier - Multiplier value, which is used to scale values provided by the attached widget. This is an optional parameter.
int flags - Attachment flags: one of the Gui:: Enumeration with ATTACH_* prefixes. This is an optional parameter.

void addChild ( const Ptr<Widget> & w, int flags = 0 ) #

Adds a child to the widget.

Arguments

const Ptr<Widget> & w - Child widget.
int flags - Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void arrange ( ) #

Rearranges the widget and its children to lay them out neatly. This function forces to recalculate widget size and allows to get updated GUI layout data in the current frame. If this function is not called, widget modifications made in the current update() will be available only in the next frame (i.e. with one-frame lag), as GUI is calculated and rendered after the script update() function has been executed.

void raise ( const Ptr<Widget> & w ) #

Brings a given widget to the top.

Notice

Works only for widgets added to GUI via the Gui::addChild() function with the Gui::ALIGN_OVERLAP flag specified (should not be Gui::ALIGN_FIXED).

Arguments

const Ptr<Widget> & w - Widget to be brought up.

void removeAttach ( const Ptr<Widget> & w ) #

Detaches a given widget from the current one.

Arguments

const Ptr<Widget> & w - Widget to detach.

void removeChild ( const Ptr<Widget> & w ) #

Removes a child widget from the list of the widget's children.

Arguments

const Ptr<Widget> & w - Child widget smart pointer.

void removeFocus ( ) #

Removes focus from the widget.

void replaceChild ( const Ptr<Widget> & w, const Ptr<Widget> & old_w, int flags = 0 ) #

Replaces one child widget with another.

Arguments

const Ptr<Widget> & w - New child widget smart pointer.
const Ptr<Widget> & old_w - Widget to be replaced.
int flags - Widget flags: one of the Gui:: Enumeration with ALIGN_* prefixes. This is an optional parameter.

void runCallback ( int callback ) const#

Runs a given callback function.

Arguments

int callback - Callback number: one of the Gui:: Enumeration (for example, SHOW, HIDE, etc).

void setIntersectionEnabled ( bool enabled ) #

Sets a value indicating if intersection detection is enabled for the widget.

Arguments

bool enabled - true to enable intersection detection for the widget, false - to disable it.

bool isIntersectionEnabled ( ) const#

Returns a value indicating if intersection detection is enabled for the widget.

Return value

true if intersection detection is enabled for the widget; otherwise, false.

Last update: 13.12.2021

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Unigine::Widget Class

See Also#

Methods:

Widget Class

Enums

TYPE#

Members

bool isCallback ( int callback ) const#

Arguments

Return value

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase * func ) #

Arguments

Return value

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase1< Ptr<Widget> > * func ) #

Arguments

Return value

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase2< Ptr<Widget>, Ptr<Widget> > * func ) #

Arguments

Return value

void * addCallback ( Gui::CALLBACK_INDEX callback, Unigine::CallbackBase3< Ptr<Widget>, Ptr<Widget>, int > * func ) #

Arguments

Return value

bool removeCallback ( Gui::CALLBACK_INDEX callback, void * id ) #

Arguments

Return value

void clearCallbacks ( Gui::CALLBACK_INDEX callback ) #

Arguments

void setCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int key, int ctrl, int alt, int shift ) #

Arguments

bool getCallbackAccel ( Gui::CALLBACK_INDEX callback, unsigned int & key, int & ctrl, int & alt, int & shift ) const#

Arguments

Return value

int isCallbackAccel ( unsigned int key, int ctrl, int alt, int shift ) const#

Arguments

Return value

void setCallbackEnabled ( Gui::CALLBACK_INDEX callback, bool enabled ) #

Arguments

int isCallbackEnabled ( Gui::CALLBACK_INDEX callback ) const#

Arguments

Return value

Ptr<Widget> getChild ( int num ) const#

Arguments

Return value

int isChild ( const Ptr<Widget> & w ) const#

Arguments

Return value

void setData ( const char * data ) #

Arguments

const char * getData ( ) const#

Return value

void setEnabled ( bool enabled ) #

Arguments

bool isEnabled ( ) const#

Return value

void setFlags ( int flags ) #

Arguments

int getFlags ( ) const#

Return value

void setFocus ( ) #

int isFocused ( ) const#

Return value

void setFont ( const char * name ) #

Arguments

void setFontColor ( const Math::vec4 & color ) #

Arguments

Math::vec4 getFontColor ( ) const#

Return value

void setFontHOffset ( int hoffset ) #

Arguments

int getFontHOffset ( ) const#

Return value

void setFontHSpacing ( int hspacing ) #

Arguments

int getFontHSpacing ( ) const#

Return value

void setFontOutline ( int outline ) #

Arguments

int getFontOutline ( ) const#

Return value

void setFontPermanent ( int permanent ) #