eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::Legacy::ERectangleShape Class Reference

Manages a rectangle shape. More...

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

Inheritance diagram for eVision::Legacy::ERectangleShape:
Collaboration diagram for eVision::Legacy::ERectangleShape:

Public Member Functions

virtual ~ERectangleShape () throw ()
eVision::Legacy::ERectangleShape & operator= (const eVision::Legacy::ERectangleShape &other)
 Copies all the data from another ERectangleShape object into the current ERectangleShape 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 center coordinates of a ERectangleShape 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
 Orientation of the shape.
void SetAngle (float f32Angle)
 Orientation of the shape.
float GetScale () const
 Horizontal sensor resolution, in pixels per unit.
void SetScale (float f32Scale)
 Horizontal sensor resolution, in pixels per unit.
void SetFromTwoPoints (const eVision::EPoint &origin, const eVision::EPoint &end)
 Sets the geometric parameters of an ERectangleShape object using two opposed corners.
void SetFromOppositeCorners (const eVision::EPoint &origin, const eVision::EPoint &end)
 Sets the geometric parameters of an ERectangleShape object using two opposed corners.
void SetFromOriginMiddleEnd (const eVision::EPoint &origin, const eVision::EPoint &middle, const eVision::EPoint &end)
 Sets the geometric parameters of an ERectangleShape object using three corners.
void SetFromThreeCorners (const eVision::EPoint &origin, const eVision::EPoint &middle, const eVision::EPoint &end)
 Sets the geometric parameters of an ERectangleShape object using three corners.
virtual void SetRectangle (const eVision::Legacy::ERectangle &rectangle)
 Sets the parameters of the rectangle according to a known ERectangle object.
void SetSize (float sizeX, float sizeY)
 Sets the size of a ERectangleShape object.
float GetSizeX () const
 X size of the ERectangleShape.
float GetSizeY () const
 Y size of the ERectangleShape.
eVision::EPoint GetPoint (float fractionX, float fractionY)
 Returns the coordinates of a particular point, specified by its location in the ERectangleShape area.
void GetMidEdges (eVision::EPoint &x, eVision::EPoint &XX, eVision::EPoint &y, eVision::EPoint &YY)
 Retrieves the center coordinates of each edge of a ERectangleShape object.
void GetCorners (eVision::EPoint &xy, eVision::EPoint &XXy, eVision::EPoint &xYY, eVision::EPoint &XXYY)
 Retrieves the coordinates of each corner of a ERectangleShape object.
void GetEdges (eVision::Legacy::ELine &x, eVision::Legacy::ELine &XX, eVision::Legacy::ELine &y, eVision::Legacy::ELine &YY)
 Retrieves each edge of a ERectangleShape object.
void CopyTo (eVision::Legacy::ERectangleShape &dest, bool bRecursive) const
 Copies all the data of the current ERectangleShape object into another ERectangleShape object and returns it.
void CopyTo (eVision::Legacy::ERectangleShape &dest) const
 Copies all the data of the current ERectangleShape object into another ERectangleShape object and returns it.
eVision::Legacy::ERectangleShape * CopyTo (eVision::Legacy::ERectangleShape *dest, bool bRecursive) const
 Copies all the data of the current ERectangleShape object into another ERectangleShape object and returns it.
virtual eVision::EShapeType GetType () const
 Shape type.
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 n32CursorX, int32_t n32CursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
 ERectangleShape (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 rectangle shape.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ ~ERectangleShape()

eVision::Legacy::ERectangleShape::~ERectangleShape ( )
throw ( )
virtual

◆ ERectangleShape()

eVision::Legacy::ERectangleShape::ERectangleShape ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Closest()

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

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

Parameters
destPointer to the ERectangleShape object in which the current ERectangleShape object data have to be copied.

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

◆ CopyTo() [2/3]

void eVision::Legacy::ERectangleShape::CopyTo ( eVision::Legacy::ERectangleShape & dest,
bool bRecursive ) const

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

Parameters
destPointer to the ERectangleShape object in which the current ERectangleShape object data have to be copied.
bRecursivetrue if the children shapes have to be copied as well, false otherwise.

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

◆ CopyTo() [3/3]

eVision::Legacy::ERectangleShape * eVision::Legacy::ERectangleShape::CopyTo ( eVision::Legacy::ERectangleShape * dest,
bool bRecursive ) const

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

Parameters
destPointer to the ERectangleShape object in which the current ERectangleShape object data have to be copied.
bRecursivetrue if the children shapes have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new ERectangleShape 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::ERectangleShape::Drag ( int32_t n32CursorX,
int32_t n32CursorY )
virtual

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

Parameters
n32CursorXCurrent cursor coordinates.
n32CursorYCurrent cursor coordinates.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ Draw() [1/9]

void eVision::Legacy::ERectangleShape::Draw ( eVision::EDrawAdapter * graphicContext)
virtual

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

Parameters
graphicContextHandle of the device context on which to draw.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ Draw() [2/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ Draw() [3/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ Draw() [4/9]

void eVision::Legacy::ERectangleShape::Draw ( HDC graphicContext)
virtual

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

Parameters
graphicContextHandle 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::ERectangleGauge.

◆ Draw() [5/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
colorThe 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::ERectangleGauge.

◆ Draw() [6/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color to draw with.
drawingModeIndicates 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::ERectangleGauge.

◆ Draw() [7/9]

void eVision::Legacy::ERectangleShape::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
graphicContextHandle of the device context on which to draw.
colorThe color to draw with.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue 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::ERectangleGauge.

◆ Draw() [8/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates 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::ERectangleGauge.

◆ Draw() [9/9]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue 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::ERectangleGauge.

◆ DrawWithCurrentPen() [1/3]

void eVision::Legacy::ERectangleShape::DrawWithCurrentPen ( HDC graphicContext)
virtual

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

Parameters
graphicContextHandle 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::ERectangleGauge.

◆ DrawWithCurrentPen() [2/3]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates 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::ERectangleGauge.

◆ DrawWithCurrentPen() [3/3]

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

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue 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::ERectangleGauge.

◆ GetAngle()

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

Orientation of the shape.

◆ GetCenter()

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

Center point of the shape.

◆ GetCenterX()

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

Abscissa of the origin point of the shape.

◆ GetCenterY()

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

Ordinate of the origin point of the shape.

◆ GetCorners()

void eVision::Legacy::ERectangleShape::GetCorners ( eVision::EPoint & xy,
eVision::EPoint & XXy,
eVision::EPoint & xYY,
eVision::EPoint & XXYY )

Retrieves the coordinates of each corner of a ERectangleShape object.

Parameters
xyCoordinates of the lower leftmost corner of the ERectangleShape object.
XXyCoordinates of the lower rightmost corner of the ERectangleShape object.
xYYCoordinates of the upper leftmost corner of the ERectangleShape object.
XXYYCoordinates of the upper rightmost corner of the ERectangleShape object.

◆ GetEdges()

void eVision::Legacy::ERectangleShape::GetEdges ( eVision::Legacy::ELine & x,
eVision::Legacy::ELine & XX,
eVision::Legacy::ELine & y,
eVision::Legacy::ELine & YY )

Retrieves each edge of a ERectangleShape object.

Parameters
xLeftmost edge of the ERectangleShape object.
XXRightmost edge of the ERectangleShape object.
yLower edge of the ERectangleShape object.
YYUpper edge of the ERectangleShape object.

◆ GetMidEdges()

void eVision::Legacy::ERectangleShape::GetMidEdges ( eVision::EPoint & x,
eVision::EPoint & XX,
eVision::EPoint & y,
eVision::EPoint & YY )

Retrieves the center coordinates of each edge of a ERectangleShape object.

Parameters
xCenter coordinates of the leftmost edge of the ERectangleShape object.
XXCenter coordinates of the rightmost edge of the ERectangleShape object.
yCenter coordinates of the lower edge of the ERectangleShape object.
YYCenter coordinates of the upper edge of the ERectangleShape object.

◆ GetPoint()

eVision::EPoint eVision::Legacy::ERectangleShape::GetPoint ( float fractionX,
float fractionY )

Returns the coordinates of a particular point, specified by its location in the ERectangleShape area.

Parameters
fractionXPoint location expressed as a fraction of the ERectangleShape vertical edges (range -1, +1).
fractionYPoint location expressed as a fraction of the ERectangleShape horizontal edges (range -1, +1).

◆ GetScale()

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

Horizontal sensor resolution, in pixels per unit.

◆ GetSizeX()

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

X size of the ERectangleShape.

◆ GetSizeY()

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

Y size of the ERectangleShape.

◆ GetType()

eVision::EShapeType eVision::Legacy::ERectangleShape::GetType ( ) const
virtual

Shape type.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ HitTest() [1/2]

bool eVision::Legacy::ERectangleShape::HitTest ( )
virtual

Checks if there is a handle under the cursor.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ HitTest() [2/2]

bool eVision::Legacy::ERectangleShape::HitTest ( bool bDaughters)
virtual

Checks if there is a handle under the cursor.

Parameters
bDaughtersIndicates if the check must be done in the whole hierarchy or just this object.

Implements eVision::Legacy::EShape.

Reimplemented in eVision::Legacy::ERectangleGauge.

◆ operator=()

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

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

Parameters
otherERectangleShape object to be copied

◆ SetAngle()

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

Orientation of the shape.

◆ SetCenter()

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

Center point of the shape.

◆ SetCenterXY()

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

Sets the center coordinates of a ERectangleShape object.

Parameters
centerXCenter coordinates of the ERectangleShape object.
centerYCenter coordinates of the ERectangleShape object.

◆ SetFromOppositeCorners()

void eVision::Legacy::ERectangleShape::SetFromOppositeCorners ( const eVision::EPoint & origin,
const eVision::EPoint & end )

Sets the geometric parameters of an ERectangleShape object using two opposed corners.

Parameters
originOrigin point coordinates of the rectangle.
endEnd point coordinates of the rectangle.

In a direct coordinate system, the abscissa extends rightwards and the ordinate extends upwards. The coordinate system is said to be inverse if the abscissa extends rightwards and the ordinate extends downwards.

◆ SetFromOriginMiddleEnd()

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

Sets the geometric parameters of an ERectangleShape object using three corners.

Parameters
originOrigin point coordinates of the rectangle.
middleMiddle point coordinates of the rectangle.
endEnd point coordinates of the rectangle.

In a direct coordinate system, the abscissa extends rightwards and the ordinate extends upwards. The coordinate system is said to be inverse if the abscissa extends rightwards and the ordinate extends downwards.

Deprecated

Use ERectangleShape::SetFromThreeCorners instead.

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

◆ SetFromThreeCorners()

void eVision::Legacy::ERectangleShape::SetFromThreeCorners ( const eVision::EPoint & origin,
const eVision::EPoint & middle,
const eVision::EPoint & end )

Sets the geometric parameters of an ERectangleShape object using three corners.

Parameters
originOrigin point coordinates of the rectangle.
middleMiddle point coordinates of the rectangle.
endEnd point coordinates of the rectangle.

In a direct coordinate system, the abscissa extends rightwards and the ordinate extends upwards. The coordinate system is said to be inverse if the abscissa extends rightwards and the ordinate extends downwards.

◆ SetFromTwoPoints()

void eVision::Legacy::ERectangleShape::SetFromTwoPoints ( const eVision::EPoint & origin,
const eVision::EPoint & end )

Sets the geometric parameters of an ERectangleShape object using two opposed corners.

Parameters
originOrigin point coordinates of the rectangle.
endEnd point coordinates of the rectangle.

In a direct coordinate system, the abscissa extends rightwards and the ordinate extends upwards. The coordinate system is said to be inverse if the abscissa extends rightwards and the ordinate extends downwards.

Deprecated

Use ERectangleShape::SetFromOppositeCorners instead.

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

◆ SetRectangle()

void eVision::Legacy::ERectangleShape::SetRectangle ( const eVision::Legacy::ERectangle & rectangle)
virtual

Sets the parameters of the rectangle according to a known ERectangle object.

◆ SetScale()

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

Horizontal sensor resolution, in pixels per unit.

◆ SetSize()

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

Sets the size of a ERectangleShape object.

Parameters
sizeXNominal size X of the ERectangleShape object. Default values is 100.
sizeYNominal size Y of the ERectangleShape object. Default values is 100.

A ERectangleShape object is fully defined knowing its nominal position (given by the coordinates of its center), its nominal size, its rotation angle and its outline tolerance. By default, the width and height values are 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.