Manages a complete context for measuring frame shapes. More...

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

Inheritance diagram for eVision::Legacy::EFrameShape:

Collaboration diagram for eVision::Legacy::EFrameShape:

Public Member Functions
	EFrameShape ()
	Construct a EFrameShape object.
	EFrameShape (const eVision::Legacy::EFrameShape &frameShape)
	Construct a EFrameShape object.
virtual	~EFrameShape () throw ()
eVision::Legacy::EFrameShape &	operator= (const eVision::Legacy::EFrameShape &other)
	Assignement operator.
void	CopyTo (eVision::Legacy::EFrameShape &other, bool recursive) const
	Copy operator.
void	CopyTo (eVision::Legacy::EFrameShape &other) const
	Copy operator.
eVision::Legacy::EFrameShape *	CopyTo (eVision::Legacy::EFrameShape *other, bool recursive) const
	Copy operator.
virtual eVision::EShapeType	GetType () const
	Type of the frame.
eVision::EPoint	GetCenter () const
	Origin point coordinates of the frame.
void	SetCenter (const eVision::EPoint &point)
	Origin point coordinates of the frame.
void	SetCenterXY (float centerX, float centerY)
	Sets the origin point coordinates of the frame.
float	GetCenterX () const
	Gets the origin point abscissa of the frame.
float	GetCenterY () const
	Gets the origin point ordinate of the frame.
float	GetAngle () const
	The angle of the frame.
void	SetAngle (float angle)
	The angle of the frame.
float	GetScale () const
	The scale of the frame.
void	SetScale (float scale)
	The scale of the frame.
float	GetSizeX () const
	Frame X-axis length.
float	GetSizeY () const
	Frame Y-axis length.
void	Set (const eVision::EPoint &center, float angle, float scale)
	Sets the coordinates of the origin point and the orientation of the frame.
void	Set (const eVision::EPoint &center, float angle)
	Sets the coordinates of the origin point and the orientation of the frame.
void	Set (const eVision::EPoint &center)
	Sets the coordinates of the origin point and the orientation of the frame.
void	SetSize (float sizeX, float sizeY)
	Sets the frame size.
void	SetSize (float sizeX)
	Sets the frame size.
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 daughter)
	Checks whether the cursor is positioned over a handle (true) or not (false).
virtual bool	HitTest ()
	Checks whether the cursor is positioned over a handle (true) or not (false).
virtual void	Drag (int32_t cursorX, int32_t cursorY)
	Moves a handle to a new position and updates the position parameters of the shape.
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.
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax, uint32_t un32NumXIntervals, uint32_t un32NumYIntervals)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax, uint32_t un32NumXIntervals)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin, float f32XMax, float f32YMin)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin, float f32XMax)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext, float f32XMin)
void	DrawCrossGrid (eVision::EDrawAdapter *graphicContext)
void	DrawCrossGrid (HDC dc, float f32XMin, float f32XMax, float f32YMin, float f32YMax, uint32_t un32NumXIntervals, uint32_t un32NumYIntervals)
void	DrawCrossGrid (HDC dc, float f32XMin, float f32XMax, float f32YMin, float f32YMax, uint32_t un32NumXIntervals)
void	DrawCrossGrid (HDC dc, float f32XMin, float f32XMax, float f32YMin, float f32YMax)
void	DrawCrossGrid (HDC dc, float f32XMin, float f32XMax, float f32YMin)
void	DrawCrossGrid (HDC dc, float f32XMin, float f32XMax)
void	DrawCrossGrid (HDC dc, float f32XMin)
void	DrawCrossGrid (HDC dc)
	EFrameShape (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 complete context for measuring frame shapes.

This class allows the grouping of several gauges or other frames.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EFrameShape() [1/3]

eVision::Legacy::EFrameShape::EFrameShape ( )

Construct a EFrameShape object.

With the default constructor, all parameters are initialized to their respective default value. With the copy constructor, the constructed frame shape measurement context is based on a pre-existing EFrameShape object. By default, the daughter shapes are also copied. Use the EFrameShape::CopyTo method to disable explicitly the daughter shapes copy.

◆ EFrameShape() [2/3]

eVision::Legacy::EFrameShape::EFrameShape ( const eVision::Legacy::EFrameShape & frameShape )

Construct a EFrameShape object.

Parameters

frameShape Pre-existing EFrameShape object used by the copy constructor.

With the default constructor, all parameters are initialized to their respective default value. With the copy constructor, the constructed frame shape measurement context is based on a pre-existing EFrameShape object. By default, the daughter shapes are also copied. Use the EFrameShape::CopyTo method to disable explicitly the daughter shapes copy.

◆ ~EFrameShape()

eVision::Legacy::EFrameShape::~EFrameShape	(		)
throw	(	)

virtual

◆ EFrameShape() [3/3]

eVision::Legacy::EFrameShape::EFrameShape ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Closest()

void eVision::Legacy::EFrameShape::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::EFrameShape::CopyTo ( eVision::Legacy::EFrameShape & other ) const

Copy operator.

Parameters

other EFrameShape object to copy to.

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

◆ CopyTo() [2/3]

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

Copy operator.

Parameters

other	EFrameShape object to copy to.
recursive	true if the daughter shapes have to be copied as well, false otherwise.

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

◆ CopyTo() [3/3]

eVision::Legacy::EFrameShape * eVision::Legacy::EFrameShape::CopyTo	(	eVision::Legacy::EFrameShape *	other,
		bool	recursive ) const

Copy operator.

Parameters

other	EFrameShape object to copy to.
recursive	true if the daughter shapes have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new EFrameShape 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::EFrameShape::Drag	(	int32_t	cursorX,
		int32_t	cursorY )

virtual

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

Parameters

cursorX	Current cursor coordinates.
cursorY	Current cursor coordinates.

Implements eVision::Legacy::EShape.

◆ Draw() [1/9]

void eVision::Legacy::EFrameShape::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.

◆ Draw() [2/9]

void eVision::Legacy::EFrameShape::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 shape must be displayed, as defined by EDrawingMode.

Implements eVision::Legacy::EShape.

◆ Draw() [3/9]

void eVision::Legacy::EFrameShape::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 shape must be displayed, as defined by EDrawingMode.
daughters	true if the daughter shapes are to be displayed also.

Implements eVision::Legacy::EShape.

◆ Draw() [4/9]

void eVision::Legacy::EFrameShape::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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ Draw() [5/9]

void eVision::Legacy::EFrameShape::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 in which to draw the overlay.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ Draw() [6/9]

void eVision::Legacy::EFrameShape::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 in which to draw the overlay.
drawingMode	Indicates how the shape must be displayed, as defined by EDrawingMode.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ Draw() [7/9]

void eVision::Legacy::EFrameShape::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 in which to draw the overlay.
drawingMode	Indicates how the shape must be displayed, as defined by EDrawingMode.
daughters	true if the daughter shapes are to be displayed also.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ Draw() [8/9]

void eVision::Legacy::EFrameShape::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 shape must be displayed, as defined by EDrawingMode.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ Draw() [9/9]

void eVision::Legacy::EFrameShape::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 shape must be displayed, as defined by EDrawingMode.
daughters	true if the daughter shapes are to be displayed also.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ DrawCrossGrid() [1/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid ( eVision::EDrawAdapter * graphicContext )

◆ DrawCrossGrid() [2/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin )

◆ DrawCrossGrid() [3/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin,
		float	f32XMax )

◆ DrawCrossGrid() [4/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin )

◆ DrawCrossGrid() [5/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax )

◆ DrawCrossGrid() [6/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax,
		uint32_t	un32NumXIntervals )

◆ DrawCrossGrid() [7/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	eVision::EDrawAdapter *	graphicContext,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax,
		uint32_t	un32NumXIntervals,
		uint32_t	un32NumYIntervals )

◆ DrawCrossGrid() [8/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid ( HDC dc )

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

◆ DrawCrossGrid() [9/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin )

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

◆ DrawCrossGrid() [10/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin,
		float	f32XMax )

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

◆ DrawCrossGrid() [11/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin )

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

◆ DrawCrossGrid() [12/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax )

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

◆ DrawCrossGrid() [13/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax,
		uint32_t	un32NumXIntervals )

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

◆ DrawCrossGrid() [14/14]

void eVision::Legacy::EFrameShape::DrawCrossGrid	(	HDC	dc,
		float	f32XMin,
		float	f32XMax,
		float	f32YMin,
		float	f32YMax,
		uint32_t	un32NumXIntervals,
		uint32_t	un32NumYIntervals )

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

◆ DrawWithCurrentPen() [1/3]

void eVision::Legacy::EFrameShape::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

Use the overload of EFrameShape::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ DrawWithCurrentPen() [2/3]

void eVision::Legacy::EFrameShape::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

Use the overload of EFrameShape::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ DrawWithCurrentPen() [3/3]

void eVision::Legacy::EFrameShape::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

Use the overload of EFrameShape::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Implements eVision::Legacy::EShape.

◆ GetAngle()

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

The angle of the frame.

◆ GetCenter()

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

Origin point coordinates of the frame.

◆ GetCenterX()

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

Gets the origin point abscissa of the frame.

◆ GetCenterY()

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

Gets the origin point ordinate of the frame.

◆ GetScale()

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

The scale of the frame.

◆ GetSizeX()

float eVision::Legacy::EFrameShape::GetSizeX ( ) const

Frame X-axis length.

By default, both frame axis values are set to 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.

◆ GetSizeY()

float eVision::Legacy::EFrameShape::GetSizeY ( ) const

Frame Y-axis length.

By default, both frame axis values are set to 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.

◆ GetType()

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

virtual

Type of the frame.

Implements eVision::Legacy::EShape.

◆ HitTest() [1/2]

bool eVision::Legacy::EFrameShape::HitTest ( )

virtual

Checks whether the cursor is positioned over a handle (true) or not (false).

Implements eVision::Legacy::EShape.

◆ HitTest() [2/2]

bool eVision::Legacy::EFrameShape::HitTest ( bool daughter )

virtual

Checks whether the cursor is positioned over a handle (true) or not (false).

Parameters

daughter true if the daughters shapes handles have to be considered as well.

Implements eVision::Legacy::EShape.

◆ operator=()

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

Assignement operator.

Parameters

other EFrameShape object to copy.

By default, the daughter shapes are also copied. Use the EFrameShape::CopyTo method to disable explicitly the daughter shapes copy.

◆ Set() [1/3]

void eVision::Legacy::EFrameShape::Set ( const eVision::EPoint & center )

Sets the coordinates of the origin point and the orientation of the frame.

Parameters

center Coordinates of the origin point of the frame. The default value is (0,0).

◆ Set() [2/3]

void eVision::Legacy::EFrameShape::Set	(	const eVision::EPoint &	center,
		float	angle )

Sets the coordinates of the origin point and the orientation of the frame.

Parameters

center	Coordinates of the origin point of the frame. The default value is (0,0).
angle	Rotation angle of the frame. The default value is 0.

◆ Set() [3/3]

void eVision::Legacy::EFrameShape::Set	(	const eVision::EPoint &	center,
		float	angle,
		float	scale )

Sets the coordinates of the origin point and the orientation of the frame.

Parameters

center	Coordinates of the origin point of the frame. The default value is (0,0).
angle	Rotation angle of the frame. The default value is 0.
scale	Horizontal sensor resolution, in pixels per unit

◆ SetAngle()

void eVision::Legacy::EFrameShape::SetAngle ( float angle )

The angle of the frame.

Parameters

angle The angle.

◆ SetCenter()

void eVision::Legacy::EFrameShape::SetCenter ( const eVision::EPoint & point )

Origin point coordinates of the frame.

Parameters

point Coordinates of the origin point of the frame.

◆ SetCenterXY()

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

Sets the origin point coordinates of the frame.

Parameters

centerX	Abscissa of the origin point of the frame. Default value is 0.
centerY	Ordinate of the origin point of the frame. Default value is 0.

◆ SetScale()

void eVision::Legacy::EFrameShape::SetScale ( float scale )

The scale of the frame.

Parameters

scale The scale.

◆ SetSize() [1/2]

void eVision::Legacy::EFrameShape::SetSize ( float sizeX )

Sets the frame size.

Parameters

sizeX Frame X-axis length. The default value is 100.

By default, both frame axis value are set to 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

◆ SetSize() [2/2]

void eVision::Legacy::EFrameShape::SetSize	(	float	sizeX,
		float	sizeY )

Sets the frame size.

Parameters

sizeX	Frame X-axis length. The default value is 100.
sizeY	Frame Y-axis length. By default, both axes have the same length.

By default, both frame axis value are set to 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EFrameShape() [1/3]

◆ EFrameShape() [2/3]

◆ ~EFrameShape()

◆ EFrameShape() [3/3]

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]

◆ DrawCrossGrid() [1/14]

◆ DrawCrossGrid() [2/14]

◆ DrawCrossGrid() [3/14]

◆ DrawCrossGrid() [4/14]

◆ DrawCrossGrid() [5/14]

◆ DrawCrossGrid() [6/14]

◆ DrawCrossGrid() [7/14]

◆ DrawCrossGrid() [8/14]

◆ DrawCrossGrid() [9/14]

◆ DrawCrossGrid() [10/14]

◆ DrawCrossGrid() [11/14]

◆ DrawCrossGrid() [12/14]

◆ DrawCrossGrid() [13/14]

◆ DrawCrossGrid() [14/14]

◆ DrawWithCurrentPen() [1/3]

◆ DrawWithCurrentPen() [2/3]

◆ DrawWithCurrentPen() [3/3]

◆ GetAngle()

◆ GetCenter()

◆ GetCenterX()

◆ GetCenterY()

◆ GetScale()

◆ GetSizeX()

◆ GetSizeY()

◆ GetType()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ operator=()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetAngle()

◆ SetCenter()

◆ SetCenterXY()

◆ SetScale()

◆ SetSize() [1/2]

◆ SetSize() [2/2]