rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvMapLineString Class Reference

This subclass of IlvMapSegmentString is optimized to handle strings that contain only IlvMapLinearSegment instances. More...

Inheritance diagram for IlvMapLineString:
IlvMapSegmentString IlvMapSegment IlvMapCurve IlvMapGeometry

Public Member Functions

 IlvMapLineString ()
 Constructor. More...
 
 IlvMapLineString (const IlvCoordinate &startPoint)
 Initializes an instance of the class and specifies the first point of the string. More...
 
 IlvMapLineString (const IlvMapLineString &source)
 Creates a line string by copying an existing one. More...
 
virtual IlvMapGeometrycopy () const
 Returns a copy of the object. More...
 
virtual IlvClassInfogetClassInfo () const
 Returns the IlvClassInfo of the instance. More...
 
virtual const IlvCoordinategetEndPoint () const
 Returns the end point of the last segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0). More...
 
virtual IlUInt getHorizontalIntersectionCount (const IlvCoordinate &point) const
 
const IlvMapLinearSegmentgetLinearSegment (IlUInt index) const
 Returns the linear segment of index index. More...
 
const IlvCoordinategetPoint (IlUInt index) const
 Returns the point at location index in the string. More...
 
IlUInt getPointCount () const
 Returns the number of points contained in the string. More...
 
virtual const IlvMapSegmentgetSegment (IlUInt index) const
 Returns the segment of index index. More...
 
virtual IlUInt getSegmentCount () const
 Returns the number of segments contained in the string. More...
 
virtual const IlvCoordinategetStartPoint () const
 Returns the start point of the first segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0). More...
 
void lineTo (const IlvCoordinate &end)
 Appends a new linear segment to the string. More...
 
virtual void removeAll ()
 Removes all the segments in the string and sets the start point to (0,0).
 
virtual void setEndPoint (const IlvCoordinate &end)
 Sets the end point of the last segment if it exists. More...
 
virtual void setStartPoint (const IlvCoordinate &start)
 Sets the start point of the first segment. More...
 
- Public Member Functions inherited from IlvMapSegmentString
virtual const IlvMapGeometrygetSubElement (IlUInt index) const
 Returns the sub element of index index if the geometry is a collection. 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
 Returns IlTrue if the geometry is a collection of other geometries. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfoClassInfo ()
 Returns the class info. More...
 
- Protected Member Functions inherited from IlvMapSegmentString
 IlvMapSegmentString ()
 Constructor. More...
 

Detailed Description

This subclass of IlvMapSegmentString is optimized to handle strings that contain only IlvMapLinearSegment instances.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer.

See Also
IlvMapCurveString Library: ilvmaps

Constructor & Destructor Documentation

IlvMapLineString::IlvMapLineString ( )

Constructor.

Initializes an instance of the class and sets the start point to (0, 0).

IlvMapLineString::IlvMapLineString ( const IlvCoordinate startPoint)

Initializes an instance of the class and specifies the first point of the string.

Parameters
startPointThe start point.
IlvMapLineString::IlvMapLineString ( const IlvMapLineString source)

Creates a line string by copying an existing one.

Parameters
sourceThe source line string.

Member Function Documentation

virtual IlvMapGeometry* IlvMapLineString::copy ( ) const
virtual

Returns a copy of the object.

Returns
An IlvMapGeometry that must be deleted by the user.

Implements IlvMapSegmentString.

virtual IlvClassInfo* IlvMapLineString::getClassInfo ( ) const
virtual

Returns the IlvClassInfo of the instance.

Returns
An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapSegmentString.

virtual const IlvCoordinate& IlvMapLineString::getEndPoint ( ) const
virtual

Returns the end point of the last segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).

Returns
The end point.

Implements IlvMapSegmentString.

virtual IlUInt IlvMapLineString::getHorizontalIntersectionCount ( const IlvCoordinate point) const
virtual

Returns the number of intersections between an horizontal half line defined by its right extremity point and the segment. This function is used for point inclusion tests of IlvMapRing.

Parameters
pointThe point at the right extremity of the horizontal half line.
Returns
The number of intersections between the point and the segment. Tangent intersections should be counted as: 1 if the point is on the segment, 2 if the point is not on the segment. If the point is on the segment where the tangent is not horizontal, the intersection should not be counted.

Implements IlvMapSegment.

const IlvMapLinearSegment* IlvMapLineString::getLinearSegment ( IlUInt  index) const

Returns the linear segment of index index.

Parameters
indexThe index of the segment to be retrieved. index must have a value between 0 and getSegmentCount() -1.
Returns
An IlvMapLinearSegment object that should not be modified nor deleted by the user. The returned IlvMapSegment is volatile. This means that it may be modified or deleted by the IlvMapSegmentString istelf after another call to this function, or after any modification.
const IlvCoordinate& IlvMapLineString::getPoint ( IlUInt  index) const

Returns the point at location index in the string.

Parameters
indexThe index. It must take a value between 0 and getPointCount() - 1.
Returns
The point at location index in the string.
IlUInt IlvMapLineString::getPointCount ( ) const

Returns the number of points contained in the string.

Returns
The number of points contained in the string.
virtual const IlvMapSegment* IlvMapLineString::getSegment ( IlUInt  index) const
virtual

Returns the segment of index index.

Parameters
indexThe index of the segment to be retrieved. index must have a value between 0 and getSegmentCount() - 1.
Returns
An IlvMapSegment object that should not be modified nor deleted by the user. The returned IlvMapSegment is volatile. This means that it may be modified or deleted by the IlvMapSegmentString itself after an other call to this function, or after any modification.

Implements IlvMapSegmentString.

virtual IlUInt IlvMapLineString::getSegmentCount ( ) const
virtual

Returns the number of segments contained in the string.

Returns
The number of segments.

Implements IlvMapSegmentString.

virtual const IlvCoordinate& IlvMapLineString::getStartPoint ( ) const
virtual

Returns the start point of the first segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).

Returns
The start point.

Implements IlvMapSegmentString.

void IlvMapLineString::lineTo ( const IlvCoordinate end)

Appends a new linear segment to the string.

Parameters
pointThe coordinate of the end of the new segment.
virtual void IlvMapLineString::setEndPoint ( const IlvCoordinate end)
virtual

Sets the end point of the last segment if it exists.

Otherwise, it does nothing.

Parameters
endThe end point.

Implements IlvMapSegmentString.

virtual void IlvMapLineString::setStartPoint ( const IlvCoordinate start)
virtual

Sets the start point of the first segment.

Parameters
startThe start point.

Implements IlvMapSegmentString.


© 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.