Unigine::WidgetWindow Class

WidgetWindow Class

Members

---

static WidgetWindowPtr create ( const Ptr<Gui> & gui, const char * str = 0, int x = 0, int y = 0 )

Constructor. Creates a window with given parameters.

Arguments

• const Ptr<Gui> & gui - GUI, to which the new window will belong.
• const char * str - Window title. This is an optional parameter.
• int x - Horizontal space between the widgets in the window and between them and the window border. This is an optional parameter.
• int y - Vertical space between the widgets in the window and between them and the window border. This is an optional parameter.

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

Casts a WidgetWindow out of the Widget instance.

Arguments

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

Return value

Pointer to WidgetWindow.

void setBlendable( int blendable )

Sets a value indicating if the window can fade in and out when changing to the minimized state and back.

Arguments

• int blendable - 1 to allow fading in and out, 0 to disallow it.

int isBlendable( )

Returns a value indicating if the window can fade in and out when changing to the minimized state and back. The default is 0.

Return value

1 if the window can fade in and out; 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 setFloatable( int floatable )

Sets a value indicating if the window is animated when changing to the minimized state and back.

Arguments

• int floatable - 1 to allow animating the window, 0 not to make it.

int isFloatable( )

Returns a value indicating if the window is animated when changing to the minimized state and back. The default is 0.

Return value

1 if the window is animated; otherwise, 0.

void setMaxHeight( int height )

Sets the maximum height value for the window.

Arguments

• int height - Maximum height value.

int getMaxHeight( )

Returns the maximum height value of the window.

Return value

Maximum height value.

void setMaxWidth( int width )

Sets the maximum width value for the window.

Arguments

• int width - Maximum width value.

int getMaxWidth( )

Returns the maximum width value of the window.

Return value

Maximum width value.

void setMoveable( int moveable )

Sets a value indicating if the window is movable.

Arguments

• int moveable - 1 to set the window as movable; otherwise, 0.

int isMoveable( )

Returns a value indicating if the window is movable. The default is 1.

Return value

1 if the window is movable; otherwise, 0.

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 setSizeable( int sizeable )

Sets a value indicating if the window is resizeable.

Arguments

• int sizeable - 1 to allow resizing the window, 0 to disallow it.

int isSizeable( )

Returns a value indicating if the window is resizeable. The default is 0.

Return value

1 if the window is resizeable; otherwise, 0.

void setSnapDistance( int distance )

Sets a distance, at which the window snaps to another window or screen edge.

Arguments

• int distance - Distance in pixels.

int getSnapDistance( )

Returns the distance, at which the window snaps to another window or screen edge. The default is 0 (do not snap).

Return value

Distance in pixels.

void setSpace( int x, int y )

Sets a space between the widgets in the window and between them and the window border.

Arguments

• int x - Horizontal space. If a negative value is provided, 0 will be used instead.
• int y - Vertical space. If a negative value is provided, 0 will be used instead.

int getSpaceX( )

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

Return value

Horizontal space.

int getSpaceY( )

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

Return value

Vertical space.

void setText( const char * text )

Sets a window title.

Arguments

• const char * text - Window title.

const char * getText( )

Returns the current window title.

Return value

Window title.

void setTextAlign( int align )

Sets alignment of the window title.

Arguments

• int align - One of the ALIGN_* pre-defined variables.

int getTextAlign( )

Returns the alignment of the window title.

Return value

One of the ALIGN_* pre-defined variables.

void setTitleable( int titleable )

Sets a value indicating if the window is minimized when double-clicking on it. The default is 0.

Arguments

• int titleable - 1 to allow minimization, 0 to disallow it.

int isTitleable( )

Returns a value indicating if the window is minimized when double-clicking on it. The default is 0.

Return value

1 if the window is minimized when double-clicking on it; otherwise, 0.

void setTransform( const Math::mat4 & transform )

Sets the global widget transformation matrix. This 2D matrix can be tilted, rotated, moved or modified in many ways in 3D space.

Arguments

• const Math::mat4 & transform - Transformation matrix.

Math::mat4 getTransform( )

Returns the global widget transformation matrix.

Return value

Transformation matrix.

Ptr<WidgetWindow> getWidgetWindow( )

Returns a window pointer.

Return value

WidgetWindow pointer.

int type( )

WidgetWindow type.

Return value

WidgetWindow type identifier.