IlvMapLineRenderingStyle Class Reference

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

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

Inheritance diagram for IlvMapLineRenderingStyle:

Public Member Functions
	IlvMapLineRenderingStyle (IlvDisplay *display)
	Initializes an instance of the renderer. More...
	IlvMapLineRenderingStyle (const IlvMapLineRenderingStyle &source)
	Copies this rendering style. 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
	Returns IlTrue 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 IlvOutputFile. More...
void	unLock ()
	Unlocks the object. More...

Protected Member Functions
virtual	~IlvMapLineRenderingStyle ()
	Destructor. More...
Protected Member Functions inherited from IlvMapRenderingStyle
	IlvMapRenderingStyle (IlvDisplay *display)
	The constructor of this abstract class is protected. More...
	IlvMapRenderingStyle (const IlvMapRenderingStyle &source)
	Creates a renderer by copying an existing 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...

Detailed Description

This rendering style stores style parameters to draw lines.

Library: ilvmaps

Constructor & Destructor Documentation

IlvMapLineRenderingStyle() [1/2]

IlvMapLineRenderingStyle::IlvMapLineRenderingStyle

(

IlvDisplay *

display

)

Initializes an instance of the renderer.

Parameters

display

The display used to create the graphic settings.

IlvMapLineRenderingStyle() [2/2]

IlvMapLineRenderingStyle::IlvMapLineRenderingStyle

(

const IlvMapLineRenderingStyle &

source

)

Copies this rendering style.

Parameters

source

The object to be copied.

~IlvMapLineRenderingStyle()

virtual IlvMapLineRenderingStyle::~IlvMapLineRenderingStyle ( )

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

getForeground()

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.

getLineStyle()

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.

getLineWidth()

IlUShort IlvMapLineRenderingStyle::getLineWidth

(

)

const

Returns the line width used for the lines.

Returns

The line width.

getPalette()

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

isStyleAndWidthAllowed()

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.

setForeground() [1/2]

void IlvMapLineRenderingStyle::setForeground

(

IlvColor *

color

)

Sets the foreground of the lines.

Note

This is a convenience function that can be used instead of setPalette().

Parameters

color

The color used as foreground.

setForeground() [2/2]

IlvMapsError IlvMapLineRenderingStyle::setForeground

(

const char *

colorName

)

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

Note

This function is a convenience function that can be used instead of setPalette().

Parameters

colorName

The name of the color.

Returns

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

setLineStyle() [1/2]

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.

Note

This function is a convenience function that can be used instead of setPalette().

Parameters

lineStyle

The line style.

setLineStyle() [2/2]

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.

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.

setLineWidth()

void IlvMapLineRenderingStyle::setLineWidth

(

IlUShort

lineWidth

)

Sets the line width of the lines.

A line width higher than 1 removes the line style.

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.

setPalette()

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.

setStyleAndWidthAllowed()

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.