Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvMapAreaRenderingStyle Class Reference

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

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

Inheritance diagram for IlvMapAreaRenderingStyle:
IlvMapRenderingStyle

Public Member Functions

 IlvMapAreaRenderingStyle (const IlvMapAreaRenderingStyle &source)
 Initializes a new IlvMapAreaRenderingStyle instance by copying an existing one. More...
 
 IlvMapAreaRenderingStyle (IlvDisplay *display)
 Initializes a new IlvMapAreaRenderingStyle instance. More...
 
IlvColorgetFillBackground () const
 Returns the background fill color. More...
 
IlvColorgetFillColor () const
 Returns the fill color. More...
 
IlvPatterngetFillPattern () const
 Returns the fill pattern. More...
 
IlvMapLineRenderingStylegetLineRenderingStyle () const
 Returns the line rendering style used to draw the stroke of the graphic objects. More...
 
IlvPalettegetPalette () const
 Returns the palette used to fill the graphic objects. More...
 
IlBoolean isDrawingStroke () const
 Checks if generated objects will draw their stroke. More...
 
IlBoolean isFillingObject () const
 Returns IlTrue if the generated objects are filled. More...
 
void setDrawingStroke (IlBoolean drawStroke)
 Specifies whether the generated object will draw their stroke with the stroke color. More...
 
IlvMapsError setFillBackground (const char *colorName)
 Sets the background fill color by specifying its name. More...
 
void setFillBackground (IlvColor *color)
 Sets the background fill color. More...
 
IlvMapsError setFillColor (const char *colorName)
 Sets the fill color. More...
 
void setFillColor (IlvColor *color)
 Sets the fill color. More...
 
void setFillingObject (IlBoolean fillObject)
 Specifies whether the generated objects must be filled with the fill pattern (if specified) or with the fill color. More...
 
IlvMapsError setFillPattern (const char *fileName)
 Sets the fill pattern. More...
 
void setFillPattern (IlvPattern *pattern)
 Sets the fill pattern. More...
 
void setLineRenderingStyle (IlvMapLineRenderingStyle *lineRenderingStyle)
 Sets the rendering style used to draw the stroke of the graphic objects. More...
 
void setPalette (IlvPalette *palette)
 Sets the palette used to fill the graphic objects. More...
 
- Public Member Functions inherited from IlvMapRenderingStyle
virtual IlvMapRenderingStylecopy () const =0
 Copies the object. More...
 
IlvDisplaygetDisplay () const
 Returns the display that is used to create the graphic settings. More...
 
void lock ()
 Locks the object and prevents it from being deleted. More...
 
void save (IlvOutputFile &file) const
 Saves the object to an output file. More...
 
void unLock ()
 Unlocks the object. More...
 

Protected Member Functions

virtual ~IlvMapAreaRenderingStyle ()
 Destructor. More...
 
- Protected Member Functions inherited from IlvMapRenderingStyle
 IlvMapRenderingStyle (const IlvMapRenderingStyle &source)
 Initializes a new instance of the renderer style as a copy of another one. More...
 
 IlvMapRenderingStyle (IlvDisplay *display)
 Initializes a new instance of this rendering style. More...
 
virtual ~IlvMapRenderingStyle ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapRenderingStyle
static IlvMapRenderingStyleLoad (IlvInputFile &file)
 Loads a rendering style from an IlvInputFile. More...
 

Detailed Description

This rendering style stores style parameters to render areas.

Library: ilvmaps

Constructor & Destructor Documentation

◆ IlvMapAreaRenderingStyle() [1/2]

IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle ( IlvDisplay display)

Initializes a new IlvMapAreaRenderingStyle instance.

Parameters
displayThe display used to create the graphic objects.

◆ IlvMapAreaRenderingStyle() [2/2]

IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle ( const IlvMapAreaRenderingStyle source)

Initializes a new IlvMapAreaRenderingStyle instance by copying an existing one.

Parameters
sourceThe object to be copied.

◆ ~IlvMapAreaRenderingStyle()

virtual IlvMapAreaRenderingStyle::~IlvMapAreaRenderingStyle ( )
protectedvirtual

Destructor.

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

See also
IlvMapRenderingStyle::lock(), IlvMapRenderingStyle::unLock().

Member Function Documentation

◆ getFillBackground()

IlvColor* IlvMapAreaRenderingStyle::getFillBackground ( ) const

Returns the background fill color.

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

◆ getFillColor()

IlvColor* IlvMapAreaRenderingStyle::getFillColor ( ) const

Returns the fill color.

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

◆ getFillPattern()

IlvPattern* IlvMapAreaRenderingStyle::getFillPattern ( ) const

Returns the fill pattern.

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

◆ getLineRenderingStyle()

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.

◆ getPalette()

IlvPalette* IlvMapAreaRenderingStyle::getPalette ( ) const

Returns the palette used to fill the graphic objects.

Returns
0 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().

◆ isDrawingStroke()

IlBoolean IlvMapAreaRenderingStyle::isDrawingStroke ( ) const

Checks if generated objects will draw their stroke.

Returns
IlTrue if the objects draw their stroke.

◆ isFillingObject()

IlBoolean IlvMapAreaRenderingStyle::isFillingObject ( ) const

Returns IlTrue if the generated objects are filled.

Returns
IlTrue if the generated objects are filled.

◆ setDrawingStroke()

void IlvMapAreaRenderingStyle::setDrawingStroke ( IlBoolean  drawStroke)

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

Parameters
drawStrokeIf IlTrue, the generated objects will draw their stroke.
See also
setStrokeColor().

◆ setFillBackground() [1/2]

IlvMapsError IlvMapAreaRenderingStyle::setFillBackground ( const char *  colorName)

Sets the background fill color by specifying its name.

This background color may be used by some patterns.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
colorNameThe color name.
Returns
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color.

◆ setFillBackground() [2/2]

void IlvMapAreaRenderingStyle::setFillBackground ( IlvColor color)

Sets the background fill color.

This background color may be used by some patterns.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
colorThe color.

◆ setFillColor() [1/2]

IlvMapsError IlvMapAreaRenderingStyle::setFillColor ( const char *  colorName)

Sets the fill color.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
colorNameThe color name.
Returns
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color.

◆ setFillColor() [2/2]

void IlvMapAreaRenderingStyle::setFillColor ( IlvColor color)

Sets the fill color.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
colorThe color.

◆ setFillingObject()

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
fillObjectIf IlTrue, the generated object will be filled.
See also
setFillColor(), setFillPattern().

◆ setFillPattern() [1/2]

IlvMapsError IlvMapAreaRenderingStyle::setFillPattern ( const char *  fileName)

Sets the fill pattern.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
fileNameThe 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.

◆ setFillPattern() [2/2]

void IlvMapAreaRenderingStyle::setFillPattern ( IlvPattern pattern)

Sets the fill pattern.

Note
This function is a convenience function that can be used instead of setPalette().
Parameters
patternThe pattern used to fill the polygons.

◆ setLineRenderingStyle()

void IlvMapAreaRenderingStyle::setLineRenderingStyle ( IlvMapLineRenderingStyle lineRenderingStyle)

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

Parameters
lineRenderingStyleThe style, that is potentially shared with other objects.

◆ setPalette()

void IlvMapAreaRenderingStyle::setPalette ( IlvPalette palette)

Sets the palette used to fill the graphic objects.

Parameters
paletteThe palette.