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

Abstract class to federate the classes that can be hierarchically attached together (from a geometrical point of view). More...

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

Inheritance diagram for eVision::Legacy::EShape:
Collaboration diagram for eVision::Legacy::EShape:

Public Member Functions

virtual ~EShape () throw ()
virtual eVision::EShapeType GetType () const =0
 Shape type.
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 void Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool daughters)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (eVision::EDrawAdapter *graphicContext)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, eVision::EDrawingMode drawingMode)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext)=0
 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)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, const eVision::ERGBColor &color)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext)=0
 Draws a graphical representation of a shape, as defined by EDrawingMode.
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.
virtual bool HitTest (bool bDaughters)=0
 Checks if there is a handle under the cursor.
virtual bool HitTest ()=0
 Checks if there is a handle under the cursor.
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.
virtual void Drag (int32_t n32CursorX, int32_t n32CursorY)=0
 Moves a handle to a new position and updates the position parameters of the shape.
virtual void Closest ()=0
 Find the daughter shape that is the closest to this shape. To retrieve the closest shape, use EShape::GetClosestShape.
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)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Abstract class to federate the classes that can be hierarchically attached together (from a geometrical point of view).

License(s): BasicTypes

Constructor & Destructor Documentation

◆ ~EShape()

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

◆ EShape()

eVision::Legacy::EShape::EShape ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Attach()

void eVision::Legacy::EShape::Attach ( eVision::Legacy::EShape * mother)

Attaches the gauge to a mother gauge or shape.

Parameters
motherPointer to the mother gauge or shape.

When attached to a mother gauge, be aware that daughter gauges are not positioned according to the nominal mother gauge position, but to its corresponding fitted model.

◆ Closest()

virtual void eVision::Legacy::EShape::Closest ( )
pure virtual

◆ Detach()

void eVision::Legacy::EShape::Detach ( )

Detaches the gauge from its mother gauge or shape.

◆ DetachDaughters()

void eVision::Legacy::EShape::DetachDaughters ( )

Detaches the daughter gauges or shapes.

◆ DisableBehaviorFilter()

void eVision::Legacy::EShape::DisableBehaviorFilter ( eVision::EShapeBehavior behavior)

Disables (i.e. removes) a condition from the list of conditions in the behavior filter.

Parameters
behaviorThe behavior of the shape to be removed from the behavior filter.

The condition to be disabled is identified by the behavior about which the condition is. Disabling a behavior leads to less restrictive conditions for the Draw and HitTest methods to be actually carried on.

◆ DisableTypeFilter()

void eVision::Legacy::EShape::DisableTypeFilter ( )
virtual

Enables all shape types.

Reimplemented in eVision::Legacy::EWorldShape.

◆ Drag()

virtual void eVision::Legacy::EShape::Drag ( int32_t n32CursorX,
int32_t n32CursorY )
pure virtual

◆ Draw() [1/9]

◆ Draw() [2/9]

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

◆ Draw() [3/9]

virtual void eVision::Legacy::EShape::Draw ( eVision::EDrawAdapter * graphicContext,
eVision::EDrawingMode drawingMode,
bool daughters )
pure 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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [4/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext)
pure virtual

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

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

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [5/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext,
const eVision::ERGBColor & color )
pure 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

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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [6/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EDrawingMode drawingMode )
pure 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

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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [7/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EDrawingMode drawingMode,
bool daughters )
pure 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

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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [8/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext,
eVision::EDrawingMode drawingMode )
pure 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

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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ Draw() [9/9]

virtual void eVision::Legacy::EShape::Draw ( HDC graphicContext,
eVision::EDrawingMode drawingMode,
bool daughters )
pure 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

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.

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ DrawWithCurrentPen() [1/3]

virtual void eVision::Legacy::EShape::DrawWithCurrentPen ( HDC graphicContext)
pure virtual

◆ DrawWithCurrentPen() [2/3]

virtual void eVision::Legacy::EShape::DrawWithCurrentPen ( HDC graphicContext,
eVision::EDrawingMode drawingMode )
pure 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

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

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

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ DrawWithCurrentPen() [3/3]

virtual void eVision::Legacy::EShape::DrawWithCurrentPen ( HDC graphicContext,
eVision::EDrawingMode drawingMode,
bool daughters )
pure 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

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

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

Implemented in eVision::Legacy::ECircleGauge, eVision::Legacy::ECircleShape, eVision::Legacy::EFrameShape, eVision::Legacy::ELineGauge, eVision::Legacy::ELineShape, eVision::Legacy::EPointGauge, eVision::Legacy::EPointShape, eVision::Legacy::EPolygonGauge, eVision::Legacy::EPolygonShape, eVision::Legacy::ERectangleGauge, eVision::Legacy::ERectangleShape, eVision::Legacy::EWedgeGauge, eVision::Legacy::EWedgeShape, and eVision::Legacy::EWorldShape.

◆ EnableBehaviorFilter() [1/2]

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

Parameters
behaviorThe behavior of the shape to be tested.

This method registers a new necessary condition for the Draw and HitTest families of methods to be actually carried on. Such a condition is about the behavior of the shape, as specified by the behavior argument. Initially, the behavior filter contains an empty list of conditions, which means that the Draw and HitTest methods will always be executed. Adding a new condition through EShape::EnableBehaviorFilter will introduce a new restriction on the effective execution of these methods. Use EShape::DisableBehaviorFilter to remove a condition from the behavior filter.

◆ EnableBehaviorFilter() [2/2]

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

Parameters
behaviorThe behavior of the shape to be tested.
valueThe value at which the behavior property should be set to pass the test. By default, equals True.

This method registers a new necessary condition for the Draw and HitTest families of methods to be actually carried on. Such a condition is about the behavior of the shape, as specified by the behavior argument. Initially, the behavior filter contains an empty list of conditions, which means that the Draw and HitTest methods will always be executed. Adding a new condition through EShape::EnableBehaviorFilter will introduce a new restriction on the effective execution of these methods. Use EShape::DisableBehaviorFilter to remove a condition from the behavior filter.

◆ EnableTypeFilter()

void eVision::Legacy::EShape::EnableTypeFilter ( uint32_t un32Types)
virtual

Enables the filter of the specified shape type.

Parameters
un32TypesThe type of the shape to filter.

Reimplemented in eVision::Legacy::EWorldShape.

◆ GetActive()

bool eVision::Legacy::EShape::GetActive ( ) const
virtual

Flag indicating whether the shape is active or not.

◆ GetActualShape()

bool eVision::Legacy::EShape::GetActualShape ( ) const

Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

◆ GetAllocated()

bool eVision::Legacy::EShape::GetAllocated ( ) const

Gets the allocated flag.

◆ GetAutoArrange()

bool eVision::Legacy::EShape::GetAutoArrange ( ) const

◆ GetClosestShape()

eVision::Legacy::EShape * eVision::Legacy::EShape::GetClosestShape ( ) const

Closest shape among the daughters.

Use EShape::Closest to recompute the closest shape.

◆ GetDaughter()

eVision::Legacy::EShape * eVision::Legacy::EShape::GetDaughter ( uint32_t index) const
virtual

Returns a pointer to the specified daughter gauge or shape.

Parameters
indexDaughter gauge or shape index.

◆ GetDragable()

bool eVision::Legacy::EShape::GetDragable ( ) const

Flag indicating whether the shape can be dragged or not.

◆ GetDraggingMode()

eVision::EDraggingMode eVision::Legacy::EShape::GetDraggingMode ( ) const

Gets the dragging mode which defines how the shape could be dragged.

◆ GetFound()

bool eVision::Legacy::EShape::GetFound ( ) const

Flag indicating whether a measured shape has been found.

After calling Process() or Measure() on a gauge object, use GetFound() to get the status of the measurement.

◆ GetHitHandle()

eVision::EDragHandle eVision::Legacy::EShape::GetHitHandle ( ) const

Handle currently under the cursor.

When the cursor is over a particular handle, its shape could be changed for feedback.

◆ GetHitShape()

eVision::Legacy::EShape * eVision::Legacy::EShape::GetHitShape ( ) const

Pointer to the shape currently under the cursor.

When the cursor is over a particular shape, its shape could be changed for feedback.

◆ GetInspected()

bool eVision::Legacy::EShape::GetInspected ( ) const

◆ GetLabeled()

bool eVision::Legacy::EShape::GetLabeled ( ) const

Flag indicating whether the shape label should be displayed or not.

◆ GetMother()

eVision::Legacy::EShape * eVision::Legacy::EShape::GetMother ( ) const

Pointer to the mother shape.

◆ GetName()

std::string eVision::Legacy::EShape::GetName ( ) const

Name of the EShape object.

◆ GetNumDaughters()

uint32_t eVision::Legacy::EShape::GetNumDaughters ( ) const

Number of daughters attached to the shape.

◆ GetOptionalDraw()

bool eVision::Legacy::EShape::GetOptionalDraw ( ) const

◆ GetPanX()

float eVision::Legacy::EShape::GetPanX ( ) const
virtual

Current horizontal panning value for drawing operations, expressed in pixels. By default, no panning occurs.

Reimplemented in eVision::Legacy::EWorldShape.

◆ GetPanY()

float eVision::Legacy::EShape::GetPanY ( ) const
virtual

Current vertical panning value for drawing operations, expressed in pixels. By default, no panning occurs.

Reimplemented in eVision::Legacy::EWorldShape.

◆ GetPassed()

bool eVision::Legacy::EShape::GetPassed ( ) const

◆ GetProperty()

std::string eVision::Legacy::EShape::GetProperty ( const std::string & aProperty) const

Gets the value of property aProperty. Throws an exception if no such property exists.

Parameters
aPropertyThe name of the property.

◆ GetQuickDraw()

bool eVision::Legacy::EShape::GetQuickDraw ( ) const

◆ GetResizable()

bool eVision::Legacy::EShape::GetResizable ( ) const

Flag indicating whether the shape can be resized or not.

◆ GetRotatable()

bool eVision::Legacy::EShape::GetRotatable ( ) const

Flag indicating whether the shape can be rotated or not.

◆ GetSelectable()

bool eVision::Legacy::EShape::GetSelectable ( ) const

Flag indicating whether the shape can be selected or not.

◆ GetSelected()

bool eVision::Legacy::EShape::GetSelected ( ) const

Flag indicating whether the shape is selected or not.

◆ GetShapeNamed()

eVision::Legacy::EShape * eVision::Legacy::EShape::GetShapeNamed ( const std::string & name)

Returns a pointer to a daughter gauge or shape specified by its name.

Parameters
nameName of the daughter gauge or shape.

◆ GetType()

◆ GetUserFlag()

bool eVision::Legacy::EShape::GetUserFlag ( ) const

◆ GetVisible()

bool eVision::Legacy::EShape::GetVisible ( ) const

Flag indicating whether the shape is visible or not.

◆ GetWorldShape()

eVision::Legacy::EWorldShape * eVision::Legacy::EShape::GetWorldShape ( ) const

World ancestor.

◆ GetZoomX()

float eVision::Legacy::EShape::GetZoomX ( ) const
virtual

Current horizontal zooming factor for drawing operations.

Reimplemented in eVision::Legacy::EWorldShape.

◆ GetZoomY()

float eVision::Legacy::EShape::GetZoomY ( ) const
virtual

Current vertical zooming factor for drawing operations.

Reimplemented in eVision::Legacy::EWorldShape.

◆ HasProperty()

bool eVision::Legacy::EShape::HasProperty ( const std::string & aProperty) const

Returns whether a EShape has a property named aProperty.

Parameters
aPropertyThe name of the property.

◆ HasValidPolarityProperty()

bool eVision::Legacy::EShape::HasValidPolarityProperty ( ) const

Returns whether the EShape has a valid polarity property.

I.e. if it has a property named "polarity" whose value is either "inverted" or "direct".

The "polarity" property is mostly used to define the orientation of the gradient in a shape of a EVectorModel.

◆ HitTest() [1/2]

◆ HitTest() [2/2]

virtual bool eVision::Legacy::EShape::HitTest ( bool bDaughters)
pure virtual

◆ InvalidateWorld()

void eVision::Legacy::EShape::InvalidateWorld ( )

Invalidates the world shape for this shape and all its ancestors.

◆ IsWorld()

bool eVision::Legacy::EShape::IsWorld ( ) const

◆ Load() [1/4]

void eVision::Legacy::EShape::Load ( const std::string & path)

Loads a Shape.The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [2/4]

void eVision::Legacy::EShape::Load ( const std::string & path,
bool daughters )

Loads a Shape.The given ESerializer must have been created for reading.

Parameters
pathThe file path.
daughtersIndicates if the load must be done on the whole hierarchy or just this object.

◆ Load() [3/4]

void eVision::Legacy::EShape::Load ( eVision::ESerializer * serializer)

Loads a Shape.The given ESerializer must have been created for reading.

Parameters
serializerPointer to the ESerializer created for reading.

◆ Load() [4/4]

void eVision::Legacy::EShape::Load ( eVision::ESerializer * serializer,
bool daughters )

Loads a Shape.The given ESerializer must have been created for reading.

Parameters
serializerPointer to the ESerializer created for reading.
daughtersIndicates if the load must be done on the whole hierarchy or just this object.

◆ LocalToSensor()

eVision::EPoint eVision::Legacy::EShape::LocalToSensor ( const eVision::EPoint & LPoint)

Transforms a point from local coordinates to sensor coordinates.

Parameters
LPointThe point in local coordinates.

◆ Process() [1/4]

◆ Process() [2/4]

◆ Process() [3/4]

◆ Process() [4/4]

◆ RemoveProperty()

void eVision::Legacy::EShape::RemoveProperty ( const std::string & aProperty)

Removes the property name aProperty from the EShape.

Parameters
aPropertyThe name of the property.

◆ Save() [1/4]

void eVision::Legacy::EShape::Save ( const std::string & path)

Loads a Shape.The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/4]

void eVision::Legacy::EShape::Save ( const std::string & path,
bool daughters )

Loads a Shape.The given ESerializer must have been created for writing.

Parameters
pathThe file path.
daughtersIndicates if the save must be done on the whole hierarchy or just this object.

◆ Save() [3/4]

void eVision::Legacy::EShape::Save ( eVision::ESerializer * serializer)

Loads a Shape.The given ESerializer must have been created for writing.

Parameters
serializerPointer to the ESerializer created for writing.

◆ Save() [4/4]

void eVision::Legacy::EShape::Save ( eVision::ESerializer * serializer,
bool daughters )

Loads a Shape.The given ESerializer must have been created for writing.

Parameters
serializerPointer to the ESerializer created for writing.
daughtersIndicates if the save must be done on the whole hierarchy or just this object.

◆ SensorToLocal()

eVision::EPoint eVision::Legacy::EShape::SensorToLocal ( const eVision::EPoint & SPoint)

Transforms a point from sensor coordinates to local coordinates.

Parameters
SPointThe point in sensor coordinates.

◆ SetActive()

void eVision::Legacy::EShape::SetActive ( bool active)
virtual

◆ SetActiveRecursive()

void eVision::Legacy::EShape::SetActiveRecursive ( bool active)
virtual

Sets the flag indicating whether the shape and all its daughters are active or not.

Parameters
activeFlag indicating whether the shapes are active (true, default) or not (false).

When complex gauging is required, several gauges can be grouped together. Applying Process() to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

◆ SetActualShape()

void eVision::Legacy::EShape::SetActualShape ( bool actualShape)

Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

◆ SetActualShapeRecursive()

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

Parameters
actualShapeFlag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true)

◆ SetAutoArrange() [1/2]

void eVision::Legacy::EShape::SetAutoArrange ( bool bAutoArrange)

◆ SetAutoArrange() [2/2]

void eVision::Legacy::EShape::SetAutoArrange ( bool bAutoArrange,
bool bDaughters )

◆ SetCursor()

void eVision::Legacy::EShape::SetCursor ( int32_t x,
int32_t y )

Sets the cursor current coordinates.

Parameters
xCursor current coordinates.
yCursor current coordinates.

◆ SetDragable()

void eVision::Legacy::EShape::SetDragable ( bool dragable)

Flag indicating whether the shape can be dragged or not.

◆ SetDragableRecursive()

void eVision::Legacy::EShape::SetDragableRecursive ( bool dragable)

Sets the flag indicating whether the shape and all its daughters can be dragged or not.

Parameters
dragableFlag indicating whether the shape can be dragged (true) or not (false, default).

◆ SetDraggingMode() [1/2]

void eVision::Legacy::EShape::SetDraggingMode ( eVision::EDraggingMode eDraggingMode)

Sets the dragging mode which defines how the shape could be dragged.

Parameters
eDraggingModeThe draggingMode.

◆ SetDraggingMode() [2/2]

void eVision::Legacy::EShape::SetDraggingMode ( eVision::EDraggingMode eDraggingMode,
bool bDaughters )

Sets the dragging mode which defines how the shape could be dragged.

Parameters
eDraggingModeThe draggingMode.
bDaughtersIndicates if the set must be done in the whole hierarchy or just this object.

◆ SetFound() [1/2]

void eVision::Legacy::EShape::SetFound ( bool bFound)
virtual

◆ SetFound() [2/2]

void eVision::Legacy::EShape::SetFound ( bool bFound,
bool bDaughters )
virtual

◆ SetInspected() [1/2]

void eVision::Legacy::EShape::SetInspected ( bool bFound)

◆ SetInspected() [2/2]

void eVision::Legacy::EShape::SetInspected ( bool bFound,
bool bDaughters )

◆ SetLabeled()

void eVision::Legacy::EShape::SetLabeled ( bool labeled)

Flag indicating whether the shape label should be displayed or not.

◆ SetLabeledRecursive()

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

Parameters
labeledFlag indicating whether the shape label should be displayed (true) or not (false, default).

◆ SetName()

void eVision::Legacy::EShape::SetName ( const std::string & name)

Name of the EShape object.

◆ SetOptionalDraw() [1/2]

void eVision::Legacy::EShape::SetOptionalDraw ( bool bFound)

◆ SetOptionalDraw() [2/2]

void eVision::Legacy::EShape::SetOptionalDraw ( bool bFound,
bool bDaughters )

◆ SetPan() [1/3]

void eVision::Legacy::EShape::SetPan ( )
virtual

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

All objects attached to an EWorldShape object inherit of the same panning factor.

Reimplemented in eVision::Legacy::EWorldShape.

◆ SetPan() [2/3]

void eVision::Legacy::EShape::SetPan ( float panX)
virtual

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Parameters
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

All objects attached to an EWorldShape object inherit of the same panning factor.

Reimplemented in eVision::Legacy::EWorldShape.

◆ SetPan() [3/3]

void eVision::Legacy::EShape::SetPan ( float panX,
float panY )
virtual

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Parameters
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

All objects attached to an EWorldShape object inherit of the same panning factor.

Reimplemented in eVision::Legacy::EWorldShape.

◆ SetPassed() [1/2]

void eVision::Legacy::EShape::SetPassed ( bool bFound)

◆ SetPassed() [2/2]

void eVision::Legacy::EShape::SetPassed ( bool bFound,
bool bDaughters )

◆ SetProperty()

void eVision::Legacy::EShape::SetProperty ( const std::string & aProperty,
const std::string & aValue )

Sets the value of property aProperty to aValue for this EShape.

Parameters
aPropertyThe name of the property.
aValueThe value of the property.

You may use a shape property to define the orientation of the gradient in a shape of a EVectorModel. This is done by setting a property named "polarity" to "inverted" or "direct".

Additionally, you may set any property to any value for your own needs.

◆ SetPropertyRecursive()

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

Parameters
aPropertyThe name of the property.
aValueThe value of the property.

◆ SetQuickDraw() [1/2]

void eVision::Legacy::EShape::SetQuickDraw ( bool bFound)

◆ SetQuickDraw() [2/2]

void eVision::Legacy::EShape::SetQuickDraw ( bool bFound,
bool bDaughters )

◆ SetResizable()

void eVision::Legacy::EShape::SetResizable ( bool resizable)

Flag indicating whether the shape can be resized or not.

◆ SetResizableRecursive()

void eVision::Legacy::EShape::SetResizableRecursive ( bool resizable)

Sets the flag indicating whether the shape and all its daughters can be resized or not.

Parameters
resizableFlag indicating whether the shape can be resized (true) or not (false, default).

◆ SetRotatable()

void eVision::Legacy::EShape::SetRotatable ( bool rotatable)

Flag indicating whether the shape can be rotated or not.

◆ SetRotatableRecursive()

void eVision::Legacy::EShape::SetRotatableRecursive ( bool rotatable)

Sets the flag indicating whether the shape and all its daughters can be rotated or not.

Parameters
rotatableFlag indicating whether the shape can be rotated (true) or not (false, default).

◆ SetSelectable()

void eVision::Legacy::EShape::SetSelectable ( bool selectable)

Flag indicating whether the shape can be selected or not.

◆ SetSelectableRecursive()

void eVision::Legacy::EShape::SetSelectableRecursive ( bool selectable)

Sets the flag indicating whether the shape and all its daughters can be selected or not.

Parameters
selectableFlag indicating whether the shape can be selected (true, default) or not (false).

◆ SetSelected()

void eVision::Legacy::EShape::SetSelected ( bool selected)

Flag indicating whether the shape is selected or not.

◆ SetSelectedRecursive()

void eVision::Legacy::EShape::SetSelectedRecursive ( bool selected)

Sets the flag indicating whether the shape and all its daughters are selected or not.

Parameters
selectedFlag indicating whether the shape is selected (true) or not (false).

◆ SetUserFlag() [1/2]

void eVision::Legacy::EShape::SetUserFlag ( bool bUserFlag)

◆ SetUserFlag() [2/2]

void eVision::Legacy::EShape::SetUserFlag ( bool bUserFlag,
bool bDaughters )

◆ SetVisible()

void eVision::Legacy::EShape::SetVisible ( bool visible)

Flag indicating whether the shape is visible or not.

◆ SetVisibleRecursive()

void eVision::Legacy::EShape::SetVisibleRecursive ( bool visible)

Sets the flag indicating whether the shape and its daughter shapes are visible or not.

Parameters
visibleFlag indicating whether the shape is visible (true, default) or not (false).

◆ SetZoom() [1/3]

void eVision::Legacy::EShape::SetZoom ( )
virtual

Sets the horizontal and vertical zooming factors for drawing operations.

All objects attached to an EWorldShape inherit of the same zooming factor.

Reimplemented in eVision::Legacy::EWorldShape.

◆ SetZoom() [2/3]

void eVision::Legacy::EShape::SetZoom ( float zoomX)
virtual

Sets the horizontal and vertical zooming factors for drawing operations.

Parameters
zoomXHorizontal zooming factor. By default, true scale is used.

All objects attached to an EWorldShape inherit of the same zooming factor.

Reimplemented in eVision::Legacy::EWorldShape.

◆ SetZoom() [3/3]

void eVision::Legacy::EShape::SetZoom ( float zoomX,
float zoomY )
virtual

Sets the horizontal and vertical zooming factors for drawing operations.

Parameters
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0, the default value, the horizontal zooming factor is used instead, so as to provide isotropic zooming.

All objects attached to an EWorldShape inherit of the same zooming factor.

Reimplemented in eVision::Legacy::EWorldShape.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Legacy::EShape::wrappedClass_