Unigine.WidgetVBox Class
| Inherits from: | Widget |
WidgetVBox Class
Properties
bool Border#
The value indicating if the border is displayed.
int Background#
The value indicating if a background texture is rendered for the box.
vec4 BackgroundColor#
The background color used for the widget.
vec4 Color#
The color of the global color multiplier.
int Stencil#
The 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).
int PaddingBottom#
The bottom padding for the widget content.
int PaddingTop#
The top padding for the widget content.
int PaddingRight#
The right-side padding for the widget content.
int PaddingLeft#
The 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.
int BackgroundCustomFilter#
The
bool BackgroundCustomFilterEnabled#
The
float Background9SliceScale#
The
bool Background9Sliced#
The
string BackgroundTexture#
The
Members
WidgetVBox ( Gui gui, int x = 0, int y = 0 ) #
Constructor. Creates a vertical box with given parameters and adds it to the specified GUI.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.
WidgetVBox ( 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 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 SetBackgroundImage ( Image image, int dynamic = 0 ) #
Arguments
- Image image
- int dynamic
Image GetBackgroundImage ( ) #
void SetBackgroundTexture ( string texture ) #
Arguments
- string texture
string GetBackgroundTexture ( ) #
void SetBackgroundRender ( Texture texture, int flipped = 0 ) #
Arguments
- Texture texture
- int flipped
Texture GetBackgroundRender ( ) #
void SetBackground9Sliced ( bool sliced ) #
Arguments
- bool sliced
bool IsBackground9Sliced ( ) #
void SetBackground9SliceOffsets ( float l, float r, float t, float b ) #
Arguments
- float l
- float r
- float t
- float b
vec4 GetBackground9SliceOffsets ( ) #
void SetBackground9SliceScale ( float scale ) #
Arguments
- float scale
float GetBackground9SliceScale ( ) #
void SetBackgroundCustomFilterEnabled ( bool enabled ) #
Arguments
- bool enabled
bool IsBackgroundCustomFilterEnabled ( ) #
void SetBackgroundCustomFilter ( int filter ) #
Arguments
- int filter
int GetBackgroundCustomFilter ( ) #
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-04-22
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)