Manages a circle shape. More...

#include <eVision/EasyGauge/Legacy/ECircleShape.h>

Inheritance diagram for eVision::Legacy::ECircleShape:

Collaboration diagram for eVision::Legacy::ECircleShape:

Public Member Functions
	ECircleShape (const eVision::Legacy::ECircleShape &other)
	Constructs a ECircleShape object.
	ECircleShape ()
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, float diameter, float originAngle, bool direct)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, float diameter, float originAngle)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, float diameter)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, float diameter, float originAngle, float amplitude)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &origin, const eVision::EPoint &middle, const eVision::EPoint &end, bool fullCircle)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, const eVision::EPoint &origin, bool fullCircle)
	Constructs a ECircleShape object.
	ECircleShape (const eVision::EPoint &center, const eVision::EPoint &origin)
	Constructs a ECircleShape object.
virtual	~ECircleShape () throw ()
eVision::Legacy::ECircleShape &	operator= (const eVision::Legacy::ECircleShape &other)
	Copies all the data from another ECircleShape object into the current ECircleShape object.
float	GetCenterX () const
	Abscissa of the origin point of the shape.
float	GetCenterY () const
	Ordinate of the origin point of the shape.
float	GetAngle () const
	The angle of the frame.
void	SetAngle (float f32Angle)
	The angle of the frame.
float	GetScale () const
	The scale of the frame.
void	SetScale (float f32Scale)
	The scale of the frame.
float	GetAmplitude () const
	Angular amplitude of the ECircleShape object.
void	SetAmplitude (float ampl)
	Angular amplitude of the ECircleShape object.
eVision::EPoint	GetApex () const
	Apex point coordinates of a ECircleShape object.
float	GetApexAngle () const
	Angular position at the apex of a ECircleShape object.
float	GetArcLength () const
	Circle arc length of a ECircleShape object.
eVision::EPoint	GetCenter () const
	Center point of the shape.
void	SetCenter (const eVision::EPoint &center)
	Center point of the shape.
void	SetCenterXY (float centerX, float centerY)
	Sets the x and y coordinates of the center of the ECircleShape.
float	GetDiameter () const
	Diameter of a ECircleShape object.
void	SetDiameter (float f32Diameter)
	Diameter of a ECircleShape object.
bool	GetDirect () const
	Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.
eVision::EPoint	GetEnd () const
	End point coordinates of a ECircleShape object.
float	GetEndAngle () const
	Angular position of the end of a ECircleShape object.
bool	GetFull () const
	Flag indicating whether the ECircleShape object is a full circle or not.
eVision::EPoint	GetOrg () const
	Origin point coordinates of a ECircleShape object.
float	GetOrgAngle () const
	Angular position from where the ECircleShape object extents.
eVision::EPoint	GetPoint (float fraction) const
	Returns the coordinates of a particular point specified by its location along the circle arc.
float	GetRadius () const
	Radius of a ECircleShape object.
void	SetRadius (float f32Radius)
	Radius of a ECircleShape object.
void	CopyTo (eVision::Legacy::ECircleShape &other, bool recursive) const
	Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.
void	CopyTo (eVision::Legacy::ECircleShape &other) const
	Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.
eVision::Legacy::ECircleShape *	CopyTo (eVision::Legacy::ECircleShape *dest, bool recursive) const
	Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.
virtual eVision::EShapeType	GetType () const
	Shape type.
void	SetFromCenterAndOrigin (const eVision::EPoint &center, const eVision::EPoint &origin, bool direct)
	Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.
void	SetFromCenterAndOrigin (const eVision::EPoint &center, const eVision::EPoint &origin)
	Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.
void	SetFromOriginMiddleEnd (const eVision::EPoint &origin, const eVision::EPoint &middle, const eVision::EPoint &end, bool fullCircle)
	Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.
void	SetFromOriginMiddleEnd (const eVision::EPoint &origin, const eVision::EPoint &middle, const eVision::EPoint &end)
	Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.
virtual eVision::Legacy::ECircle	GetCircle () const
	The circle.
virtual void	SetCircle (const eVision::Legacy::ECircle &circle)
	The circle.
virtual void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool daughters)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (eVision::EDrawAdapter *graphicContext)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool daughters)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Draw (HDC graphicContext, const eVision::ERGBColor &color)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	DrawWithCurrentPen (HDC graphicContext)
	Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void	Closest ()
	Find the daughter shape that is the closest to this shape. To retrieve the closest shape, use EShape::GetClosestShape.
virtual bool	HitTest (bool bDaughters)
	Checks if there is a handle under the cursor.
virtual bool	HitTest ()
	Checks if there is a handle under the cursor.
virtual void	Drag (int32_t x, int32_t y)
	Moves a handle to a new position and updates the position parameters of the gauge.
	ECircleShape (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Legacy::EShape
virtual	~EShape () throw ()
std::string	GetName () const
	Name of the EShape object.
void	SetName (const std::string &name)
	Name of the EShape object.
eVision::Legacy::EShape *	GetShapeNamed (const std::string &name)
	Returns a pointer to a daughter gauge or shape specified by its name.
bool	GetVisible () const
	Flag indicating whether the shape is visible or not.
void	SetVisible (bool visible)
	Flag indicating whether the shape is visible or not.
void	SetVisibleRecursive (bool visible)
	Sets the flag indicating whether the shape and its daughter shapes are visible or not.
bool	GetSelected () const
	Flag indicating whether the shape is selected or not.
void	SetSelected (bool selected)
	Flag indicating whether the shape is selected or not.
void	SetSelectedRecursive (bool selected)
	Sets the flag indicating whether the shape and all its daughters are selected or not.
bool	GetSelectable () const
	Flag indicating whether the shape can be selected or not.
void	SetSelectable (bool selectable)
	Flag indicating whether the shape can be selected or not.
void	SetSelectableRecursive (bool selectable)
	Sets the flag indicating whether the shape and all its daughters can be selected or not.
bool	GetDragable () const
	Flag indicating whether the shape can be dragged or not.
void	SetDragable (bool dragable)
	Flag indicating whether the shape can be dragged or not.
void	SetDragableRecursive (bool dragable)
	Sets the flag indicating whether the shape and all its daughters can be dragged or not.
bool	GetResizable () const
	Flag indicating whether the shape can be resized or not.
void	SetResizable (bool resizable)
	Flag indicating whether the shape can be resized or not.
void	SetResizableRecursive (bool resizable)
	Sets the flag indicating whether the shape and all its daughters can be resized or not.
bool	GetRotatable () const
	Flag indicating whether the shape can be rotated or not.
void	SetRotatable (bool rotatable)
	Flag indicating whether the shape can be rotated or not.
void	SetRotatableRecursive (bool rotatable)
	Sets the flag indicating whether the shape and all its daughters can be rotated or not.
bool	GetLabeled () const
	Flag indicating whether the shape label should be displayed or not.
void	SetLabeled (bool labeled)
	Flag indicating whether the shape label should be displayed or not.
void	SetLabeledRecursive (bool labeled)
	Sets the flag indicating whether the shape label should be displayed or not. The flag is set in this shape and all its daughters.
virtual bool	GetActive () const
	Flag indicating whether the shape is active or not.
virtual void	SetActive (bool active)
	Flag indicating whether the shape is active or not.
virtual void	SetActiveRecursive (bool active)
	Sets the flag indicating whether the shape and all its daughters are active or not.
bool	GetActualShape () const
	Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
void	SetActualShape (bool actualShape)
	Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
void	SetActualShapeRecursive (bool actualShape)
	Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true). The flag is set in this shape and all its daughters.
bool	GetFound () const
	Flag indicating whether a measured shape has been found.
bool	GetAutoArrange () const
void	SetAutoArrange (bool bAutoArrange, bool bDaughters)
void	SetAutoArrange (bool bAutoArrange)
virtual void	SetFound (bool bFound, bool bDaughters)
virtual void	SetFound (bool bFound)
bool	GetInspected () const
void	SetInspected (bool bFound, bool bDaughters)
void	SetInspected (bool bFound)
bool	GetPassed () const
void	SetPassed (bool bFound, bool bDaughters)
void	SetPassed (bool bFound)
bool	GetQuickDraw () const
void	SetQuickDraw (bool bFound, bool bDaughters)
void	SetQuickDraw (bool bFound)
bool	GetOptionalDraw () const
void	SetOptionalDraw (bool bFound, bool bDaughters)
void	SetOptionalDraw (bool bFound)
bool	GetUserFlag () const
void	SetUserFlag (bool bUserFlag, bool bDaughters)
void	SetUserFlag (bool bUserFlag)
bool	GetAllocated () const
	Gets the allocated flag.
void	EnableBehaviorFilter (eVision::EShapeBehavior behavior, bool value)
	Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
void	EnableBehaviorFilter (eVision::EShapeBehavior behavior)
	Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
void	DisableBehaviorFilter (eVision::EShapeBehavior behavior)
	Disables (i.e. removes) a condition from the list of conditions in the behavior filter.
void	Attach (eVision::Legacy::EShape *mother)
	Attaches the gauge to a mother gauge or shape.
void	Detach ()
	Detaches the gauge from its mother gauge or shape.
void	DetachDaughters ()
	Detaches the daughter gauges or shapes.
uint32_t	GetNumDaughters () const
	Number of daughters attached to the shape.
eVision::Legacy::EShape *	GetMother () const
	Pointer to the mother shape.
virtual eVision::Legacy::EShape *	GetDaughter (uint32_t index) const
	Returns a pointer to the specified daughter gauge or shape.
eVision::Legacy::EWorldShape *	GetWorldShape () const
	World ancestor.
bool	IsWorld () const
void	InvalidateWorld ()
	Invalidates the world shape for this shape and all its ancestors.
eVision::EPoint	LocalToSensor (const eVision::EPoint &LPoint)
	Transforms a point from local coordinates to sensor coordinates.
eVision::EPoint	SensorToLocal (const eVision::EPoint &SPoint)
	Transforms a point from sensor coordinates to local coordinates.
virtual float	GetZoomX () const
	Current horizontal zooming factor for drawing operations.
virtual float	GetZoomY () const
	Current vertical zooming factor for drawing operations.
virtual float	GetPanX () const
	Current horizontal panning value for drawing operations, expressed in pixels. By default, no panning occurs.
virtual float	GetPanY () const
	Current vertical panning value for drawing operations, expressed in pixels. By default, no panning occurs.
virtual void	SetZoom (float zoomX, float zoomY)
	Sets the horizontal and vertical zooming factors for drawing operations.
virtual void	SetZoom (float zoomX)
	Sets the horizontal and vertical zooming factors for drawing operations.
virtual void	SetZoom ()
	Sets the horizontal and vertical zooming factors for drawing operations.
virtual void	SetPan (float panX, float panY)
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
virtual void	SetPan (float panX)
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
virtual void	SetPan ()
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
eVision::EDragHandle	GetHitHandle () const
	Handle currently under the cursor.
eVision::Legacy::EShape *	GetHitShape () const
	Pointer to the shape currently under the cursor.
void	SetDraggingMode (eVision::EDraggingMode eDraggingMode, bool bDaughters)
	Sets the dragging mode which defines how the shape could be dragged.
void	SetDraggingMode (eVision::EDraggingMode eDraggingMode)
	Sets the dragging mode which defines how the shape could be dragged.
eVision::EDraggingMode	GetDraggingMode () const
	Gets the dragging mode which defines how the shape could be dragged.
void	SetCursor (int32_t x, int32_t y)
	Sets the cursor current coordinates.
eVision::Legacy::EShape *	GetClosestShape () const
	Closest shape among the daughters.
virtual void	Process (eVision::EROIBW8 *pSrc, bool bDaughters)
virtual void	Process (eVision::EROIBW8 *pSrc)
virtual void	Process (eVision::EROIBW8 *pSrc, const eVision::ERegion &region, bool bDaughters)
virtual void	Process (eVision::EROIBW8 *pSrc, const eVision::ERegion &region)
void	Save (const std::string &path, bool daughters)
	Loads a Shape.The given ESerializer must have been created for writing.
void	Save (const std::string &path)
	Loads a Shape.The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer, bool daughters)
	Loads a Shape.The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Loads a Shape.The given ESerializer must have been created for writing.
void	Load (const std::string &path, bool daughters)
	Loads a Shape.The given ESerializer must have been created for reading.
void	Load (const std::string &path)
	Loads a Shape.The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer, bool daughters)
	Loads a Shape.The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Loads a Shape.The given ESerializer must have been created for reading.
bool	HasProperty (const std::string &aProperty) const
	Returns whether a EShape has a property named aProperty.
std::string	GetProperty (const std::string &aProperty) const
	Gets the value of property aProperty. Throws an exception if no such property exists.
void	SetProperty (const std::string &aProperty, const std::string &aValue)
	Sets the value of property aProperty to aValue for this EShape.
void	SetPropertyRecursive (const std::string &aProperty, const std::string &aValue)
	Sets the value of property aProperty to aValue for this EShape and all of its daughters.
void	RemoveProperty (const std::string &aProperty)
	Removes the property name aProperty from the EShape.
bool	HasValidPolarityProperty () const
	Returns whether the EShape has a valid polarity property.
virtual void	EnableTypeFilter (uint32_t un32Types)
	Enables the filter of the specified shape type.
virtual void	DisableTypeFilter ()
	Enables all shape types.
	EShape (CppWrapperInternal::InternalConstructor)

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

Detailed Description

Manages a circle shape.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ ECircleShape() [1/11]

eVision::Legacy::ECircleShape::ECircleShape ( const eVision::Legacy::ECircleShape & other )

Constructs a ECircleShape object.

Parameters

other Another ECircleShape object to be copied in the new ECircleShape object.

◆ ECircleShape() [2/11]

eVision::Legacy::ECircleShape::ECircleShape ( )

Constructs a ECircleShape object.

◆ ECircleShape() [3/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		float	diameter,
		float	originAngle,
		bool	direct )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
diameter	Nominal diameter of the circle. The default value is 100.
originAngle	Nominal angular origin of the circle. The default value is 0.
direct	true (default) means that angles increase anticlockwisely in a direct coordinate system.

◆ ECircleShape() [4/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		float	diameter,
		float	originAngle )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
diameter	Nominal diameter of the circle. The default value is 100.
originAngle	Nominal angular origin of the circle. The default value is 0.

◆ ECircleShape() [5/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		float	diameter )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
diameter	Nominal diameter of the circle. The default value is 100.

◆ ECircleShape() [6/11]

eVision::Legacy::ECircleShape::ECircleShape ( const eVision::EPoint & center )

Constructs a ECircleShape object.

Parameters

center Center coordinates of the circle at its nominal position. The default value is (0,0).

◆ ECircleShape() [7/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		float	diameter,
		float	originAngle,
		float	amplitude )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
diameter	Nominal diameter of the circle. The default value is 100.
originAngle	Nominal angular origin of the circle. The default value is 0.
amplitude	Nominal angular amplitude of the circle. The default value is 360.

◆ ECircleShape() [8/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	origin,
		const eVision::EPoint &	middle,
		const eVision::EPoint &	end,
		bool	fullCircle )

Constructs a ECircleShape object.

Parameters

origin	Origin point coordinates of the circle.
middle	Middle point coordinates of the circle.
end	End point coordinates of the circle.
fullCircle	true (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ ECircleShape() [9/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		const eVision::EPoint &	origin,
		bool	fullCircle )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
origin	Origin point coordinates of the circle.
fullCircle	true (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ ECircleShape() [10/11]

eVision::Legacy::ECircleShape::ECircleShape	(	const eVision::EPoint &	center,
		const eVision::EPoint &	origin )

Constructs a ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
origin	Origin point coordinates of the circle.

◆ ~ECircleShape()

eVision::Legacy::ECircleShape::~ECircleShape	(		)
throw	(	)

virtual

◆ ECircleShape() [11/11]

eVision::Legacy::ECircleShape::ECircleShape ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Closest()

void eVision::Legacy::ECircleShape::Closest ( )

virtual

Find the daughter shape that is the closest to this shape. To retrieve the closest shape, use EShape::GetClosestShape.

Implements eVision::Legacy::EShape.

◆ CopyTo() [1/3]

void eVision::Legacy::ECircleShape::CopyTo ( eVision::Legacy::ECircleShape & other ) const

Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.

Parameters

other ECircleShape object in which the current ECircleShape object data have to be copied.

In the overload taking a pointer, in case of a NULL pointer, a new ECircleShape object will be created and returned.

◆ CopyTo() [2/3]

void eVision::Legacy::ECircleShape::CopyTo	(	eVision::Legacy::ECircleShape &	other,
		bool	recursive ) const

Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.

Parameters

other	ECircleShape object in which the current ECircleShape object data have to be copied.
recursive	true if the children gauges have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new ECircleShape object will be created and returned.

◆ CopyTo() [3/3]

eVision::Legacy::ECircleShape * eVision::Legacy::ECircleShape::CopyTo	(	eVision::Legacy::ECircleShape *	dest,
		bool	recursive ) const

Copies all the data of the current ECircleShape object into another ECircleShape object, and returns it.

Parameters

dest	Pointer to the ECircleShape object in which the current ECircleShape object data have to be copied.
recursive	true if the children gauges have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new ECircleShape object will be created and returned.

Deprecated

Use the overload taking a reference.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Drag()

void eVision::Legacy::ECircleShape::Drag	(	int32_t	x,
		int32_t	y )

virtual

Moves a handle to a new position and updates the position parameters of the gauge.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [1/9]

void eVision::Legacy::ECircleShape::Draw ( eVision::EDrawAdapter * graphicContext )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext Handle of the device context on which to draw.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [2/9]

void eVision::Legacy::ECircleShape::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [3/9]

void eVision::Legacy::ECircleShape::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	daughters )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [4/9]

void eVision::Legacy::ECircleShape::Draw ( HDC graphicContext )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext Handle of the device context on which to draw.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [5/9]

void eVision::Legacy::ECircleShape::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color to draw with.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [6/9]

void eVision::Legacy::ECircleShape::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color to draw with.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [7/9]

void eVision::Legacy::ECircleShape::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	daughters )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color to draw with.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [8/9]

void eVision::Legacy::ECircleShape::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ Draw() [9/9]

void eVision::Legacy::ECircleShape::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	daughters )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ DrawWithCurrentPen() [1/3]

void eVision::Legacy::ECircleShape::DrawWithCurrentPen ( HDC graphicContext )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext Handle of the device context on which to draw.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ DrawWithCurrentPen() [2/3]

void eVision::Legacy::ECircleShape::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ DrawWithCurrentPen() [3/3]

void eVision::Legacy::ECircleShape::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	daughters )

virtual

Draws a graphical representation of a shape, as defined by EDrawingMode.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ GetAmplitude()

float eVision::Legacy::ECircleShape::GetAmplitude ( ) const

Angular amplitude of the ECircleShape object.

The default value is 360. A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ GetAngle()

float eVision::Legacy::ECircleShape::GetAngle ( ) const

The angle of the frame.

◆ GetApex()

eVision::EPoint eVision::Legacy::ECircleShape::GetApex ( ) const

Apex point coordinates of a ECircleShape object.

◆ GetApexAngle()

float eVision::Legacy::ECircleShape::GetApexAngle ( ) const

Angular position at the apex of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ GetArcLength()

float eVision::Legacy::ECircleShape::GetArcLength ( ) const

Circle arc length of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance.

◆ GetCenter()

eVision::EPoint eVision::Legacy::ECircleShape::GetCenter ( ) const

Center point of the shape.

◆ GetCenterX()

float eVision::Legacy::ECircleShape::GetCenterX ( ) const

Abscissa of the origin point of the shape.

◆ GetCenterY()

float eVision::Legacy::ECircleShape::GetCenterY ( ) const

Ordinate of the origin point of the shape.

◆ GetCircle()

eVision::Legacy::ECircle eVision::Legacy::ECircleShape::GetCircle ( ) const

virtual

The circle.

◆ GetDiameter()

float eVision::Legacy::ECircleShape::GetDiameter ( ) const

Diameter of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the diameter is 100, which means 100 pixels when the field of view is not calibrated, and 100 physical units in case of a calibrated field of view.

◆ GetDirect()

bool eVision::Legacy::ECircleShape::GetDirect ( ) const

Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.

true (default) means that angles increase anticlockwisely in a direct coordinate system, and clockwisely in an inverse coordinate system.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards.

◆ GetEnd()

eVision::EPoint eVision::Legacy::ECircleShape::GetEnd ( ) const

End point coordinates of a ECircleShape object.

◆ GetEndAngle()

float eVision::Legacy::ECircleShape::GetEndAngle ( ) const

Angular position of the end of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ GetFull()

bool eVision::Legacy::ECircleShape::GetFull ( ) const

Flag indicating whether the ECircleShape object is a full circle or not.

By default (true), the ECircleShape object is a full circle.

◆ GetOrg()

eVision::EPoint eVision::Legacy::ECircleShape::GetOrg ( ) const

Origin point coordinates of a ECircleShape object.

◆ GetOrgAngle()

float eVision::Legacy::ECircleShape::GetOrgAngle ( ) const

Angular position from where the ECircleShape object extents.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ GetPoint()

eVision::EPoint eVision::Legacy::ECircleShape::GetPoint ( float fraction ) const

Returns the coordinates of a particular point specified by its location along the circle arc.

Parameters

fraction Point location expressed as a fraction of the circle arc (range [-1, +1]).

◆ GetRadius()

float eVision::Legacy::ECircleShape::GetRadius ( ) const

Radius of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the radius is 50, which means 50 pixels when the field of view is not calibrated, and 50 physical units in case of a calibrated field of view.

◆ GetScale()

float eVision::Legacy::ECircleShape::GetScale ( ) const

The scale of the frame.

◆ GetType()

eVision::EShapeType eVision::Legacy::ECircleShape::GetType ( ) const

virtual

Shape type.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ HitTest() [1/2]

bool eVision::Legacy::ECircleShape::HitTest ( )

virtual

Checks if there is a handle under the cursor.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ HitTest() [2/2]

bool eVision::Legacy::ECircleShape::HitTest ( bool bDaughters )

virtual

Checks if there is a handle under the cursor.

Parameters

bDaughters Indicates if the check must be done in the whole hierarchy or just this object.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ operator=()

eVision::Legacy::ECircleShape & eVision::Legacy::ECircleShape::operator= ( const eVision::Legacy::ECircleShape & other )

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

Parameters

other ECircleShape object to be copied

◆ SetAmplitude()

void eVision::Legacy::ECircleShape::SetAmplitude ( float ampl )

Angular amplitude of the ECircleShape object.

The default value is 360. A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ SetAngle()

void eVision::Legacy::ECircleShape::SetAngle ( float f32Angle )

The angle of the frame.

◆ SetCenter()

void eVision::Legacy::ECircleShape::SetCenter ( const eVision::EPoint & center )

Center point of the shape.

◆ SetCenterXY()

void eVision::Legacy::ECircleShape::SetCenterXY	(	float	centerX,
		float	centerY )

Sets the x and y coordinates of the center of the ECircleShape.

Parameters

centerX	x coordinate of the center
centerY	y coordinate of the center

◆ SetCircle()

void eVision::Legacy::ECircleShape::SetCircle ( const eVision::Legacy::ECircle & circle )

virtual

The circle.

Parameters

circle The circle.

Reimplemented in eVision::Legacy::ECircleGauge.

◆ SetDiameter()

void eVision::Legacy::ECircleShape::SetDiameter ( float f32Diameter )

Diameter of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the diameter is 100, which means 100 pixels when the field of view is not calibrated, and 100 physical units in case of a calibrated field of view.

◆ SetFromCenterAndOrigin() [1/2]

void eVision::Legacy::ECircleShape::SetFromCenterAndOrigin	(	const eVision::EPoint &	center,
		const eVision::EPoint &	origin )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
origin	Origin point coordinates of the circle.

◆ SetFromCenterAndOrigin() [2/2]

void eVision::Legacy::ECircleShape::SetFromCenterAndOrigin	(	const eVision::EPoint &	center,
		const eVision::EPoint &	origin,
		bool	direct )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.

Parameters

center	Center coordinates of the circle at its nominal position. The default value is (0,0).
origin	Origin point coordinates of the circle.
direct	true (default) means that angles increase anticlockwise in a direct coordinate system.

◆ SetFromOriginMiddleEnd() [1/2]

void eVision::Legacy::ECircleShape::SetFromOriginMiddleEnd	(	const eVision::EPoint &	origin,
		const eVision::EPoint &	middle,
		const eVision::EPoint &	end )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.

Parameters

origin	Origin point coordinates of the circle.
middle	Middle point coordinates of the circle.
end	End point coordinates of the circle.

◆ SetFromOriginMiddleEnd() [2/2]

void eVision::Legacy::ECircleShape::SetFromOriginMiddleEnd	(	const eVision::EPoint &	origin,
		const eVision::EPoint &	middle,
		const eVision::EPoint &	end,
		bool	fullCircle )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an ECircleShape object.

Parameters

origin	Origin point coordinates of the circle.
middle	Middle point coordinates of the circle.
end	End point coordinates of the circle.
fullCircle	true (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ SetRadius()

void eVision::Legacy::ECircleShape::SetRadius ( float f32Radius )

Radius of a ECircleShape object.

A ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the radius is 50, which means 50 pixels when the field of view is not calibrated, and 50 physical units in case of a calibrated field of view.

◆ SetScale()

void eVision::Legacy::ECircleShape::SetScale ( float f32Scale )

The scale of the frame.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ECircleShape() [1/11]

◆ ECircleShape() [2/11]

◆ ECircleShape() [3/11]

◆ ECircleShape() [4/11]

◆ ECircleShape() [5/11]

◆ ECircleShape() [6/11]

◆ ECircleShape() [7/11]

◆ ECircleShape() [8/11]

◆ ECircleShape() [9/11]

◆ ECircleShape() [10/11]

◆ ~ECircleShape()

◆ ECircleShape() [11/11]

Member Function Documentation

◆ Closest()

◆ CopyTo() [1/3]

◆ CopyTo() [2/3]

◆ CopyTo() [3/3]

◆ Drag()

◆ Draw() [1/9]

◆ Draw() [2/9]

◆ Draw() [3/9]

◆ Draw() [4/9]

◆ Draw() [5/9]

◆ Draw() [6/9]

◆ Draw() [7/9]

◆ Draw() [8/9]

◆ Draw() [9/9]

◆ DrawWithCurrentPen() [1/3]

◆ DrawWithCurrentPen() [2/3]

◆ DrawWithCurrentPen() [3/3]

◆ GetAmplitude()

◆ GetAngle()

◆ GetApex()

◆ GetApexAngle()

◆ GetArcLength()

◆ GetCenter()

◆ GetCenterX()

◆ GetCenterY()

◆ GetCircle()

◆ GetDiameter()

◆ GetDirect()

◆ GetEnd()

◆ GetEndAngle()

◆ GetFull()

◆ GetOrg()

◆ GetOrgAngle()

◆ GetPoint()

◆ GetRadius()

◆ GetScale()

◆ GetType()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ operator=()

◆ SetAmplitude()

◆ SetAngle()

◆ SetCenter()

◆ SetCenterXY()

◆ SetCircle()

◆ SetDiameter()

◆ SetFromCenterAndOrigin() [1/2]

◆ SetFromCenterAndOrigin() [2/2]

◆ SetFromOriginMiddleEnd() [1/2]

◆ SetFromOriginMiddleEnd() [2/2]

◆ SetRadius()

◆ SetScale()