IlvMapSegmentRing Class Reference

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

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

Inheritance diagram for IlvMapSegmentRing:

Public Member Functions
	IlvMapSegmentRing (IlvMapSegmentString *stroke)
	Initializes an instance of the class with its stroke. More...
	IlvMapSegmentRing (const IlvMapSegmentRing &source)
	Creates a segment ring by copying an existing one. More...
virtual IlBoolean	contains (const IlvCoordinate &coordinate) const
	Returns IlTrue if coordinate is contained in the object. More...
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object. More...
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance. More...
const IlvMapSegmentString *	getSegmentStroke () const
	Returns the stroke of the object. More...
virtual const IlvMapCurve *	getStroke () const
	Returns the stroke of the area. More...
virtual const IlvMapGeometry *	getSubElement (IlUInt index) 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...
IlvMapSegmentString *	setStroke (IlvMapSegmentString *stroke)
	Sets the stroke of the object. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfo *	ClassInfo ()
	Returns the class info. More...
Protected Member Functions inherited from IlvMapRing
	IlvMapRing ()
	Constructor. More...
Protected Member Functions inherited from IlvMapArea
	IlvMapArea ()
	Constructor. More...
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class defines a ring whose stroke is an IlvMapSegmentString.

The IlvMapSegmentString should be closed, which means that its start point should be the same as its end point. If the IlvMapSegmentString is not closed, the assumption is performed that it is closed by an IlvMapLinearSegment. The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultAreaRenderer. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapSegmentRing() [1/2]

IlvMapSegmentRing::IlvMapSegmentRing

(

IlvMapSegmentString *

stroke

)

Initializes an instance of the class with its stroke.

Parameters

stroke

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

IlvMapSegmentRing() [2/2]

IlvMapSegmentRing::IlvMapSegmentRing

(

const IlvMapSegmentRing &

source

)

Creates a segment ring by copying an existing one.

Parameters

source

The source segment ring.

Member Function Documentation

contains()

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

copy()

virtual IlvMapGeometry* IlvMapSegmentRing::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapRing.

getClassInfo()

virtual IlvClassInfo* IlvMapSegmentRing::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapRing.

getSegmentStroke()

const IlvMapSegmentString* IlvMapSegmentRing::getSegmentStroke

(

)

const

Returns the stroke of the object.

Returns

The stroke of the object.

getStroke()

virtual const IlvMapCurve* IlvMapSegmentRing::getStroke ( ) const

virtual

Returns the stroke of the area.

Returns

An IlvCurve object that should not be deleted nor modified.

Implements IlvMapRing.

getSubElement()

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

virtual

Returns a sub element of a collection geometry.

Parameters

index

The 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 IlvMapSegmentRing::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 IlvMapSegmentRing::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.

setStroke()

IlvMapSegmentString* IlvMapSegmentRing::setStroke

(

IlvMapSegmentString *

stroke

)

Sets the stroke of the object.

Parameters

stroke

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

Returns

The previous stroke that must be deleted by the user.