Unigine::WidgetVBox Class

WidgetVBox Class

Members

int getPaddingBottom() const#

Return value

Current bottom padding in pixels.

int getPaddingTop() const#

Return value

Current top padding in pixels.

int getPaddingRight() const#

Return value

Current right-side padding in pixels.

int getPaddingLeft() const#

Return value

Current left-side padding in pixels.

int getSpaceY() const#

Return value

Current vertical space.

int getSpaceX() const#

Return value

Current horizontal space.

void setBackgroundCustomFilter ( int filter ) #

Arguments

• int filter - The texture flag.

int getBackgroundCustomFilter() const#

Return value

Current texture flag.

void setBackgroundCustomFilterEnabled ( bool enabled ) #

Arguments

• bool enabled - Set true to enable a custom filtering mode for the background texture; false - to disable it.

bool isBackgroundCustomFilterEnabled() const#

Return value

true if a custom filtering mode for the background texture is enabled; otherwise false.

void setBackground9SliceScale ( float scale ) #

Arguments

• float scale - The value to control scaling for corners of the background texture; the default is 1.

float getBackground9SliceScale() const#

Return value

Current value to control scaling for corners of the background texture; the default is 1.

void setBackground9Sliced ( bool sliced ) #

Arguments

• bool sliced - Set true to enable the 9-sliced mode; false - to disable it.

bool isBackground9Sliced() const#

Return value

true if the 9-sliced mode is enabled; otherwise false.

void setBackgroundTexture ( const char * texture ) #

Arguments

• const char * texture - The path to the texture.

const char * getBackgroundTexture() const#

Return value

Current path to the texture.

---

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.

void setBorder ( bool border ) #

Sets the border display state for the widget.

Arguments

• bool border - true to display the border, otherwise, false.

bool isBorder ( ) const#

Returns the current value indicating if the border is displayed.

Return value

true if the border is displayed, otherwise, false.

void setBackgroundImage ( const Ptr<Image> & image, int dynamic = 0 ) #

Sets an image loaded into memory as the background of the widget.

Arguments

• const Ptr<Image> & image - Pointer to the image.
• int dynamic - Positive number if the image will be updated each frame; otherwise, 0.

Ptr<Image> getBackgroundImage ( ) const#

Returns a pointer to the image currently set as the background of the widget.

Return value

Pointer to the image.

void setBackgroundRender ( const Ptr<Texture> & texture, int flipped = 0 ) #

Sets a texture to be rendered as the background of the widget.

Arguments

• const Ptr<Texture> & texture - Pointer to the texture.
• int flipped - Flipped flag.

Ptr<Texture> getBackgroundRender ( ) const#

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.

Math::vec4 getBackground9SliceOffsets ( ) const#

Gets the vector of offset values for the background texture when 9-slice mode is enabled.

Return value

The vector of offset values.