Represents a polygon. The number of vertices is arbitrary. A EPolygon could be closed (last and first point connected) or open (like a polyline shape). More...

#include <eVision/Easy/EPolygon.h>

Inheritance diagram for eVision::EPolygon:

Collaboration diagram for eVision::EPolygon:

Public Member Functions
	EPolygon ()
	Constructs a EPolygon.
	EPolygon (const eVision::EPolygon &other)
	Constructs a EPolygon.
	EPolygon (const std::vector< eVision::EPoint > &vertices, bool closed)
	Constructs a EPolygon.
	EPolygon (const std::vector< eVision::EPoint > &vertices)
	Constructs a EPolygon.
virtual	~EPolygon () throw ()
eVision::EPolygon &	operator= (const eVision::EPolygon &other)
	Copies all the data from another EPolygon object into the current EPolygon object.
bool	operator== (const eVision::EPolygon &polygon) const
	Compares the current EPolygon with another EPolygon object.
bool	operator!= (const eVision::EPolygon &polygon) const
	Compares the current EPolygon with another EPolygon object.
void	CopyTo (eVision::EPolygon &other) const
	Copies the content of this object to the other one.
void	AppendVertex (const eVision::EPoint &pt)
	Appends a polygon vertex after the last.
void	InsertVertex (int index, const eVision::EPoint &pt)
	Inserts a vertex before the given index.
void	RemoveVertex (int index)
	Removes vertex at the given index.
void	SetVertex (int index, const eVision::EPoint &pt)
	Sets a polygon vertex.
eVision::EPoint	GetVertex (int index) const
	Gets a polygon vertex.
void	SetIsClosed (bool state)
	The polygon close attribute.
bool	GetIsClosed () const
	The polygon close attribute.
int	GetNumVertices () const
	Returns the number of polygon's vertices.
int	GetNumEdges () const
	Returns the number of polygon's edges (or sides). Depends on the EPolygon::SetIsClosed status.
std::vector< eVision::EPoint >	GetVertices () const
	Returns the list of polygon vertices.
bool	IsValid () const
	Returns true if the polygon is valid. A valid polygon has at least 2 (when open) or 3 (when closed) distinct and valid vertices and no duplicate points.
float	GetLength () const
	Returns the length (perimeter) of the polygon.
float	GetArea () const
	Returns the area of the polygon.
eVision::EPoint	GetCenter () const
	The center of the polygon (average position of all the vertices).
float	GetEdgeLength (int index) const
	Length of an edge.
float	GetEdgeAngle (int index) const
	Angle of the edge with respect to the X-axis.
eVision::ELine	GetEdge (int index) const
	Edge of the polygon as a ELine object.
virtual eVision::EEditionMode	GetAvailableEditionModes () const
	Available edition modes for the shape.
virtual std::string	GetDescription () const
	Textual description of the shape and its parameters.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY, float panX)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
eVision::EEditionMode	AddVertexAtDisplayPosition (int32_t x, int32_t y)
	Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, const eVision::EFrame &frame)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY, float panX)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX, float zoomY)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y, float zoomX)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition (int32_t x, int32_t y)
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
void	RemoveVertexAtDisplayPosition ()
	Removes the vertex at the given position or the vertex hit during the last call to EShape::HitTest.
	EPolygon (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::EShape
virtual	~EShape () throw ()
void	Load (const std::string &path)
	Load the EShape configuration. The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Load the EShape configuration. The given ESerializer must have been created for reading.
void	Save (const std::string &path)
	Save the EShape configuration. The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Save the EShape configuration. The given ESerializer must have been created for writing.
void	Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX, float panY) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, float zoomX) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX) const
	Draws the EShape shape.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame) const
	Draws the EShape shape.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EEditionMode	HitTest (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
void	Drag (int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, float zoomX, float zoomY, float panX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, float zoomX, float zoomY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY, float panX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX, float zoomY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, const eVision::EFrame &frame, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	Drag (int32_t x, int32_t y, const eVision::EFrame &frame)
	Moves the specified handle to a new position and updates all placement parameters of the region.
void	SetEditionMode (eVision::EEditionMode modes)
	Current edition mode for the shape. Default: EEditionMode_None.
eVision::EEditionMode	GetEditionMode () const
	Current edition mode for the shape. Default: EEditionMode_None.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling) const
	Converts the shape to a frame.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling, const eVision::EFrame &shapeFrame) const
	Converts the shape to a frame.
	EShape (CppWrapperInternal::InternalConstructor)

Additional Inherited Members
Public Attributes inherited from eVision::EShape
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Represents a polygon. The number of vertices is arbitrary. A EPolygon could be closed (last and first point connected) or open (like a polyline shape).

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EPolygon() [1/5]

eVision::EPolygon::EPolygon ( )

Constructs a EPolygon.

◆ EPolygon() [2/5]

eVision::EPolygon::EPolygon ( const eVision::EPolygon & other )

Constructs a EPolygon.

Parameters

other Reference to the EPolygon used for the initialization.

◆ EPolygon() [3/5]

eVision::EPolygon::EPolygon	(	const std::vector< eVision::EPoint > &	vertices,
		bool	closed )

Constructs a EPolygon.

Parameters

vertices	A vector of at least 3 points.
closed	An optional parameter to set the closed properties. When closed, an edge exists between the last and first points of the polygon. By default, created polygons are closed.

◆ EPolygon() [4/5]

eVision::EPolygon::EPolygon ( const std::vector< eVision::EPoint > & vertices )

Constructs a EPolygon.

Parameters

vertices A vector of at least 3 points.

◆ ~EPolygon()

eVision::EPolygon::~EPolygon	(		)
throw	(	)

virtual

◆ EPolygon() [5/5]

eVision::EPolygon::EPolygon ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddVertexAtDisplayPosition() [1/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.

◆ AddVertexAtDisplayPosition() [2/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		const eVision::EFrame &	frame )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.

◆ AddVertexAtDisplayPosition() [3/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		const eVision::EFrame &	frame,
		float	zoomX )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ AddVertexAtDisplayPosition() [4/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ AddVertexAtDisplayPosition() [5/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ AddVertexAtDisplayPosition() [6/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ AddVertexAtDisplayPosition() [7/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		float	zoomX )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ AddVertexAtDisplayPosition() [8/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		float	zoomX,
		float	zoomY )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ AddVertexAtDisplayPosition() [9/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		float	zoomX,
		float	zoomY,
		float	panX )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ AddVertexAtDisplayPosition() [10/10]

eVision::EEditionMode eVision::EPolygon::AddVertexAtDisplayPosition	(	int32_t	x,
		int32_t	y,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Adds a vertex at the given mouse position such that the new vertex splits the edge that it is the closest to.

Returns EEditionMode.Stretch for the new vertex.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ AppendVertex()

void eVision::EPolygon::AppendVertex ( const eVision::EPoint & pt )

Appends a polygon vertex after the last.

Parameters

pt	The point to append.

◆ CopyTo()

void eVision::EPolygon::CopyTo ( eVision::EPolygon & other ) const

Copies the content of this object to the other one.

Parameters

other Other EPolygon object in which to copy the content of this object.

◆ GetArea()

float eVision::EPolygon::GetArea ( ) const

Returns the area of the polygon.

◆ GetAvailableEditionModes()

eVision::EEditionMode eVision::EPolygon::GetAvailableEditionModes ( ) const

virtual

Available edition modes for the shape.

Implements eVision::EShape.

◆ GetCenter()

eVision::EPoint eVision::EPolygon::GetCenter ( ) const

The center of the polygon (average position of all the vertices).

◆ GetDescription()

std::string eVision::EPolygon::GetDescription ( ) const

virtual

Textual description of the shape and its parameters.

Implements eVision::EShape.

◆ GetEdge()

eVision::ELine eVision::EPolygon::GetEdge ( int index ) const

Edge of the polygon as a ELine object.

Parameters

index Index of the edge between 0 and EPolygon::GetNumEdges - 1.

◆ GetEdgeAngle()

float eVision::EPolygon::GetEdgeAngle ( int index ) const

Angle of the edge with respect to the X-axis.

Parameters

index Index of the edge between 0 and EPolygon::GetNumEdges - 1.

◆ GetEdgeLength()

float eVision::EPolygon::GetEdgeLength ( int index ) const

Length of an edge.

Parameters

index Index of the edge between 0 and EPolygon::GetNumEdges - 1.

◆ GetIsClosed()

bool eVision::EPolygon::GetIsClosed ( ) const

The polygon close attribute.

◆ GetLength()

float eVision::EPolygon::GetLength ( ) const

Returns the length (perimeter) of the polygon.

◆ GetNumEdges()

int eVision::EPolygon::GetNumEdges ( ) const

Returns the number of polygon's edges (or sides). Depends on the EPolygon::SetIsClosed status.

◆ GetNumVertices()

int eVision::EPolygon::GetNumVertices ( ) const

Returns the number of polygon's vertices.

◆ GetVertex()

eVision::EPoint eVision::EPolygon::GetVertex ( int index ) const

Gets a polygon vertex.

Parameters

index The index of the vertex.

◆ GetVertices()

std::vector< eVision::EPoint > eVision::EPolygon::GetVertices ( ) const

Returns the list of polygon vertices.

◆ InsertVertex()

void eVision::EPolygon::InsertVertex	(	int	index,
		const eVision::EPoint &	pt )

Inserts a vertex before the given index.

Parameters

index	The index after which the vertex will be inserted.
pt	The point to insert.

◆ IsValid()

bool eVision::EPolygon::IsValid ( ) const

Returns true if the polygon is valid. A valid polygon has at least 2 (when open) or 3 (when closed) distinct and valid vertices and no duplicate points.

◆ operator!=()

bool eVision::EPolygon::operator!= ( const eVision::EPolygon & polygon ) const

Compares the current EPolygon with another EPolygon object.

Parameters

polygon The other EPolygon object.

◆ operator=()

eVision::EPolygon & eVision::EPolygon::operator= ( const eVision::EPolygon & other )

Copies all the data from another EPolygon object into the current EPolygon object.

Parameters

other EPolygon object to be copied

◆ operator==()

bool eVision::EPolygon::operator== ( const eVision::EPolygon & polygon ) const

Compares the current EPolygon with another EPolygon object.

Parameters

polygon The other EPolygon object.

◆ RemoveVertex()

void eVision::EPolygon::RemoveVertex ( int index )

Removes vertex at the given index.

Parameters

index The index of the vertex to remove.