 |
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 draw lines. More...
#include <ilviews/maps/rendering/linerdrstyle.h>
Public Member Functions | |
| IlvMapLineRenderingStyle (IlvDisplay *display) | |
| Initializes a new instance of the renderer. More... | |
| IlvMapLineRenderingStyle (const IlvMapLineRenderingStyle &source) | |
| Initializes a new instance of the renderer as a copy of another one. More... | |
| IlvColor * | getForeground () const |
| Returns the foreground used to create the lines. More... | |
| IlvLineStyle * | getLineStyle () const |
| Returns the style used by the renderer to draw the lines. More... | |
| IlUShort | getLineWidth () const |
| Returns the line width used for the lines. More... | |
| IlvPalette * | getPalette () const |
| Returns the palette used to create the graphic objects. More... | |
| IlBoolean | isStyleAndWidthAllowed () const |
Indicates if dashed style can be used for lines of width greater than 1. More... | |
| void | setForeground (IlvColor *color) |
| Sets the foreground of the lines. More... | |
| IlvMapsError | setForeground (const char *colorName) |
| Sets the foreground of the lines by specifying a color name. More... | |
| void | setLineStyle (IlvLineStyle *lineStyle) |
| Sets the array representing the lengths of the dash segments of the lines. More... | |
| IlvMapsError | setLineStyle (const char *lineStyleName) |
| Sets the array representing the lengths of the dash segments of the lines. More... | |
| void | setLineWidth (IlUShort lineWidth) |
| Sets the line width of the lines. More... | |
| void | setPalette (IlvPalette *palette) |
| Sets the palette used to create the graphic objects. More... | |
| void | setStyleAndWidthAllowed (IlBoolean allow) |
Specifies if dashed style can be used for lines of width greater than 1. 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 | ~IlvMapLineRenderingStyle () |
| 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 draw lines.
Library: ilvmaps
| IlvMapLineRenderingStyle::IlvMapLineRenderingStyle | ( | IlvDisplay * | display | ) |
Initializes a new instance of the renderer.
| display | The display used to create the graphic settings. |
| IlvMapLineRenderingStyle::IlvMapLineRenderingStyle | ( | const IlvMapLineRenderingStyle & | source | ) |
Initializes a new instance of the renderer as a copy of another 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* IlvMapLineRenderingStyle::getForeground | ( | ) | const |
Returns the foreground used to create the lines.
0 if no color is specified (in this case, the default display foreground 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. | IlvLineStyle* IlvMapLineRenderingStyle::getLineStyle | ( | ) | const |
Returns the style used by the renderer to draw the lines.
0 if no line style is specified or an IlvLineStyle that should not be modified, because it can potentially be shared with other objects. However, it is possible to lock it if another object has to use it. | IlUShort IlvMapLineRenderingStyle::getLineWidth | ( | ) | const |
Returns the line width used for the lines.
| IlvPalette* IlvMapLineRenderingStyle::getPalette | ( | ) | const |
Returns the palette used to create 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 another object has to use it. IlvResource::lock(). | IlBoolean IlvMapLineRenderingStyle::isStyleAndWidthAllowed | ( | ) | const |
Indicates if dashed style can be used for lines of width greater than 1.
IlTrue if a line style can be used for lines of width greater than 1. | void IlvMapLineRenderingStyle::setForeground | ( | IlvColor * | color | ) |
Sets the foreground of the lines.
This is a convenience function that can be used instead of setPalette().
| color | The color used as foreground. |
| IlvMapsError IlvMapLineRenderingStyle::setForeground | ( | const char * | colorName | ) |
Sets the foreground of the lines by specifying a color name.
setPalette(). | colorName | The name of the color. |
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the color name cannot be translated into a color. | void IlvMapLineRenderingStyle::setLineStyle | ( | IlvLineStyle * | lineStyle | ) |
Sets the array representing the lengths of the dash segments of the lines.
This function sets the line width to 1 if the line style is not plain.
setPalette(). | lineStyle | The line style. |
| IlvMapsError IlvMapLineRenderingStyle::setLineStyle | ( | const char * | lineStyleName | ) |
Sets the array representing the lengths of the dash segments of the lines.
This function sets the line width to 1 if the line style is not plain.
setPalette(). | lineStyleName | The name of a style. |
IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the line style name cannot be translated into an IlvLineStyle. | void IlvMapLineRenderingStyle::setLineWidth | ( | IlUShort | lineWidth | ) |
Sets the line width of the lines.
A line width higher than 1 removes the line style.
setPalette(). | lineWidth | The width of the line used to draw the polylines generated by this renderer. |
| void IlvMapLineRenderingStyle::setPalette | ( | IlvPalette * | palette | ) |
Sets the palette used to create the graphic objects.
This function can be used to specify a special palette instead of the palette created by the setters of this class.
| palette | The palette. |
| void IlvMapLineRenderingStyle::setStyleAndWidthAllowed | ( | IlBoolean | allow | ) |
Specifies if dashed style can be used for lines of width greater than 1.
IlTrue, the produced graphic objects can have a different aspect on Unix, Windows NT or Windows 98. | allow | If IlTrue, line style can be used for lines of width greater than 1. |
© 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.