Unigine::WidgetVBox Class

WidgetVBox Class

Members

---

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

Constructor. Creates a vertical box with given parameters.

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.

Ptr<WidgetVBox> cast(const Ptr<Widget> & widget)

Casts a WidgetVBox out of the Widget instance.

Arguments

• const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetVBox.

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(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()

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

Ptr<WidgetVBox> getWidgetVBox()

Returns a widget vbox pointer.

Return value

WidgetVBox pointer.

int type()

WidgetVBox type.

Return value

WidgetVBox type identifier.