2D-object representing a polyline. More...

#include <CPolyline.h>

Inheritance diagram for i2d::CPolyline:

Collaboration diagram for i2d::CPolyline:

Public Types
typedef CPolygon	BaseClass

Public Types inherited from i2d::CPolygon
typedef CPolypoint	BaseClass

Public Types inherited from i2d::IObject2d
enum	ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
	CPolyline ()

virtual bool	IsClosed () const

virtual void	SetClosed (bool state=true)
	Set polyline to be opened or closed.

virtual int	GetSegmentsCount () const
	Return number of line segments.

virtual i2d::CLine2d	GetSegmentLine (int segmentIndex) const
	Return number of line segments.

virtual double	GetLength () const
	Get length of this polyline.

virtual i2d::CVector2d	GetKneeVector (int nodeIndex) const
	Return vector for knee, that has the same angle to both neighbor segments.

bool	GetAdjacentNodes (double atPositionNormalized, i2d::CVector2d &previous, i2d::CVector2d &next, double &alpha) const
	Get adjacent nodes by position on line, and by position of arbitrary point.

bool	GetAdjacentNodes (const i2d::CVector2d &position, i2d::CVector2d &previous, i2d::CVector2d &next) const
	Get adjacent nodes by position on line, and by position of arbitrary point.

bool	GetAdjacentNodeIndices (double position, int &previousIndex, int &nextIndex, double &alpha) const
	Get adjacent node indices by position on line, and position of arbitrary point.

bool	GetAdjacentNodeIndices (const i2d::CVector2d &position, int &previousIndex, int &nextIndex) const
	Get adjacent node indices by position on line, and position of arbitrary point.

bool	GetAdjacentLine (double position, i2d::CLine2d &line, double &alpha) const
	Get adjacent segment by position on line, and by position of arbitrary point.

bool	GetAdjacentLine (const i2d::CVector2d &position, i2d::CLine2d &line) const
	Get adjacent segment by position on line, and by position of arbitrary point.

bool	GetInterpolatedPosition (double position, i2d::CVector2d &output) const
	Get position on this polyline in order to normal position [0..1].

i2d::CVector2d	GetInterpolatedPosition (double position) const

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

QByteArray	GetFactoryId () const override

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

bool	IsEqual (const IChangeable &object) const override

Public Member Functions inherited from i2d::CPolygon
	CPolygon (const QPolygonF &qpolygon=QPolygonF())

	operator QPolygonF () const

bool	Contains (const i2d::CVector2d &point) const
	Check if the polygon contains a given point.

virtual double	GetOutlineLength () const
	Get outline length of this polygon.

virtual void	FlipByX ()
	Flip object by X-axis.

virtual void	FlipByY ()
	Flip object by Y-axis.

virtual void	Rotate (double radians)
	Rotate object around its center.

virtual void	ReverseNodes ()
	Reverses nodes order.

double	GetArea (bool oriented=false) const
	Get area of the polygon.

double	GetPerimeter () const
	Get perimeter of the polygon.

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

Public Member Functions inherited from i2d::CPolypoint
virtual void	Clear ()
	Removes all nodes.

virtual void	SetNodesCount (int nodesCount)
	Set new nodes count.

virtual int	GetNodesCount () const
	Return size of node table.

bool	IsEmpty () const
	Return `true` if there are no points.

virtual const i2d::CVector2d &	GetNodePos (int index) const
	Return position of node at specified index.

i2d::CVector2d &	GetNodePosRef (int index)
	Get reference to position object for node.

virtual void	SetNodePos (int index, const i2d::CVector2d &position)
	Set node at specified index.

virtual bool	InsertNode (const i2d::CVector2d &position)
	Insert a node at the end of node table.

virtual bool	InsertNode (int index, const i2d::CVector2d &position)
	Insert a node at specified index.

virtual bool	RemoveNode (int index)
	Remove a node at specified index.

CVector2d	GetCenter () const override
	Returns center of this 2D-object.

void	MoveCenterTo (const CVector2d &position) override
	Move object to position `position`.

i2d::CRectangle	GetBoundingBox () const override
	Get bounding box of this shape.

bool	Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Transform this object using some transformation.

bool	InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Do inverse transformation of this object.

bool	GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate transformation of the object into second one.

bool	GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate inverse transformation of the object into second one.

QByteArray	GetFactoryId () const override

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

int	GetSupportedOperations () const override
	Get set of flags for supported operations.

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

bool	IsEqual (const IChangeable &object) const override

Public Member Functions inherited from i2d::CObject2dBase
	CObject2dBase ()

	CObject2dBase (const CObject2dBase &object2d)

	CObject2dBase (CObject2dBase &&object2d)

const ICalibration2d *	GetCalibration () const override
	Get access to transformation object, which transforms a local logical coordinate system to global one.

void	SetCalibration (istd::TOptDelPtr< const ICalibration2d > &&calibrationPtr) override
	Set calibration of this object.

bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

CObject2dBase &	operator= (const CObject2dBase &object2d)

CObject2dBase &	operator= (CObject2dBase &&object2d)

Public Member Functions inherited from i2d::IObject2d
Public Member Functions inherited from iser::IObject
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from i2d::ICalibration2dProvider

Static Public Member Functions
static QByteArray	GetTypeName ()

Static Public Member Functions inherited from i2d::CPolygon
static QByteArray	GetTypeName ()

Static Public Member Functions inherited from i2d::CPolypoint
static QByteArray	GetTypeName ()

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Additional Inherited Members
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Static Protected Attributes inherited from i2d::CPolypoint
static const istd::IChangeable::ChangeSet	s_clearAllNodesChange

static const istd::IChangeable::ChangeSet	s_createPolygonNodesChange

static const istd::IChangeable::ChangeSet	s_insertPolygonNodeChange

static const istd::IChangeable::ChangeSet	s_removePolygonNodeChange

Static Protected Attributes inherited from i2d::CObject2dBase
static const ChangeSet	s_objectMovedChange

static const ChangeSet	s_objectModifiedChange

Detailed Description

2D-object representing a polyline.

A polyline is a connected series of line segments and is normally used to approximate curved paths.

Definition at line 22 of file CPolyline.h.

Member Typedef Documentation

◆ BaseClass

CPolygon i2d::CPolyline::BaseClass

Definition at line 25 of file CPolyline.h.

Constructor & Destructor Documentation

◆ CPolyline()

i2d::CPolyline::CPolyline ( )

inline

Definition at line 112 of file CPolyline.h.

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > i2d::CPolyline::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns: new instance or nullptr, if this operation is not supported.

Reimplemented from i2d::CPolygon.

Reimplemented in i2d::CSpline.

◆ CopyFrom()

bool i2d::CPolyline::CopyFrom	(	const IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

override

◆ GetAdjacentLine() [1/2]

bool i2d::CPolyline::GetAdjacentLine	(	const i2d::CVector2d &	position,
		i2d::CLine2d &	line ) const

Get adjacent segment by position on line, and by position of arbitrary point.

◆ GetAdjacentLine() [2/2]

bool i2d::CPolyline::GetAdjacentLine	(	double	position,
		i2d::CLine2d &	line,
		double &	alpha ) const

Get adjacent segment by position on line, and by position of arbitrary point.

◆ GetAdjacentNodeIndices() [1/2]

bool i2d::CPolyline::GetAdjacentNodeIndices	(	const i2d::CVector2d &	position,
		int &	previousIndex,
		int &	nextIndex ) const

Get adjacent node indices by position on line, and position of arbitrary point.

◆ GetAdjacentNodeIndices() [2/2]

bool i2d::CPolyline::GetAdjacentNodeIndices	(	double	position,
		int &	previousIndex,
		int &	nextIndex,
		double &	alpha ) const

Get adjacent node indices by position on line, and position of arbitrary point.

◆ GetAdjacentNodes() [1/2]

bool i2d::CPolyline::GetAdjacentNodes	(	const i2d::CVector2d &	position,
		i2d::CVector2d &	previous,
		i2d::CVector2d &	next ) const

Get adjacent nodes by position on line, and by position of arbitrary point.

◆ GetAdjacentNodes() [2/2]

bool i2d::CPolyline::GetAdjacentNodes	(	double	atPositionNormalized,
		i2d::CVector2d &	previous,
		i2d::CVector2d &	next,
		double &	alpha ) const

Get adjacent nodes by position on line, and by position of arbitrary point.

◆ GetFactoryId()

QByteArray i2d::CPolyline::GetFactoryId ( ) const

overridevirtual

Reimplemented from i2d::CPolygon.

◆ GetInterpolatedPosition() [1/2]

i2d::CVector2d i2d::CPolyline::GetInterpolatedPosition ( double position ) const

◆ GetInterpolatedPosition() [2/2]

bool i2d::CPolyline::GetInterpolatedPosition	(	double	position,
		i2d::CVector2d &	output ) const

Get position on this polyline in order to normal position [0..1].

◆ GetKneeVector()

virtual i2d::CVector2d i2d::CPolyline::GetKneeVector ( int nodeIndex ) const

virtual

Return vector for knee, that has the same angle to both neighbor segments.

◆ GetLength()

virtual double i2d::CPolyline::GetLength ( ) const

virtual

Get length of this polyline.

◆ GetSegmentLine()

virtual i2d::CLine2d i2d::CPolyline::GetSegmentLine ( int segmentIndex ) const

virtual

Return number of line segments.

◆ GetSegmentsCount()

virtual int i2d::CPolyline::GetSegmentsCount ( ) const

virtual

Return number of line segments.

◆ GetTypeName()

static QByteArray i2d::CPolyline::GetTypeName ( )

static

◆ IsClosed()

bool i2d::CPolyline::IsClosed ( ) const

inlinevirtual

Definition at line 118 of file CPolyline.h.

◆ IsEqual()

bool i2d::CPolyline::IsEqual ( const IChangeable & object ) const

override

◆ Serialize()

bool i2d::CPolyline::Serialize ( iser::IArchive & archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also: iser::IArchive

Implements iser::ISerializable.

◆ SetClosed()

virtual void i2d::CPolyline::SetClosed ( bool state = true )

virtual

Set polyline to be opened or closed.

The documentation for this class was generated from the following file:

i2d/CPolyline.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CPolyline()

Member Function Documentation

◆ CloneMe()

◆ CopyFrom()

◆ GetAdjacentLine() [1/2]

◆ GetAdjacentLine() [2/2]

◆ GetAdjacentNodeIndices() [1/2]

◆ GetAdjacentNodeIndices() [2/2]

◆ GetAdjacentNodes() [1/2]

◆ GetAdjacentNodes() [2/2]

◆ GetFactoryId()

◆ GetInterpolatedPosition() [1/2]

◆ GetInterpolatedPosition() [2/2]

◆ GetKneeVector()

◆ GetLength()

◆ GetSegmentLine()

◆ GetSegmentsCount()

◆ GetTypeName()

◆ IsClosed()

◆ IsEqual()

◆ Serialize()

◆ SetClosed()