IlvMapLinearSegment Class Reference

This class defines a linear segment. More...

Inheritance diagram for IlvMapLinearSegment:

List of all members.

Public Member Functions
	IlvMapLinearSegment (const IlvCoordinate &start, const IlvCoordinate &end)
	Creates a linear segment by specifying the start and end point.
	IlvMapLinearSegment (const IlvMapLinearSegment &source)
	Creates a linear segment by copying an existing one.
	IlvMapLinearSegment ()
	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 segment.
virtual IlUInt	getHorizontalIntersectionCount (const IlvCoordinate &point) const
virtual const IlvCoordinate &	getStartPoint () const
	Returns the start point of the segment.
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.
virtual void	setEndPoint (const IlvCoordinate &end)
	Sets the end point of the segment.
virtual void	setStartPoint (const IlvCoordinate &start)
	Sets the start point of the segment.

---

Detailed Description

This class defines a linear segment.

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

---

Constructor & Destructor Documentation

IlvMapLinearSegment::IlvMapLinearSegment

(

)

Constructor.

Initializes an instance of the class.

IlvMapLinearSegment::IlvMapLinearSegment

(

const IlvMapLinearSegment &

source

)

Creates a linear segment by copying an existing one.

Parameters:

source

The source linear segment.

IlvMapLinearSegment::IlvMapLinearSegment	(	const IlvCoordinate &	start,
		const IlvCoordinate &	end
	)

Creates a linear segment by specifying the start and end point.

Parameters:

	start	The start point.
	end	The end point.

---

Member Function Documentation

virtual IlvMapGeometry* IlvMapLinearSegment::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapSegment.

virtual IlvClassInfo* IlvMapLinearSegment::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

virtual const IlvCoordinate& IlvMapLinearSegment::getEndPoint

(

)

const [virtual]

Returns the end point of the segment.

Returns:

The end point.

Implements IlvMapSegment.

virtual IlUInt IlvMapLinearSegment::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 IlvCoordinate& IlvMapLinearSegment::getStartPoint

(

)

const [virtual]

Returns the start point of the segment.

Returns:

The start point.

Implements IlvMapSegment.

virtual const IlvMapGeometry* IlvMapLinearSegment::getSubElement

(

IlUInt

index

)

const [virtual]

Returns the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns:

The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapLinearSegment::getSubElementCount

(

)

const [virtual]

Returns the number of elements contained in the geometry if the geometry is a collection.

Otherwise, it returns 0.

Returns:

The number of elements contained in the geometry if the geometry is a collection. Otherwise, it returns 0.

Implements IlvMapGeometry.

virtual IlBoolean IlvMapLinearSegment::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.

Returns:

IlTrue if the geometry is a collection of other geometries.

Implements IlvMapGeometry.

virtual void IlvMapLinearSegment::setEndPoint

(

const IlvCoordinate &

end

)

[virtual]

Sets the end point of the segment.

Parameters:

end

The end point.

Implements IlvMapSegment.

virtual void IlvMapLinearSegment::setStartPoint

(

const IlvCoordinate &

start

)

[virtual]

Sets the start point of the segment.

Parameters:

start

The start point.

Implements IlvMapSegment.