IlvMapLineRenderingStyle Class Reference

This rendering style stores style parameters to draw lines. More...

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

Inheritance diagram for IlvMapLineRenderingStyle:

List of all members.

Public Member Functions
	IlvMapLineRenderingStyle (const IlvMapLineRenderingStyle &source)
	Copies this rendering style.
	IlvMapLineRenderingStyle (IlvDisplay *display)
	Initializes an instance of the renderer.
IlvColor *	getForeground () const
	Returns the foreground used to create the lines.
IlvLineStyle *	getLineStyle () const
	Returns the style used by the renderer to draw the lines.
IlUShort	getLineWidth () const
	Returns the line width used for the lines.
IlvPalette *	getPalette () const
	Returns the palette used to create the graphic objects.
IlBoolean	isStyleAndWidthAllowed () const
	Returns IlTrue if dashed style can be used for lines of width greater than 1.
IlvMapsError	setForeground (const char *colorName)
	Sets the foreground of the lines by specifying a color name.
void	setForeground (IlvColor *color)
	Sets the foreground of the lines.
IlvMapsError	setLineStyle (const char *lineStyleName)
	Sets the array representing the lengths of the dash segments of the lines.
void	setLineStyle (IlvLineStyle *lineStyle)
	Sets the array representing the lengths of the dash segments of the lines.
void	setLineWidth (IlUShort lineWidth)
	Sets the line width of the lines.
void	setPalette (IlvPalette *palette)
	Sets the palette used to create the graphic objects.
void	setStyleAndWidthAllowed (IlBoolean allow)
	Specifies if dashed style can be used for lines of width greater than 1.
Protected Member Functions
virtual	~IlvMapLineRenderingStyle ()
	Destructor.

---

Detailed Description

This rendering style stores style parameters to draw lines.

Library: ilvmaps

---

Constructor & Destructor Documentation

virtual IlvMapLineRenderingStyle::~IlvMapLineRenderingStyle

(

)

[protected, virtual]

Destructor.

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

See also:

IlvMapRenderingStyle::lock, IlvMapRenderingStyle::unLock

IlvMapLineRenderingStyle::IlvMapLineRenderingStyle

(

IlvDisplay *

display

)

Initializes an instance of the renderer.

Parameters:

display

The display used to create the graphic settings.

IlvMapLineRenderingStyle::IlvMapLineRenderingStyle

(

const IlvMapLineRenderingStyle &

source

)

Copies this rendering style.

Parameters:

source

The object to be copied.

---

Member Function Documentation

IlvColor* IlvMapLineRenderingStyle::getForeground

(

)

const

Returns the foreground used to create the lines.

Returns:

A null pointer 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.

Returns:

A null pointer 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.

Returns:

The line width.

IlvPalette* IlvMapLineRenderingStyle::getPalette

(

)

const

Returns the palette used to create 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 another object has to use it.

See also:

IlvResource::lock()

IlBoolean IlvMapLineRenderingStyle::isStyleAndWidthAllowed

(

)

const

Returns IlTrue if dashed style can be used for lines of width greater than 1.

Returns:

IlTrue if a line style can be used for lines of width greater than 1.

IlvMapsError IlvMapLineRenderingStyle::setForeground

(

const char *

colorName

)

Sets the foreground of the lines by specifying a color name.

Warning:

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

Parameters:

The

name of the color.

Returns:

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

void IlvMapLineRenderingStyle::setForeground

(

IlvColor *

color

)

Sets the foreground of the lines.

Warning:

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

Parameters:

color

The color used as foreground.

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.

Warning:

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

Parameters:

lineStyleName

The name of a style.

Returns:

IlvMapsError::NoError() or IlvMaps::IllegalArgument() if the line style name cannot be translated into an IlvLineStyle.

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.

Warning:

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

Parameters:

lineStyle

The line style.

void IlvMapLineRenderingStyle::setLineWidth

(

IlUShort

lineWidth

)

Sets the line width of the lines.

A line width higher than 1 removes the line style.

Warning:

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

Parameters:

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.

Parameters:

palette

The palette.

void IlvMapLineRenderingStyle::setStyleAndWidthAllowed

(

IlBoolean

allow

)

Specifies if dashed style can be used for lines of width greater than 1.

Warning:

If this function is called with allow set to IlTrue, the produced graphic objects can have a different aspect on Unix, Windows NT or Windows 98.

Parameters:

allow

If IlTrue, line style can be used for lines of width greater than 1.