 |
Rogue Wave Views Maps Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Maps Package API Reference Guide |
Rogue Wave Views Documentation Home |
This rendering style stores style parameters to render areas. More...
#include <ilviews/maps/rendering/areardrstyle.h>
Public Member Functions | |
| IlvMapAreaRenderingStyle (IlvDisplay *display) | |
Initializes a new IlvMapAreaRenderingStyle instance. More... | |
| IlvMapAreaRenderingStyle (const IlvMapAreaRenderingStyle &source) | |
Initializes a new IlvMapAreaRenderingStyle instance by copying an existing one. More... | |
| IlvColor * | getFillBackground () const |
| Returns the background fill color. More... | |
| IlvColor * | getFillColor () const |
| Returns the fill color. More... | |
| IlvPattern * | getFillPattern () const |
| Returns the fill pattern. More... | |
| IlvMapLineRenderingStyle * | getLineRenderingStyle () const |
| Returns the line rendering style used to draw the stroke of the graphic objects. More... | |
| IlvPalette * | getPalette () 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... | |
| void | setFillBackground (IlvColor *color) |
| Sets the background fill color. More... | |
| IlvMapsError | setFillBackground (const char *colorName) |
| Sets the background fill color by specifying its name. More... | |
| void | setFillColor (IlvColor *color) |
| Sets the fill color. More... | |
| IlvMapsError | setFillColor (const char *colorName) |
| 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... | |
| void | setFillPattern (IlvPattern *pattern) |
| Sets the fill pattern. More... | |
| IlvMapsError | setFillPattern (const char *fileName) |
| 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 IlvMapRenderingStyle * | copy () const =0 |
| Copies the object. More... | |
| IlvDisplay * | getDisplay () 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 (IlvDisplay *display) | |
| Initializes a new instance of this rendering style. More... | |
| IlvMapRenderingStyle (const IlvMapRenderingStyle &source) | |
| Initializes a new instance of the renderer style as a copy of another one. More... | |
| virtual | ~IlvMapRenderingStyle () |
| Destructor. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from IlvMapRenderingStyle | |
| static IlvMapRenderingStyle * | Load (IlvInputFile &file) |
Loads a rendering style from an IlvInputFile. More... | |
This rendering style stores style parameters to render areas.
Library: ilvmaps
| IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle | ( | IlvDisplay * | display | ) |
Initializes a new IlvMapAreaRenderingStyle instance.
| display | The display used to create the graphic objects. |
| IlvMapAreaRenderingStyle::IlvMapAreaRenderingStyle | ( | const IlvMapAreaRenderingStyle & | source | ) |
Initializes a new IlvMapAreaRenderingStyle instance by copying an existing one.
| source | The object to be copied. |
|
protectedvirtual |
Destructor.
The destructor of this class is protected, because instances of IlvMapRenderingStyle are potentially shared by several objects.
| 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.
IlvColor used as a background. | IlvColor* IlvMapAreaRenderingStyle::getFillColor | ( | ) | const |
Returns the fill color.
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. IlvColor object used as fill color. | IlvPattern* IlvMapAreaRenderingStyle::getFillPattern | ( | ) | const |
Returns the fill pattern.
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. | IlvMapLineRenderingStyle* IlvMapAreaRenderingStyle::getLineRenderingStyle | ( | ) | const |
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.
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. IlvResource::lock(). | IlBoolean IlvMapAreaRenderingStyle::isDrawingStroke | ( | ) | const |
Checks if generated objects will draw their stroke.
IlTrue if the objects draw their stroke. | IlBoolean IlvMapAreaRenderingStyle::isFillingObject | ( | ) | const |
Returns IlTrue if the generated objects are filled.
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.
| drawStroke | If IlTrue, the generated objects will draw their stroke. |
setStrokeColor(). | void IlvMapAreaRenderingStyle::setFillBackground | ( | IlvColor * | color | ) |
Sets the background fill color.
This background color may be used by some patterns.
setPalette(). | color | The color. |
| IlvMapsError IlvMapAreaRenderingStyle::setFillBackground | ( | const char * | colorName | ) |
Sets the background fill color by specifying its name.
This background color may be used by some patterns.
setPalette(). | colorName | The color name. |
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color. | void IlvMapAreaRenderingStyle::setFillColor | ( | IlvColor * | color | ) |
Sets the fill color.
setPalette(). | color | The color. |
| IlvMapsError IlvMapAreaRenderingStyle::setFillColor | ( | const char * | colorName | ) |
Sets the fill color.
setPalette(). | colorName | The color name. |
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a 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.
| fillObject | If IlTrue, the generated object will be filled. |
setFillColor(), setFillPattern(). | void IlvMapAreaRenderingStyle::setFillPattern | ( | IlvPattern * | pattern | ) |
Sets the fill pattern.
setPalette(). | pattern | The pattern used to fill the polygons. |
| IlvMapsError IlvMapAreaRenderingStyle::setFillPattern | ( | const char * | fileName | ) |
Sets the fill pattern.
setPalette(). | fileName | The name of the file containing an image that will be used as a fill pattern. |
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the line file cannot be used to create a pattern. | void IlvMapAreaRenderingStyle::setLineRenderingStyle | ( | IlvMapLineRenderingStyle * | lineRenderingStyle | ) |
Sets the rendering style used to draw the stroke of the graphic objects.
| lineRenderingStyle | The style, that is potentially shared with other objects. |
| void IlvMapAreaRenderingStyle::setPalette | ( | IlvPalette * | palette | ) |
Sets the palette used to fill the graphic objects.
| palette | The palette. |
© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.