Rogue Wave Views 5.5.1 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
This class defines an area that is composed of a list of IlvMapArea
.
More...
Public Member Functions | |
IlvMapMultiArea (const IlvMapMultiArea &source) | |
Creates a multi area by copying an existing one. | |
IlvMapMultiArea () | |
Constructor. | |
void | addArea (IlvMapArea *area) |
Adds an area. In this operation, the multi area becomes owner of the area. | |
virtual IlBoolean | contains (const IlvCoordinate &coordinate) const |
Returns IlTrue if coordinate is contained in the object. | |
virtual IlvMapGeometry * | copy () const |
Returns a copy of the object. | |
const IlvMapArea * | getArea (IlUInt i) const |
Returns the area of index i. | |
IlUInt | getCardinal () const |
Returns the number of areas. | |
virtual IlvClassInfo * | getClassInfo () const |
Returns the IlvClassInfo of the instance. | |
virtual const IlvMapCurve * | getStroke () const |
Returns the stroke of the area. | |
virtual const IlvMapGeometry * | getSubElement (IlUInt index) const |
Returns the sub element of index index if the geometry is a collection. | |
virtual IlUInt | getSubElementCount () const |
Returns the number of elements contained in the geometry if the geometry is a collection. | |
virtual IlBoolean | isCollection () const |
Returns IlTrue if the geometry is a collection of other geometries. | |
void | removeAll () |
Removes and deletes all the areas. | |
IlvMapArea * | removeArea (const IlvMapArea *area) |
Removes the specified area and returns it. |
This class defines an area that is composed of a list of IlvMapArea
.
The instances of this class can be rendered by an IlvDefaultFeatureRenderer
or by an IlvDefaultAreaRenderer
. Library: ilvmaps
IlvMapMultiArea::IlvMapMultiArea | ( | ) |
Constructor.
Initializes an instance of the class.
IlvMapMultiArea::IlvMapMultiArea | ( | const IlvMapMultiArea & | source | ) |
Creates a multi area by copying an existing one.
source | The source area. |
void IlvMapMultiArea::addArea | ( | IlvMapArea * | area | ) |
Adds an area. In this operation, the multi area becomes owner of the area.
area | The area to be added. |
virtual IlBoolean IlvMapMultiArea::contains | ( | const IlvCoordinate & | coordinate | ) | const [virtual] |
Returns IlTrue
if coordinate is contained in the object.
coordinate | The point to be checked. |
IlTrue
if coordinate is contained in the object. Implements IlvMapArea.
virtual IlvMapGeometry* IlvMapMultiArea::copy | ( | ) | const [virtual] |
Returns a copy of the object.
IlvMapGeometry
that must be deleted by the user. Implements IlvMapArea.
const IlvMapArea* IlvMapMultiArea::getArea | ( | IlUInt | i | ) | const |
Returns the area of index i.
i | The index that should be between 0 and getCardinal() - 1 |
IlvMapArea
object that should not be modified nor deleted. IlUInt IlvMapMultiArea::getCardinal | ( | ) | const |
Returns the number of areas.
virtual IlvClassInfo* IlvMapMultiArea::getClassInfo | ( | ) | const [virtual] |
Returns the IlvClassInfo
of the instance.
IlvClassInfo
that should not be modified nor deleted. Implements IlvMapArea.
virtual const IlvMapCurve* IlvMapMultiArea::getStroke | ( | ) | const [virtual] |
Returns the stroke of the area.
IlvCurve
object that should not be deleted nor modified. Implements IlvMapArea.
virtual const IlvMapGeometry* IlvMapMultiArea::getSubElement | ( | IlUInt | index | ) | const [virtual] |
Returns the sub element of index index if the geometry is a collection.
Otherwise, it returns a null pointer.
Implements IlvMapGeometry.
virtual IlUInt IlvMapMultiArea::getSubElementCount | ( | ) | const [virtual] |
Returns the number of elements contained in the geometry if the geometry is a collection.
Otherwise, it returns 0
.
0
. Implements IlvMapGeometry.
virtual IlBoolean IlvMapMultiArea::isCollection | ( | ) | const [virtual] |
Returns IlTrue
if the geometry is a collection of other geometries.
The composite geometries predefined in Rogue Wave Views Maps are: IlvMapGeometryCollection, IlvMapMultiPoint, IlvMapSegmentString
and its subclasses, IlvMapMultiCurve
and IlvMapMultiArea
.
IlTrue
if the geometry is a collection of other geometries. Implements IlvMapGeometry.
IlvMapArea* IlvMapMultiArea::removeArea | ( | const IlvMapArea * | area | ) |
Removes the specified area and returns it.
If the area is not part of the multi area, the function returns a null pointer.
A | null pointer if area is not a member of the object, or an IlvMapArea that should be deleted by the user. |
© Copyright 2012, 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.