Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMapGeneralPath Class Reference

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

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

Inheritance diagram for IlvMapGeneralPath:
IlvSimpleGraphic IlvGraphic IlvValueInterface

Public Member Functions

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

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
displayThe display on which this general path is displayed.
drawRuleThe draw rule of this object. If not specified, defaults to IlvStrokeAndFill.
paletteThe 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
intermediatePointA point that is on the arc.
endPointThe 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
endPointThe 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
newPointThe new point.
virtual void IlvMapGeneralPath::setAlpha ( IlvIntensity  alpha)
virtual

Changes the alpha value for this object.

Parameters
alphathe alpha value defining the transparency.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setBackground ( IlvColor bg)
virtual

Changes the background of this object.

Parameters
bgThe new background color.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setDrawRule ( IlvDrawRule  rule)

Sets the draw rule for this IlvMapGeneralPath.

Parameters
ruleThe new draw rule.
void IlvMapGeneralPath::setFillBackground ( IlvColor bg)

Change the fill background of this object.

Parameters
bgThe new fill background color.
void IlvMapGeneralPath::setFillForeground ( IlvColor fg)

Change the fill foreground of this object.

Parameters
fgThe new fill foreground color.
void IlvMapGeneralPath::setFillPalette ( IlvPalette pal)

Sets the palette used to fill this object.

Parameters
palThe new palette.
void IlvMapGeneralPath::setForeground ( IlvColor fg)
virtual

Changes the foreground of this object.

Parameters
fgThe new foreground color.

Reimplemented from IlvSimpleGraphic.

void IlvMapGeneralPath::setPalette ( IlvPalette pal)
virtual

Changes the palette for this object.

Parameters
palThe new palette.

Reimplemented from IlvSimpleGraphic.


© Copyright 2016, 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.