This abstract class is the base class for segments that can be divided into other smaller segments. More...

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

Inheritance diagram for IlvMapSegmentString:

Public Member Functions
virtual IlvMapGeometry *	copy () const =0
	Returns a copy of the object. More...

virtual IlvClassInfo *	getClassInfo () const =0
	Returns the `IlvClassInfo` of the instance. More...

virtual const IlvCoordinate &	getEndPoint () const =0
	Returns the end point of the last segment. More...

virtual const IlvMapSegment *	getSegment (IlUInt index) const =0
	Returns the segment at a given index. More...

virtual IlUInt	getSegmentCount () const =0
	Returns the number of segments contained in the string. More...

virtual const IlvCoordinate &	getStartPoint () const =0
	Returns the start point of the first segment, if it exists, otherwise, it returns an `IlvCoordinate` set to (0,0). More...

virtual const IlvMapGeometry *	getSubElement (IlUInt) const
	Returns a sub element of a collection geometry. 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
	Checks if this geometry is a collection of other geometries. More...

virtual void	removeAll ()=0
	Removes all the segments in the string and sets the start point to (0,0).

virtual void	setEndPoint (const IlvCoordinate &end)=0
	Sets the end point of the last segment if it exists. More...

virtual void	setStartPoint (const IlvCoordinate &start)=0
	Sets the start point of the first segment. More...

Public Member Functions inherited from IlvMapSegment
virtual IlUInt	getHorizontalIntersectionCount (const IlvCoordinate &point) const =0
	Returns the number of intersections between this segment and an horizontal half line. More...

Protected Member Functions
	IlvMapSegmentString ()
	Initializes a new `IlvMapSegmentString` instance.

Protected Member Functions inherited from IlvMapSegment
	IlvMapSegment ()
	Initializes a new `IlvMapSegment` instance.

Protected Member Functions inherited from IlvMapCurve
	IlvMapCurve ()
	Initializes a new, empty, curve.

Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfo *	ClassInfo ()
	Returns the class info. More...

Detailed Description

This abstract class is the base class for segments that can be divided into other smaller segments.

Library: ilvmaps

The IlvMapCurveString is a generic implementation that can handle any type of IlvMapSegment, while other subclasses are optimized to handle uniform lists of segments.

The instances of the predefined subclasses of IlvMapSegmentString can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultCurveRenderer.

Member Function Documentation

◆ copy()

virtual IlvMapGeometry* IlvMapSegmentString::copy ( ) const

pure virtual

Returns a copy of the object.

Returns: An IlvMapGeometry that must be deleted by the user.

Implements IlvMapSegment.

Implemented in IlvMapLineString, IlvMapCurveString, and IlvMapArcString.

◆ getClassInfo()

virtual IlvClassInfo* IlvMapSegmentString::getClassInfo ( ) const

pure virtual

Returns the IlvClassInfo of the instance.

Returns: An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapCurve.

Implemented in IlvMapLineString, IlvMapCurveString, and IlvMapArcString.

◆ getEndPoint()

virtual const IlvCoordinate& IlvMapSegmentString::getEndPoint ( ) const

pure virtual

Returns the end point of the last segment.

Returns: The end point. If there is no end point, the point (0, 0) is returned.

Implements IlvMapSegment.

Implemented in IlvMapLineString, IlvMapCurveString, and IlvMapArcString.

◆ getSegment()

virtual const IlvMapSegment* IlvMapSegmentString::getSegment ( IlUInt index ) const

pure virtual

Returns the segment at a given 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: it may be modified or deleted by the IlvMapSegmentString itself after an other call to this function, or after any modification.

Implemented in IlvMapLineString, IlvMapCurveString, and IlvMapArcString.