Rogue Wave Views 5.5.1 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
This class defines a ring whose stroke is an IlvMapSegmentString
.
More...
Public Member Functions | |
IlvMapSegmentRing (const IlvMapSegmentRing &source) | |
Creates a segment ring by copying an existing one. | |
IlvMapSegmentRing (IlvMapSegmentString *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. | |
virtual IlvClassInfo * | getClassInfo () const |
Returns the IlvClassInfo of the instance. | |
const IlvMapSegmentString * | getSegmentStroke () const |
Returns the stroke of the object. | |
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. | |
IlvMapSegmentString * | setStroke (IlvMapSegmentString *stroke) |
Sets the stroke of the object. |
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
IlvMapSegmentRing::IlvMapSegmentRing | ( | IlvMapSegmentString * | stroke | ) |
Initializes an instance of the class with its stroke.
stroke | The 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.
source | The source segment ring. |
virtual IlBoolean IlvMapSegmentRing::contains | ( | const IlvCoordinate & | coordinate | ) | const [virtual] |
Returns IlTrue
if coordinate is contained in the object.
coordinate | The point to be checked. |
IlTrue
if coordinate is contained in the object. Implements IlvMapRing.
virtual IlvMapGeometry* IlvMapSegmentRing::copy | ( | ) | const [virtual] |
Returns a copy of the object.
IlvMapGeometry
that must be deleted by the user. Implements IlvMapRing.
virtual IlvClassInfo* IlvMapSegmentRing::getClassInfo | ( | ) | const [virtual] |
Returns the IlvClassInfo
of the instance.
IlvClassInfo
that should not be modified nor deleted. Implements IlvMapRing.
const IlvMapSegmentString* IlvMapSegmentRing::getSegmentStroke | ( | ) | const |
Returns the stroke of the object.
virtual const IlvMapCurve* IlvMapSegmentRing::getStroke | ( | ) | const [virtual] |
Returns the stroke of the area.
IlvCurve
object that should not be deleted nor modified. Implements IlvMapRing.
virtual const IlvMapGeometry* IlvMapSegmentRing::getSubElement | ( | IlUInt | index | ) | const [virtual] |
Returns the sub element of index index if the geometry is a collection.
Otherwise, it returns a null pointer.
Implements IlvMapGeometry.
virtual IlUInt IlvMapSegmentRing::getSubElementCount | ( | ) | const [virtual] |
Returns the number of elements contained in the geometry if the geometry is a collection.
Otherwise, it returns 0
.
0
. Implements IlvMapGeometry.
virtual IlBoolean IlvMapSegmentRing::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
.
IlTrue
if the geometry is a collection of other geometries. Implements IlvMapGeometry.
IlvMapSegmentString* IlvMapSegmentRing::setStroke | ( | IlvMapSegmentString * | stroke | ) |
Sets the stroke of the object.
stroke | The new stroke. In this operation, the IlvMapSegmentRing object becomes owner of stroke. |
© Copyright 2012, 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.