Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMapSegmentRing Class Reference

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

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

Inheritance diagram for IlvMapSegmentRing:
IlvMapRing IlvMapArea IlvMapGeometry

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 IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
const IlvMapSegmentStringgetSegmentStroke () const
 Returns the stroke of the object. More...
 
virtual const IlvMapCurvegetStroke () const
 Returns the stroke of the area. More...
 
virtual const IlvMapGeometrygetSubElement (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...
 
IlvMapSegmentStringsetStroke (IlvMapSegmentString *stroke)
 Sets the stroke of the object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfoClassInfo ()
 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::IlvMapSegmentRing ( IlvMapSegmentString stroke)

Initializes an instance of the class with its stroke.

Parameters
strokeThe stroke. This parameter should not be null. The IlvMapSegmentRing becomes the owner of stroke.
IlvMapSegmentRing::IlvMapSegmentRing ( const IlvMapSegmentRing source)

Creates a segment ring by copying an existing one.

Parameters
sourceThe source segment ring.

Member Function Documentation

virtual IlBoolean IlvMapSegmentRing::contains ( const IlvCoordinate coordinate) const
virtual

Returns IlTrue if coordinate is contained in the object.

Parameters
coordinateThe point to be checked.
Returns
IlTrue if coordinate is contained in the object.

Implements IlvMapRing.

virtual IlvMapGeometry* IlvMapSegmentRing::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapRing.

virtual IlvClassInfo* IlvMapSegmentRing::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapRing.

const IlvMapSegmentString* IlvMapSegmentRing::getSegmentStroke ( ) const

Returns the stroke of the object.

Returns
The stroke of the object.
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.

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

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.

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.

IlvMapSegmentString* IlvMapSegmentRing::setStroke ( IlvMapSegmentString stroke)

Sets the stroke of the object.

Parameters
strokeThe new stroke. In this operation, the IlvMapSegmentRing object becomes owner of stroke.
Returns
The previous stroke that must be deleted by the user.

© Copyright 2016, 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.