IlvPalette builder. More...

#include <ilviews/base/resource.h>

Inheritance diagram for IlvPalette::Builder:

Public Member Functions
	Builder (IlvDisplay *display)
	Initializes a new palette builder, starting with the default palette of the indicated display. More...

	Builder (const IlvPalette *palette)
	Initializes a new palette builder, starting with an existing palette. More...

	Builder (const Builder &builder)
	Copy constructor. More...

Builder &	alpha (IlvIntensity alpha)
	Sets the new palette alpha value. More...

Builder &	antialiasingMode (IlvAntialiasingMode aaMode)
	Sets the new palette antialias setting. More...

Builder &	arcMode (IlvArcMode arcMode)
	Sets the new palette arc mode. More...

Builder &	background (IlvColor *background)
	Sets the new palette background color. More...

Builder &	background (const char *background)
	Sets the new palette background color name. More...

Builder &	backgroundHSV (IlFloat hue, IlFloat saturation, IlFloat value)
	Sets the new palette background color HSV values. More...

Builder &	backgroundRGB (IlvIntensity r, IlvIntensity g, IlvIntensity b)
	Sets the new palette background color RGB values. More...

Builder &	colorPattern (IlvColorPattern *colorPattern)
	Sets the new palette fill color pattern. More...

Builder &	fillRule (IlvFillRule fillRule)
	Sets the new palette fill rule. More...

Builder &	fillStyle (IlvFillStyle fillStyle)
	Sets the new palette fill style. More...

Builder &	font (IlvFont *font)
	Sets the new palette font. More...

Builder &	font (const char *fontName)
	Sets the new palette font by name. More...

Builder &	foreground (IlvColor *foreground)
	Sets the new palette foreground color. More...

Builder &	foreground (const char *foreground)
	Sets the new palette foreground color name. More...

Builder &	foregroundHSV (IlFloat hue, IlFloat saturation, IlFloat value)
	Sets the new palette foreground color HSV values. More...

Builder &	foregroundRGB (IlvIntensity r, IlvIntensity g, IlvIntensity b)
	Sets the new palette foreground color RGB values. More...

virtual IlvPalette *	get (IlBoolean shared=IlTrue) const
	Builds and returns the new palette. More...

Builder &	gradientPattern (IlvGradientPattern *gradPat)
	Sets the new palette gradient pattern. More...

Builder &	invert ()
	Swaps the foreground and the background colors of this palette builder. More...

Builder &	lineStyle (IlvLineStyle *lineStyle)
	Sets the new palette line style. More...

Builder &	lineStyle (const char *name)
	Sets the new palette line style. More...

Builder &	lineStyle (IlUShort count, const unsigned char *dashes, IlUShort offset=0)
	Sets the new palette line style. More...

Builder &	lineWidth (IlUShort lineWidth)
	Sets the new palette line width. More...

	operator IlvPalette * () const
	Cast operator to a pointer to an `IlvPalette`. More...

Builder &	operator= (const Builder &builder)
	Assignment operator. More...

Builder &	pattern (IlvPattern *pattern)
	Sets the new palette fill pattern. More...

Detailed Description

IlvPalette builder.

Library: xviews or winviews or mviews (mutually exclusive)
This class simplifies the process of building a new IlvPalette, starting from an existing palette, and limiting the parameters that need to be changed to just what the application needs .

Starting with a palette, the palette builder lets you change one or several palette settings, so one does not have to provide the entire set of palette parameters should only a few of them be changed.

If you need to create a new palette that is the exact copy of another one, but where, for example, the background and foreground colors are swapped and where the line width is changed, you can use the following code:

    IlvPalette* newPalette = IlvPalette::Builder(initialPalette)
        .invert()
        .lineWidth(10);
    // newPalette is identical to initialPalette, except that its
    // background and foreground colors are swapped, and the line
    // width is now set to 10.

that is much more readable, less error-prone and shorter than the equivalent code:

    IlvPalette* newPalette = initialPalette->getDisplay()
        ->getPalette(initialPalette->getForeground(),
             initialPalette->getBackground(),
             initialPalette->getPattern(),
             initialPalette->getColorPattern(),
             initialPalette->getFont(),
             initialPalette->getLineStyle(),
             10,
             initialPalette->getFillStyle(),
             initialPalette->getArcMode(),
             initialPalette->getFillRule(),
             initialPalette->getAlpha(),
             initialPalette->getAntialiasingMode(),
             initialPalette->getGradientPattern());

A handy use case is when you want to create a set of IlvPalette objects that are based on a reference one:

    IlvPalette::Builder builder(display);
    builder.background("black").foreground("white").lineWidth(1);
    IlvPalette* normal = builder.get();
    IlvPalette* warning = builder.foreground("orange").lineWidth(3);
    IlvPalette* error   = builder.foreground("red").lineWidth(7);
    // 'warning' and 'error' are similar to 'normal', where only the
    // foreground color and the line width were changed.

Without the Builder, you would have to repeat a large number of parameters when invoking IlvDisplay::getPalette().

Constructor & Destructor Documentation

§ Builder() [1/3]

IlvPalette::Builder::Builder ( IlvDisplay * display )

Initializes a new palette builder, starting with the default palette of the indicated display.

Parameters

display The display instance to query the default palette from, that initializes the builder state.

§ Builder() [2/3]

IlvPalette::Builder::Builder ( const IlvPalette * palette )

Initializes a new palette builder, starting with an existing palette.

Parameters

palette The palette to initialize the builder from.

§ Builder() [3/3]

IlvPalette::Builder::Builder ( const Builder & builder )

Copy constructor.

Constructs a copy of builder.

Parameters

builder The builder that is copied to this object.

Member Function Documentation

§ alpha()

Builder& IlvPalette::Builder::alpha ( IlvIntensity alpha )

Sets the new palette alpha value.

Parameters

alpha The new palette alpha value.

Returns: The Builder object (*this).

§ antialiasingMode()

Builder& IlvPalette::Builder::antialiasingMode ( IlvAntialiasingMode aaMode )

Sets the new palette antialias setting.

Parameters

aaMode The new palette antialias setting.

Returns: The Builder object (*this).

§ arcMode()

Builder& IlvPalette::Builder::arcMode ( IlvArcMode arcMode )

Sets the new palette arc mode.

Parameters

arcMode The new palette arc mode.

Returns: The Builder object (*this).

§ background() [1/2]

Builder& IlvPalette::Builder::background ( IlvColor * background )

Sets the new palette background color.

Parameters

background The new palette background color. This color is locked.

Returns: The Builder object (*this).

§ background() [2/2]

Builder& IlvPalette::Builder::background ( const char * background )

Sets the new palette background color name.

Parameters

background The name of the new palette background color. If this name does not correspond to an actual color, this function does nothing.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(const char*, IlBoolean).

§ backgroundHSV()

Builder& IlvPalette::Builder::backgroundHSV	(	IlFloat	hue,
		IlFloat	saturation,
		IlFloat	value
	)

Sets the new palette background color HSV values.

Parameters

hue	The hue value value of the new palette background color.
saturation	The saturation value of the new palette background color.
value	The The luminosity value of the new palette background color.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(IlFloat, IlFloat, IlFloat, IlBoolean).

§ backgroundRGB()

Builder& IlvPalette::Builder::backgroundRGB	(	IlvIntensity	r,
		IlvIntensity	g,
		IlvIntensity	b
	)

Sets the new palette background color RGB values.

Parameters

r	The red component value of the new palette background color.
g	The green component value of the new palette background color.
b	The red component value of the new palette background color.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(IlvIntensity, IlvIntensity, IlvIntensity, IlBoolean).

§ colorPattern()

Builder& IlvPalette::Builder::colorPattern ( IlvColorPattern * colorPattern )

Sets the new palette fill color pattern.

Parameters

colorPattern The new palette fill color pattern. This pattern is locked.

Returns: The Builder object (*this).

§ fillRule()

Builder& IlvPalette::Builder::fillRule ( IlvFillRule fillRule )

Sets the new palette fill rule.

Parameters

fillRule The new palette fill rule.

Returns: The Builder object (*this).

§ fillStyle()

Builder& IlvPalette::Builder::fillStyle ( IlvFillStyle fillStyle )

Sets the new palette fill style.

Parameters

fillStyle The new palette fill style.

Returns: The Builder object (*this).

§ font() [1/2]

Builder& IlvPalette::Builder::font ( IlvFont * font )

Sets the new palette font.

Parameters

font	The new palette font. This font is locked.

Returns: The Builder object (*this).

§ font() [2/2]

Builder& IlvPalette::Builder::font ( const char * fontName )

Sets the new palette font by name.

Parameters

fontName The new palette font name. This font is locked. If this name does not correspond to an actual font, this function does nothing.

Returns: The Builder object (*this).

§ foreground() [1/2]

Builder& IlvPalette::Builder::foreground ( IlvColor * foreground )

Sets the new palette foreground color.

Parameters

foreground The new palette foreground color. This color is locked.

Returns: The Builder object (*this).

§ foreground() [2/2]

Builder& IlvPalette::Builder::foreground ( const char * foreground )

Sets the new palette foreground color name.

Parameters

foreground The name of the new palette foreground color. If this name does not correspond to an actual color, this function does nothing.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(const char*, IlBoolean).

§ foregroundHSV()

Builder& IlvPalette::Builder::foregroundHSV	(	IlFloat	hue,
		IlFloat	saturation,
		IlFloat	value
	)

Sets the new palette foreground color HSV values.

Parameters

hue	The hue value value of the new palette foreground color.
saturation	The saturation value of the new palette foreground color.
value	The The luminosity value of the new palette foreground color.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(IlFloat, IlFloat, IlFloat, IlBoolean).

§ foregroundRGB()

Builder& IlvPalette::Builder::foregroundRGB	(	IlvIntensity	r,
		IlvIntensity	g,
		IlvIntensity	b
	)

Sets the new palette foreground color RGB values.

Parameters

r	The red component value of the new palette foreground color.
g	The green component value of the new palette foreground color.
b	The red component value of the new palette foreground color.

Returns: The Builder object (*this).

See also: IlvDisplay::getColor(IlvIntensity, IlvIntensity, IlvIntensity, IlBoolean).

§ get()

virtual IlvPalette* IlvPalette::Builder::get ( IlBoolean shared = IlTrue ) const

virtual

Builds and returns the new palette.

Parameters

shared If IlTrue, the palette that is built is shared (that is, allocated using IlvDisplay::getPalette()), and not locked.
If IlFalse, the new palette is not shared (allocated using the IlvPalette constructor).

Returns: The new palette that was just build.

See also: operator IlvPalette*().

Reimplemented in IlvPalette::Changer.

§ gradientPattern()

Builder& IlvPalette::Builder::gradientPattern ( IlvGradientPattern * gradPat )

Sets the new palette gradient pattern.

Parameters

gradPat The new gradient pattern. This gradient pattern is locked.

Returns: The Builder object (*this).

§ invert()

Builder& IlvPalette::Builder::invert ( )

Swaps the foreground and the background colors of this palette builder.

Returns: The Builder object (*this).

See also: foreground(), background().

§ lineStyle() [1/3]

Builder& IlvPalette::Builder::lineStyle ( IlvLineStyle * lineStyle )

Sets the new palette line style.

Parameters

lineStyle The new palette line style. This line style is locked.

Returns: The Builder object (*this).

§ lineStyle() [2/3]

Builder& IlvPalette::Builder::lineStyle ( const char * name )

Sets the new palette line style.

Parameters

name	The new palette line style name if the style has been previously defined.

Returns: The Builder object (*this).

§ lineStyle() [3/3]

Builder& IlvPalette::Builder::lineStyle	(	IlUShort	count,
		const unsigned char *	dashes,
		IlUShort	offset = `0`
	)

Sets the new palette line style.

Parameters

count	The length of the line style array.
dashes	The number of foreground-colored pixels in a dash.
offset	The number of pixels to be skipped before the next dash.

Returns: The Builder object (*this).

§ lineWidth()

Builder& IlvPalette::Builder::lineWidth ( IlUShort lineWidth )

Sets the new palette line width.

Parameters

lineWidth The new palette line width.

Returns: The Builder object (*this).

§ operator IlvPalette *()

IlvPalette::Builder::operator IlvPalette * ( ) const

Cast operator to a pointer to an IlvPalette.

The palette that is returned is a shared palette that is not locked.

Returns: The new palette, as returned by get(IlTrue).

§ operator=()

Builder& IlvPalette::Builder::operator= ( const Builder & builder )

Assignment operator.

This operator assigns builder to this object.

Parameters

builder The builder that is copied to this object.

§ pattern()

Builder& IlvPalette::Builder::pattern ( IlvPattern * pattern )

Sets the new palette fill pattern.

Parameters

pattern The new palette fill pattern. This pattern is locked.

Returns: The Builder object (*this).

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

§ Builder() [1/3]

§ Builder() [2/3]

§ Builder() [3/3]

Member Function Documentation

§ alpha()

§ antialiasingMode()

§ arcMode()

§ background() [1/2]

§ background() [2/2]

§ backgroundHSV()

§ backgroundRGB()

§ colorPattern()

§ fillRule()

§ fillStyle()

§ font() [1/2]

§ font() [2/2]

§ foreground() [1/2]

§ foreground() [2/2]

§ foregroundHSV()

§ foregroundRGB()

§ get()

§ gradientPattern()

§ invert()

§ lineStyle() [1/3]

§ lineStyle() [2/3]

§ lineStyle() [3/3]

§ lineWidth()

§ operator IlvPalette *()

§ operator=()

§ pattern()