IlvMapLineString Class Reference

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

Inheritance diagram for IlvMapLineString:

List of all members.

Public Member Functions
	IlvMapLineString (const IlvMapLineString &source)
	Creates a line string by copying an existing one.
	IlvMapLineString (const IlvCoordinate &startPoint)
	Initializes an instance of the class and specifies the first point of the string.
	IlvMapLineString ()
	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
const IlvMapLinearSegment *	getLinearSegment (IlUInt index) const
	Returns the linear segment of index index.
const IlvCoordinate &	getPoint (IlUInt index) const
	Returns the point at location index in the string.
IlUInt	getPointCount () const
	Returns the number of points contained in the string.
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	lineTo (const IlvCoordinate &end)
	Appends a new linear segment to 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 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:

startPoint

The start point.

IlvMapLineString::IlvMapLineString

(

const IlvMapLineString &

source

)

Creates a line string by copying an existing one.

Parameters:

source

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

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.

const IlvMapLinearSegment* IlvMapLineString::getLinearSegment

(

IlUInt

index

)

const

Returns the linear 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 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:

index

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

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 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:

point

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

end

The end point.

Implements IlvMapSegmentString.

virtual void IlvMapLineString::setStartPoint

(

const IlvCoordinate &

start

)

[virtual]

Sets the start point of the first segment.

Parameters:

start

The start point.

Implements IlvMapSegmentString.