IlvMapCircularRing Class Reference

This class defines a ring whose stroke is an IlvMapCircle. More...

Inheritance diagram for IlvMapCircularRing:

List of all members.

Public Member Functions
	IlvMapCircularRing (const IlvMapCircularRing &source)
	Creates a ring by copying an existing one.
	IlvMapCircularRing (IlvMapCircle *stroke)
	Initializes an instance of the class with its stroke.
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 IlvMapCircle *	getCircularStroke () const
	Returns the stroke of the object.
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.
IlvMapCircle *	setStroke (IlvMapCircle *stroke)
	Sets the stroke of the object.

---

Detailed Description

This class defines a ring whose stroke is an IlvMapCircle.

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

---

Constructor & Destructor Documentation

IlvMapCircularRing::IlvMapCircularRing

(

IlvMapCircle *

stroke

)

Initializes an instance of the class with its stroke.

Parameters:

stroke

The stroke. This parameter should not be null. The IlvMapCircularRing becomes owner of stroke.

IlvMapCircularRing::IlvMapCircularRing

(

const IlvMapCircularRing &

source

)

Creates a ring by copying an existing one.

Parameters:

source

The source segment ring.

---

Member Function Documentation

virtual IlBoolean IlvMapCircularRing::contains

(

const IlvCoordinate &

coordinate

)

const [virtual]

Returns IlTrue if coordinate is contained in the object.

Parameters:

coordinate

The point to be checked.

Returns:

IlTrue if coordinate is contained in the object.

Implements IlvMapRing.

virtual IlvMapGeometry* IlvMapCircularRing::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapRing.

const IlvMapCircle* IlvMapCircularRing::getCircularStroke

(

)

const

Returns the stroke of the object.

Returns:

The stroke of the object.

virtual IlvClassInfo* IlvMapCircularRing::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapRing.

virtual const IlvMapCurve* IlvMapCircularRing::getStroke

(

)

const [virtual]

Returns the stroke of the area.

Returns:

An IlvCurve object that should not be deleted nor modified.

Implements IlvMapRing.

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

IlvMapCircle* IlvMapCircularRing::setStroke

(

IlvMapCircle *

stroke

)

Sets the stroke of the object.

Parameters:

stroke

The new stroke. In this operation, the IlvMapCircularRing object becomes owner of stroke.

Returns:

The previous stroke that must be deleted by the user.