IlvMapGeneralPath Class Reference

The IlvMapGeneralPath class represents a geometric path constructed from segments. More...

#include <ilviews/maps/graphics/mapgenpath.h>

Inheritance diagram for IlvMapGeneralPath:

List of all members.

Public Member Functions
	IlvMapGeneralPath (IlvDisplay *display, IlvDrawRule drawRule=IlvStrokeAndFill, IlvPalette *palette=0)
	Initializes a new empty IlvMapGeneralPath.
void	arcTo (const IlvPoint &intermediatePoint, const IlvPoint &endPoint)
	Adds an arc defined by 3 points to the current path.
IlvDrawRule	getDrawRule () const
	Returns the current draw rule used for this IlvMapGeneralPath.
IlvPalette *	getFillPalette () const
	Returns the palette used to fill this object.
void	lineTo (const IlvPoint &endPoint)
	Adds a straight segment to the current path.
void	moveTo (const IlvPoint &newPoint)
	Adds a new point to the path by moving to the specified coordinates.
virtual void	setAlpha (IlvIntensity alpha)
	Changes the alpha value for this object.
void	setBackground (IlvColor *bg)
	Changes the background of this object.
void	setDrawRule (IlvDrawRule rule)
	Sets the draw rule for this IlvMapGeneralPath.
void	setFillBackground (IlvColor *bg)
	Change the fill background of this object.
void	setFillForeground (IlvColor *fg)
	Change the fill foreground of this object.
void	setFillPalette (IlvPalette *pal)
	Sets the palette used to fill this object.
void	setForeground (IlvColor *fg)
	Changes the foreground of this object.
void	setPalette (IlvPalette *pal)
	Changes the palette for this object.

---

Detailed Description

The IlvMapGeneralPath class represents a geometric path constructed from segments.

Library: ilvmaps

This class represents a geometric path constructed from straight lines and arcs. An IlvMapGeneralPath can contain multiple subpaths.

See also:

IlvMaps

IlvDrawRule

---

Constructor & Destructor Documentation

IlvMapGeneralPath::IlvMapGeneralPath	(	IlvDisplay *	display,
		IlvDrawRule	drawRule = IlvStrokeAndFill,
		IlvPalette *	palette = 0
	)

Initializes a new empty IlvMapGeneralPath.

Parameters:

	display	The display on which this general path is displayed.
	drawRule	The draw rule of this object. If not specified, defaults to IlvStrokeAndFill.
	palette	The palette to display this graphic object. If not specified, the default palette from display is used.

See also:

IlvDrawRule

---

Member Function Documentation

void IlvMapGeneralPath::arcTo	(	const IlvPoint &	intermediatePoint,
		const IlvPoint &	endPoint
	)

Adds an arc defined by 3 points to the current path.

Adds an arc to the current path by drawing an arc from the current coordinates to the specified endPoint. This circular arc is constructed so that the current point is the arc starting point, the specified intermediatePoint is on the arc, and the specified endPoint is the arc end point.

Parameters:

	intermediatePoint	A point that is on the arc.
	endPoint	The arc end point.

IlvDrawRule IlvMapGeneralPath::getDrawRule

(

)

const

Returns the current draw rule used for this IlvMapGeneralPath.

Returns:

The current IlvDrawRule

IlvPalette* IlvMapGeneralPath::getFillPalette

(

)

const

Returns the palette used to fill this object.

Returns:

The palette used to fill this object.

void IlvMapGeneralPath::lineTo

(

const IlvPoint &

endPoint

)

Adds a straight segment to the current path.

Adds a point to the current path by drawing a straight line from the current coordinates to the new specified point.

Parameters:

endPoint

The specified point.

void IlvMapGeneralPath::moveTo

(

const IlvPoint &

newPoint

)

Adds a new point to the path by moving to the specified coordinates.

Adds a point to the path by moving to the specified coordinates.

Parameters:

newPoint

The new point.

virtual void IlvMapGeneralPath::setAlpha

(

IlvIntensity

alpha

)

[virtual]

Changes the alpha value for this object.

Parameters:

alpha

the alpha value defining the transparency.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setBackground

(

IlvColor *

bg

)

[virtual]

Changes the background of this object.

Parameters:

bg

The new background color.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setDrawRule

(

IlvDrawRule

rule

)

Sets the draw rule for this IlvMapGeneralPath.

Parameters:

rule

The new draw rule.

void IlvMapGeneralPath::setFillBackground

(

IlvColor *

bg

)

Change the fill background of this object.

Parameters:

bg

The new fill background color.

void IlvMapGeneralPath::setFillForeground

(

IlvColor *

fg

)

Change the fill foreground of this object.

Parameters:

fg

The new fill foreground color.

void IlvMapGeneralPath::setFillPalette

(

IlvPalette *

pal

)

Sets the palette used to fill this object.

Parameters:

pal

The new palette.

void IlvMapGeneralPath::setForeground

(

IlvColor *

fg

)

[virtual]

Changes the foreground of this object.

Parameters:

fg

The new foreground color.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setPalette

(

IlvPalette *

pal

)

[virtual]

Changes the palette for this object.

Parameters:

pal

The new palette.

Reimplemented from IlvSimpleGraphic.