rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvMapMultiPoint Class Reference

This class defines a multipoint, which is a collection of points. More...

#include <ilviews/maps/geometry/geompoint.h>

Inheritance diagram for IlvMapMultiPoint:
IlvMapGeometry

Public Member Functions

 IlvMapMultiPoint ()
 Constructor. More...
 
 IlvMapMultiPoint (const IlvMapMultiPoint &source)
 Creates a multipoint by copying an existing one. More...
 
void addPoint (const IlvCoordinate &c)
 Adds a coordinate at the end of the multipoint. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
const IlvCoordinategetPoint (IlUInt index) const
 Returns the coordinate of the specified index. More...
 
IlUInt getPointCount () const
 Returns the number of points in the multipoint. More...
 
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns the sub element of index index if the geometry is a collection. More...
 
virtual IlUInt getSubElementCount () const
 Returns the number of elements contained in the geometry if the geometry is a collection. More...
 
virtual IlBoolean isCollection () const
 Returns IlTrue if the geometry is a collection of other geometries. More...
 
void removeAll ()
 Removes all the coordinates from the multipoint.
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfoClassInfo ()
 Returns the class info. More...
 
- Protected Member Functions inherited from IlvMapGeometry
 IlvMapGeometry ()
 Constructor. More...
 

Detailed Description

This class defines a multipoint, which is a collection of points.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapMultiPoint::IlvMapMultiPoint ( )

Constructor.

Initializes an instance of the class.

IlvMapMultiPoint::IlvMapMultiPoint ( const IlvMapMultiPoint source)

Creates a multipoint by copying an existing one.

Parameters
sourceThe source multipoint.

Member Function Documentation

void IlvMapMultiPoint::addPoint ( const IlvCoordinate c)

Adds a coordinate at the end of the multipoint.

Parameters
cThe coordinate.
virtual IlvMapGeometry* IlvMapMultiPoint::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

virtual IlvClassInfo* IlvMapMultiPoint::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

const IlvCoordinate& IlvMapMultiPoint::getPoint ( IlUInt  index) const

Returns the coordinate of the specified index.

Parameters
indexThe index.
Returns
The coordinate of the specified index.
IlUInt IlvMapMultiPoint::getPointCount ( ) const

Returns the number of points in the multipoint.

Returns
The number of points in the multipoint.
virtual const IlvMapGeometry* IlvMapMultiPoint::getSubElement ( IlUInt  index) const
virtual

Returns the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns
The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapMultiPoint::getSubElementCount ( ) const
virtual

Returns the number of elements contained in the geometry if the geometry is a collection.

Otherwise, it returns 0.

Returns
The number of elements contained in the geometry if the geometry is a collection. Otherwise, it returns 0.

Implements IlvMapGeometry.

virtual IlBoolean IlvMapMultiPoint::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.

Returns
IlTrue if the geometry is a collection of other geometries.

Implements IlvMapGeometry.


© 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.