IlvMapAreaRenderingStyle Class Reference

This rendering style stores style parameters to render areas. More...

#include <ilviews/maps/rendering/areardrstyle.h>

Inheritance diagram for IlvMapAreaRenderingStyle:

List of all members.

Public Member Functions
	IlvMapAreaRenderingStyle (const IlvMapAreaRenderingStyle &source)
	Creates a IlvMapAreaRenderingStyle by copying an existing one.
	IlvMapAreaRenderingStyle (IlvDisplay *display)
	Initializes an instance of the rendering style.
IlvColor *	getFillBackground () const
	Returns the background fill color.
IlvColor *	getFillColor () const
	Returns the fill color.
IlvPattern *	getFillPattern () const
	Returns the fill pattern.
IlvMapLineRenderingStyle *	getLineRenderingStyle () const
	Returns the line rendering style used to draw the stroke of the graphic objects.
IlvPalette *	getPalette () const
	Returns the palette used to fill the graphic objects.
IlBoolean	isDrawingStroke () const
	Checks if generated objects will draw their stroke.
IlBoolean	isFillingObject () const
	Returns IlTrue if the generated objects are filled.
void	setDrawingStroke (IlBoolean drawStroke)
	Specifies whether the generated object will draw their stroke with the stroke color.
IlvMapsError	setFillBackground (const char *colorName)
	Sets the background fill color by specifying its name.
void	setFillBackground (IlvColor *color)
	Sets the background fill color.
IlvMapsError	setFillColor (const char *colorName)
	Sets the fill color.
void	setFillColor (IlvColor *color)
	Sets the fill color.
void	setFillingObject (IlBoolean fillObject)
	Specifies whether the generated objects must be filled with the fill pattern (if specified) or with the fill color.
IlvMapsError	setFillPattern (const char *fileName)
	Sets the fill pattern.
void	setFillPattern (IlvPattern *pattern)
	Sets the fill pattern.
void	setLineRenderingStyle (IlvMapLineRenderingStyle *lineRenderingStyle)
	Sets the rendering style used to draw the stroke of the graphic objects.
void	setPalette (IlvPalette *palette)
	Sets the palette used to fill the graphic objects.
Protected Member Functions
virtual	~IlvMapAreaRenderingStyle ()
	The destructor of this class is protected, because instances of IlvMapRenderingStyle are potentially shared by several objects.

---

Detailed Description

This rendering style stores style parameters to render areas.

Library: ilvmaps

---

Constructor & Destructor Documentation

virtual IlvMapAreaRenderingStyle::~IlvMapAreaRenderingStyle

(

)

[protected, virtual]

The destructor of this class is protected, because instances of IlvMapRenderingStyle are potentially shared by several objects.

See also:

IlvMapRenderingStyle::lock, IlvMapRenderingStyle::unLock.

IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle

(

IlvDisplay *

display

)

Initializes an instance of the rendering style.

Parameters:

display

The display used to create the graphic objects.

IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle

(

const IlvMapAreaRenderingStyle &

source

)

Creates a IlvMapAreaRenderingStyle by copying an existing one.

Parameters:

source

The object to be copied.

---

Member Function Documentation

IlvColor* IlvMapAreaRenderingStyle::getFillBackground

(

)

const

Returns the background fill color.

Returns a null pointer if no color is specified (in this case, the default display background color is used), or an IlvColor that should not be modified, because it can potentially be shared by other objects. However, it is possible to lock it if another object has to use it.

Returns:

The IlvColor used as a background.

IlvColor* IlvMapAreaRenderingStyle::getFillColor

(

)

const

Returns the fill color.

Returns:

A null pointer if no color is specified (in this case, the default display background color is used), or an IlvColor that should not be modified, because it can potentially be shared by other objects. However, it is possible to lock it if another object has to use it.

The IlvColor object used as fill color.

IlvPattern* IlvMapAreaRenderingStyle::getFillPattern

(

)

const

Returns the fill pattern.

Returns:

A null pointer if no fill pattern is specified or an IlvPattern that should not be modified, because it can potentially be shared with other objects. However, it is possible to lock it if an other object has to use it.

IlvMapLineRenderingStyle* IlvMapAreaRenderingStyle::getLineRenderingStyle

(

)

const

Returns the line rendering style used to draw the stroke of the graphic objects.

Returns:

The line rendering style used to draw the stroke of the graphic objects.

IlvPalette* IlvMapAreaRenderingStyle::getPalette

(

)

const

Returns the palette used to fill the graphic objects.

Returns:

A null pointer if no specific setting is set, or an IlvPalette that should not be modified, because it can potentially be shared by other objects. However, it is possible to lock it if an other object has to use it.

See also:

IlvResource::lock()

IlBoolean IlvMapAreaRenderingStyle::isDrawingStroke

(

)

const

Checks if generated objects will draw their stroke.

Returns:

IlTrue if the objects draw their stroke.

IlBoolean IlvMapAreaRenderingStyle::isFillingObject

(

)

const

Returns IlTrue if the generated objects are filled.

Returns:

IlTrue if the generated objects are filled.

void IlvMapAreaRenderingStyle::setDrawingStroke

(

IlBoolean

drawStroke

)

Specifies whether the generated object will draw their stroke with the stroke color.

Parameters:

drawStroke

If IlTrue, the generated objects will draw their stroke.

See also:

setStrokeColor

IlvMapsError IlvMapAreaRenderingStyle::setFillBackground

(

const char *

colorName

)

Sets the background fill color by specifying its name.

This background color may be used by some patterns.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

colorName

The color name.

Returns:

IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color.

void IlvMapAreaRenderingStyle::setFillBackground

(

IlvColor *

color

)

Sets the background fill color.

This background color may be used by some patterns.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

color

The color.

IlvMapsError IlvMapAreaRenderingStyle::setFillColor

(

const char *

colorName

)

Sets the fill color.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

colorName

The color name.

Returns:

IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color.

void IlvMapAreaRenderingStyle::setFillColor

(

IlvColor *

color

)

Sets the fill color.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

color

The color.

void IlvMapAreaRenderingStyle::setFillingObject

(

IlBoolean

fillObject

)

Specifies whether the generated objects must be filled with the fill pattern (if specified) or with the fill color.

Parameters:

fillObject

If IlTrue, the generated object will be filled.

See also:

setFillColor, setFillPattern.

IlvMapsError IlvMapAreaRenderingStyle::setFillPattern

(

const char *

fileName

)

Sets the fill pattern.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

fileName

The name of the file containing an image that will be used as a fill pattern.

Returns:

IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the line file cannot be used to create a pattern.

void IlvMapAreaRenderingStyle::setFillPattern

(

IlvPattern *

pattern

)

Sets the fill pattern.

Warning:

[note] This function is a convenience function that can be used instead of setPalette.

Parameters:

pattern

The pattern used to fill the polygons.

void IlvMapAreaRenderingStyle::setLineRenderingStyle

(

IlvMapLineRenderingStyle *

lineRenderingStyle

)

Sets the rendering style used to draw the stroke of the graphic objects.

Parameters:

lineRenderingStyle

An IlvMapLineRenderingStyle that can be shared by other objects.

void IlvMapAreaRenderingStyle::setPalette

(

IlvPalette *

palette

)

Sets the palette used to fill the graphic objects.

Parameters:

palette

The palette.