IlvMapCurveString Class Reference

This implementation fo the IlvMapSegmentString class supports any sequence of IlvMapSegment. More...

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

Inheritance diagram for IlvMapCurveString:

List of all members.

Public Member Functions
	IlvMapCurveString (const IlvMapCurveString &source)
	Creates a segment string by copying an existing one.
	IlvMapCurveString ()
	Constructor.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
virtual const IlvCoordinate &	getEndPoint () const
	Returns the end point of the last segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).
virtual IlUInt	getHorizontalIntersectionCount (const IlvCoordinate &point) const
virtual const IlvMapSegment *	getSegment (IlUInt index) const
	Returns the segment of index index.
virtual IlUInt	getSegmentCount () const
	Returns the number of segments contained in the string.
virtual const IlvCoordinate &	getStartPoint () const
	Returns the start point of the first segment, if it exists, otherwise, it returns an IlvCoordinate set to (0,0).
void	joinSegment (IlvMapSegment *segment)
	Joins a segment at the end of the string.
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.
virtual void	setStartPoint (const IlvCoordinate &start)
	Sets the start point of the first segment.

---

Detailed Description

This implementation fo the IlvMapSegmentString class supports any sequence of IlvMapSegment.

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

---

Constructor & Destructor Documentation

IlvMapCurveString::IlvMapCurveString

(

)

Constructor.

Initializes an instance of the class.

IlvMapCurveString::IlvMapCurveString

(

const IlvMapCurveString &

source

)

Creates a segment string by copying an existing one.

Parameters:

source

The source segment string.

---

Member Function Documentation

virtual IlvMapGeometry* IlvMapCurveString::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapSegmentString.

virtual IlvClassInfo* IlvMapCurveString::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapSegmentString.

virtual const IlvCoordinate& IlvMapCurveString::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 IlvMapCurveString::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:

point

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

virtual const IlvMapSegment* IlvMapCurveString::getSegment

(

IlUInt

index

)

const [virtual]

Returns the segment of index index.

Parameters:

index

The 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 IlvMapCurveString::getSegmentCount

(

)

const [virtual]

Returns the number of segments contained in the string.

Returns:

The number of segments.

Implements IlvMapSegmentString.

virtual const IlvCoordinate& IlvMapCurveString::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 IlvMapCurveString::joinSegment

(

IlvMapSegment *

segment

)

Joins a segment at the end of the string.

The last point of the preceding segment is moved to fit the starting point of the segment given as argument. In this operation, the IlvMapCurveString object becomes owner of segment.

Parameters:

segment

The segment to be joined.

virtual void IlvMapCurveString::setEndPoint

(

const IlvCoordinate &

end

)

[virtual]

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

Otherwise, it does nothing.

Parameters:

end

The end point.

Implements IlvMapSegmentString.

virtual void IlvMapCurveString::setStartPoint

(

const IlvCoordinate &

start

)

[virtual]

Sets the start point of the first segment.

Parameters:

start

The start point.

Implements IlvMapSegmentString.