IlvMapPoint Class Reference

This class defines a point. More...

Inheritance diagram for IlvMapPoint:

List of all members.

Public Member Functions
	IlvMapPoint (const IlvCoordinate &point)
	Initializes an IlvMapPoint with the specified coordinate.
	IlvMapPoint (const IlvMapPoint &source)
	Creates a point by copying an existing point.
	IlvMapPoint ()
	Constructor.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
const IlvCoordinate &	getPoint () const
	Returns the position of the point.
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	setPoint (const IlvCoordinate &point)
	Changes the value of the coordinate.

---

Detailed Description

This class defines a point.

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

---

Constructor & Destructor Documentation

IlvMapPoint::IlvMapPoint

(

)

Constructor.

Initializes an instance of IlvMapPoint.

IlvMapPoint::IlvMapPoint

(

const IlvMapPoint &

source

)

Creates a point by copying an existing point.

Parameters:

source

The source point.

IlvMapPoint::IlvMapPoint

(

const IlvCoordinate &

point

)

Initializes an IlvMapPoint with the specified coordinate.

Parameters:

point

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

---

Member Function Documentation

virtual IlvMapGeometry* IlvMapPoint::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapGeometry.

virtual IlvClassInfo* IlvMapPoint::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapGeometry.

const IlvCoordinate& IlvMapPoint::getPoint

(

)

const

Returns the position of the point.

Returns:

The position of the point.

virtual const IlvMapGeometry* IlvMapPoint::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 IlvMapPoint::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 IlvMapPoint::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.

void IlvMapPoint::setPoint

(

const IlvCoordinate &

point

)

Changes the value of the coordinate.

Parameters:

point

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