cee::vis::Background

class Background

Small class for the view background settings.

The Background class defines the view background settings. The background can either be single colored or be a gradient between a top and a bottom color.

Get the background of a view with View::background().

See also

View

Public Functions

Background()

Constructs an empty object.

Background(const Background &other)

Constructs a background object as a copy of other.

Background &operator=(const Background &rhs)

Assigns rhs to this background and returns a reference to this background.

Color3f topColor() const

Returns the top color of the background.

If background is single color, topColor() and bottomColor() returns the same color.

Color3f bottomColor() const

Returns the bottom color of the background.

If background is single color, topColor() and bottomColor() returns the same color.

void setSingleColor(const Color3f &color)

Sets the background color to color (single color)

Same as setTopAndBottomColor(, ). Provided for convenience.

void setTopAndBottomColor(const Color3f &topColor, const Color3f &bottomColor)

Sets the background color to a gradient defined by a top color and a bottom color.

Public Static Functions

static Background createSingleColor(const Color3f &color)

Returns a single color background configured with the given color.

static Background createTopAndBottomColor(const Color3f &topColor, const Color3f &bottomColor)

Returns a top/bottom color background configured with the given colors.