WidgetVBox Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits from: | Widget |
WidgetVBox Class
Members
int getPaddingBottom() const#
Returns the current bottom padding for the widget content.
Return value
Current bottom padding in pixels.int getPaddingTop() const#
Returns the current top padding for the widget content.
Return value
Current top padding in pixels.int getPaddingRight() const#
Returns the current right-side padding for the widget content.
Return value
Current right-side padding in pixels.int getPaddingLeft() const#
Returns the current left-side padding for the widget content.
Return value
Current left-side padding in pixels.int getSpaceY() const#
Returns the current vertical space between the widgets in the box and between them and the box border.
Return value
Current vertical space.int getSpaceX() const#
Returns the current horizontal space between the widgets in the box and between them and the box border.
Return value
Current horizontal space.void setBackgroundCustomFilter ( int filter ) #
Sets a new custom filtering mode for the texture used as the background of the widget.
Arguments
- int filter - The texture flag.
int getBackgroundCustomFilter() const#
Returns the current custom filtering mode for the texture used as the background of the widget.
Return value
Current texture flag.void setBackgroundCustomFilterEnabled ( bool enabled ) #
Sets a new value indicating whether a custom filtering mode for the background texture is enabled.
Arguments
- bool enabled - Set true to enable a custom filtering mode for the background texture; false - to disable it.
bool isBackgroundCustomFilterEnabled() const#
Returns the current value indicating whether a custom filtering mode for the background texture is enabled.
Return value
true if a custom filtering mode for the background texture is enabled; otherwise false.void setBackground9SliceScale ( float scale ) #
Sets a new value that controls scaling for corners of a background texture when 9-sliced mode is enabled.
Arguments
- float scale - The value to control scaling for corners of the background texture; the default is 1.
float getBackground9SliceScale() const#
Returns the current value that controls scaling for corners of a background texture when 9-sliced mode is enabled.
Return value
Current value to control scaling for corners of the background texture; the default is 1.void setBackground9Sliced ( bool sliced ) #
Sets a new value indicating whether 9-sliced mode is enabled.
Arguments
- bool sliced - Set true to enable the 9-sliced mode; false - to disable it.
bool isBackground9Sliced() const#
Returns the current value indicating whether 9-sliced mode is enabled.
Return value
true if the 9-sliced mode is enabled; otherwise false.void setBackgroundTexture ( ) #
Sets a new texture path for the widget background.
Arguments
- texture - The path to the texture.
const char * getBackgroundTexture() const#
Returns the current texture path for the widget background.
Return value
Current path to the texture.static 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.
static 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 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 ( ) #
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 ( vec4 color ) #
Sets a color for the global color multiplier. The default is equivalent to #ffffff (white).Arguments
- vec4 color - Multiplier color.
vec4 getColor ( ) #
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 ( ) #
Returns the current bottom padding for the widget content.Return value
Bottom padding in pixels.int getPaddingLeft ( ) #
Returns the current left-side padding for the widget content.Return value
Left-side padding in pixels.int getPaddingRight ( ) #
Returns the current right-side padding for the widget content.Return value
Right-side padding in pixels.int getPaddingTop ( ) #
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 ( ) #
Returns the horizontal space between the widgets in the box and between them and the box border.Return value
Horizontal space.int getSpaceY ( ) #
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 ( ) #
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 GUI_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 ( 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.void setBorder ( int border ) #
Sets the border display state for the widget.Arguments
- int border - 1 to display the border, otherwise, 0.
int isBorder ( ) #
Returns the current value indicating if the border is displayed.Return value
1 if the border is displayed, otherwise, 0.Image getBackgroundImage ( ) #
Returns a pointer to the image currently set as the background of the widget.Return value
Pointer to the image.void setBackgroundRender ( Texture texture, int flipped = 0 ) #
Sets a texture to be rendered as the background of the widget.Arguments
- Texture texture - Pointer to the texture.
- int flipped - Flipped flag.
Texture getBackgroundRender ( ) #
Returns a pointer to the texture currently set as the background of the widget.Return value
Pointer to the texture.void setBackground9SliceOffsets ( float l, float r, float t, float b ) #
Sets the offsets for the background texture when 9-slice mode is enabled. Offsets are specified in normalized values (from 0 to 1).Arguments
- float l - Left-side offset.
- float r - Right-side offset.
- float t - Top offset.
- float b - Bottom offset.
vec4 getBackground9SliceOffsets ( ) #
Gets the vector of offset values for the background texture when 9-slice mode is enabled.Return value
The vector of offset values.The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-05-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)