This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
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
Content Creation
Content Optimization
Materials
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::WidgetVBox Class

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

This class creates a single vertical column container.

WidgetVBox Class

Members


static WidgetVBoxPtr create ( const Ptr<Gui> & gui, int x = 0, int y = 0 ) #

Constructor. Creates a vertical box with given parameters and adds it to the specified GUI.

Arguments

  • const Ptr<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.

static WidgetVBoxPtr create ( int x = 0, int y = 0 ) #

Constructor. Creates a vertical box with given parameters and adds it to the Engine GUI.

Arguments

  • 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 setBackground ( int background ) #

Sets a value indicating if a background texture should be rendered for the box.

Arguments

  • int background - 1 to render a background texture, 0 not to render.

int getBackground ( ) const#

Returns a value indicating if a background texture is rendered for the box.

Return value

1 if a background texture is rendered; otherwise, 0.

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

Sets a color for the global color multiplier. The default is equivalent to vec4(1,1,1,1) (white).

Arguments

  • const Math::vec4 & color - Multiplier color.

Math::vec4 getColor ( ) const#

Returns a color of the global color multiplier.

Return value

Multiplier color.

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.

int getPaddingBottom ( ) const#

Returns the current bottom padding for the widget content.

Return value

Bottom padding in pixels.

int getPaddingLeft ( ) const#

Returns the current left-side padding for the widget content.

Return value

Left-side padding in pixels.

int getPaddingRight ( ) const#

Returns the current right-side padding for the widget content.

Return value

Right-side padding in pixels.

int getPaddingTop ( ) const#

Returns the current top padding for the widget content.

Return value

Top 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.

int getSpaceX ( ) const#

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

Return value

Horizontal space.

int getSpaceY ( ) const#

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

Return value

Vertical space.

void setStencil ( int stencil ) #

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.

Arguments

  • int stencil - 1 to enable cutting, 0 to disable it.

int getStencil ( ) const#

Returns 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).

Return value

1 if cutting is enabled; otherwise, 0.

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

Sets the background color to be used for the widget.

Arguments

  • const Math::vec4 & color - Four-component vector specifying the color in the RGBA format.

Math::vec4 getBackgroundColor ( ) const#

Returns the current background color used for the widget.

Return value

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