This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
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
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.WidgetVBox Class

Inherits: Widget

This class creates a single vertical column container.

WidgetVBox Class

Properties

int Background#

A value indicating if a background texture is rendered for the box.
set
Sets a value indicating if a background texture should be rendered for the box.
set value - 1 to render a background texture, 0 not to render.

vec4 Color#

A color of the global color multiplier.
set
Sets a color for the global color multiplier. The default is equivalent to vec4(1,1,1,1) (white).
set value - Multiplier color.

int Stencil#

A value indicating if a widget cuts off its children along its set bounds. Everything that lies outside of them, is not rendered. This option works only if children have ALIGN_OVERLAP flag set (otherwise, they will expand the box widget bounds and no cutting will be done).
set
Sets a value indicating if a widget cuts off its children along its bounds. Everything that lies outside of them, is not rendered. The default is 0.
set value - 1 to enable cutting, 0 to disable it.

int PaddingBottom#

The current bottom padding for the widget content.

int PaddingTop#

The current top padding for the widget content.

int PaddingRight#

The current right-side padding for the widget content.

int PaddingLeft#

The current left-side padding for the widget content.

int SpaceY#

The vertical space between the widgets in the box and between them and the box border.

int SpaceX#

The horizontal space between the widgets in the box and between them and the box border.

vec4 BackgroundColor#

Returns the current background color used for the widget.
set
Sets the background color to be used for the widget.
set value - Four-component vector specifying the color in the RGBA format.

Members


static WidgetVBox ( Gui gui, int x = 0, int y = 0 ) #

Constructor. Creates a vertical box with given parameters.

Arguments

  • Gui gui - GUI, to which the new box will belong.
  • int x - Horizontal space between the widgets in the box and between them and the box border. This is an optional parameter.
  • int y - Vertical space between the widgets in the box and between them and the box border. This is an optional parameter.

void SetPadding ( int l, int r, int t, int b ) #

Sets widget paddings for all sides. Padding clears an area around the content of a widget (inside of it).

Arguments

  • int l - Left-side padding in pixels.
  • int r - Right-side padding in pixels.
  • int t - Top padding in pixels.
  • int b - Bottom padding in pixels.

void SetSpace ( int x, int y ) #

Sets a space between the widgets in the box and between them and the box border.

Arguments

  • int x - Horizontal space. If a negative value is specified, 0 will be used instead.
  • int y - Vertical space. If a negative value is specified, 0 will be used instead.

void SetBackgroundColor ( vec4 color ) #

Sets the background color to be used for the widget.

Arguments

  • vec4 color - Four-component vector specifying the color in the RGBA format.

vec4 GetBackgroundColor ( ) #

Returns the current background color used for the widget.

Return value

Four-component vector specifying the color in the RGBA format.
Last update: 2020-04-10
Build: ()