Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvMapPoint Class Reference

This class defines a point. More...

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

Inheritance diagram for IlvMapPoint:
IlvMapGeometry

Public Member Functions

 IlvMapPoint ()
 Initializes a new IlvMapPoint instance.
 
 IlvMapPoint (const IlvCoordinate &point)
 Initializes an IlvMapPoint with the specified coordinate. More...
 
 IlvMapPoint (const IlvMapPoint &source)
 Initializes a new IlvMapPoint instance by copying an existing point. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
const IlvCoordinategetPoint () const
 Returns the position of the point. More...
 
virtual const IlvMapGeometrygetSubElement (IlUInt) const
 Returns a sub element of a collection geometry. 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
 Checks if this geometry is a collection of other geometries. More...
 
void setPoint (const IlvCoordinate &point)
 Changes the value of the coordinate. More...
 

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

Library: ilvmaps

The instances of this class can be rendered by an IlvDefaultFeatureRenderer, by an IlvDefaultPointRenderer or by an IlvIconPointRenderer.

Constructor & Destructor Documentation

◆ IlvMapPoint() [1/2]

IlvMapPoint::IlvMapPoint ( const IlvMapPoint source)

Initializes a new IlvMapPoint instance by copying an existing point.

Parameters
sourceThe source point.

◆ IlvMapPoint() [2/2]

IlvMapPoint::IlvMapPoint ( const IlvCoordinate point)

Initializes an IlvMapPoint with the specified coordinate.

Parameters
pointThe coordinate of the point. The object is not copied.

Member Function Documentation

◆ copy()

virtual IlvMapGeometry* IlvMapPoint::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

◆ getClassInfo()

virtual IlvClassInfo* IlvMapPoint::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

◆ getPoint()

const IlvCoordinate& IlvMapPoint::getPoint ( ) const

Returns the position of the point.

Returns
The position of the point.

◆ getSubElement()

virtual const IlvMapGeometry* IlvMapPoint::getSubElement ( IlUInt  index) const
virtual

Returns a sub element of a collection geometry.

Parameters
indexThe index of the sub-geometry to be retrieved.
Returns
The sub element of index index if the geometry is a collection or 0 if it is not.

Implements IlvMapGeometry.

◆ getSubElementCount()

virtual IlUInt IlvMapPoint::getSubElementCount ( ) const
virtual

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

Returns
The number of elements contained in the geometry if the geometry is a collection. If it is not, this method returns 0.

Implements IlvMapGeometry.

◆ isCollection()

virtual IlBoolean IlvMapPoint::isCollection ( ) const
virtual

Checks if this 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.

◆ setPoint()

void IlvMapPoint::setPoint ( const IlvCoordinate point)

Changes the value of the coordinate.

Parameters
pointThe coordinate of the point.