eVision .NET API
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...

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

Public Member Functions

eVision.Legacy.EShape GetShapeNamed (string name)
 Returns a pointer to a daughter gauge or shape specified by its name.
bool GetFound ()
 Flag indicating whether a measured shape has been found.
bool GetAutoArrange ()
void SetAutoArrange (bool bAutoArrange, bool bDaughters)
void SetAutoArrange (bool bAutoArrange)
virtual void SetFound (bool bFound, bool bDaughters)
virtual void SetFound (bool bFound)
bool GetInspected ()
void SetInspected (bool bFound, bool bDaughters)
void SetInspected (bool bFound)
bool GetPassed ()
void SetPassed (bool bFound, bool bDaughters)
void SetPassed (bool bFound)
bool GetQuickDraw ()
void SetQuickDraw (bool bFound, bool bDaughters)
void SetQuickDraw (bool bFound)
bool GetOptionalDraw ()
void SetOptionalDraw (bool bFound, bool bDaughters)
void SetOptionalDraw (bool bFound)
bool GetUserFlag ()
void SetUserFlag (bool bUserFlag, bool bDaughters)
void SetUserFlag (bool bUserFlag)
bool GetAllocated ()
 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.
virtual eVision.Legacy.EShape GetDaughter (uint index)
 Returns a pointer to the specified daughter gauge or shape.
bool IsWorld ()
void InvalidateWorld ()
 Invalidates the world shape for this shape and all its ancestors.
eVision.EPoint LocalToSensor (eVision.EPoint LPoint)
 Transforms a point from local coordinates to sensor coordinates.
eVision.EPoint SensorToLocal (eVision.EPoint SPoint)
 Transforms a point from sensor coordinates to local coordinates.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (IntPtr graphicContext, eVision.ERGBColor color)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void DrawWithCurrentPen (IntPtr graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void DrawWithCurrentPen (IntPtr graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void DrawWithCurrentPen (IntPtr graphicContext)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
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.
bool HitTest (bool bDaughters)
 Checks if there is a handle under the cursor.
bool HitTest ()
 Checks if there is a handle 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 ()
 Gets the dragging mode which defines how the shape could be dragged.
void SetCursor (int x, int y)
 Sets the cursor current coordinates.
void Drag (int n32CursorX, int n32CursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
void Closest ()
 Find the daughter shape that is the closest to this shape. To retrieve the closest shape, use EShape.ClosestShape.
virtual void Process (eVision.EROIBW8 pSrc, bool bDaughters)
virtual void Process (eVision.EROIBW8 pSrc)
virtual void Process (eVision.EROIBW8 pSrc, eVision.ERegion region, bool bDaughters)
virtual void Process (eVision.EROIBW8 pSrc, eVision.ERegion region)
void Save (string path, bool daughters)
 Loads a Shape.The given ESerializer must have been created for writing.
void Save (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 (string path, bool daughters)
 Loads a Shape.The given ESerializer must have been created for reading.
void Load (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 (string aProperty)
 Returns whether a EShape has a property named aProperty.
string GetProperty (string aProperty)
 Gets the value of property aProperty. Throws an exception if no such property exists.
void SetProperty (string aProperty, string aValue)
 Sets the value of property aProperty to aValue for this EShape.
void SetPropertyRecursive (string aProperty, string aValue)
 Sets the value of property aProperty to aValue for this EShape and all of its daughters.
void RemoveProperty (string aProperty)
 Removes the property name aProperty from the EShape.
bool HasValidPolarityProperty ()
 Returns whether the EShape has a valid polarity property.
virtual void EnableTypeFilter (uint un32Types)
 Enables the filter of the specified shape type.
virtual void DisableTypeFilter ()
 Enables all shape types.
void Draw (System.Drawing.Graphics graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (System.Drawing.Graphics graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (System.Drawing.Graphics graphicContext)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color)
 Draws a graphical representation of a shape, as defined by EDrawingMode.

Properties

eVision.EShapeType Type [get]
 Shape type.
string Name [get, set]
 Name of the EShape object.
bool Visible [get, set]
 Flag indicating whether the shape is visible or not.
bool VisibleRecursive [set]
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
bool Selected [get, set]
 Flag indicating whether the shape is selected or not.
bool SelectedRecursive [set]
 Sets the flag indicating whether the shape and all its daughters are selected or not.
bool Selectable [get, set]
 Flag indicating whether the shape can be selected or not.
bool SelectableRecursive [set]
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
bool Dragable [get, set]
 Flag indicating whether the shape can be dragged or not.
bool DragableRecursive [set]
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
bool Resizable [get, set]
 Flag indicating whether the shape can be resized or not.
bool ResizableRecursive [set]
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
bool Rotatable [get, set]
 Flag indicating whether the shape can be rotated or not.
bool RotatableRecursive [set]
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
bool Labeled [get, set]
 Flag indicating whether the shape label should be displayed or not.
bool LabeledRecursive [set]
 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 Active [get, set]
 Flag indicating whether the shape is active or not.
virtual bool ActiveRecursive [set]
 Sets the flag indicating whether the shape and all its daughters are active or not.
bool ActualShape [get, set]
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
bool ActualShapeRecursive [set]
 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.
uint NumDaughters [get]
 Number of daughters attached to the shape.
eVision.Legacy.EShape Mother [get]
 Pointer to the mother shape.
eVision.Legacy.EWorldShape WorldShape [get]
 World ancestor.
virtual float ZoomX [get]
 Current horizontal zooming factor for drawing operations.
virtual float ZoomY [get]
 Current vertical zooming factor for drawing operations.
virtual float PanX [get]
 Current horizontal panning value for drawing operations, expressed in pixels. By default, no panning occurs.
virtual float PanY [get]
 Current vertical panning value for drawing operations, expressed in pixels. By default, no panning occurs.
eVision.EDragHandle HitHandle [get]
 Handle currently under the cursor.
eVision.Legacy.EShape HitShape [get]
 Pointer to the shape currently under the cursor.
eVision.Legacy.EShape ClosestShape [get]
 Closest shape among the daughters.

Detailed Description

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

License(s): BasicTypes

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()

void eVision.Legacy.EShape.Closest ( )
abstract

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

◆ 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()

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

Enables all shape types.

Reimplemented in eVision.Legacy.EWorldShape.

◆ Drag()

void eVision.Legacy.EShape.Drag ( int n32CursorX,
int n32CursorY )
abstract

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

Parameters
n32CursorXCurrent cursor coordinates.
n32CursorYCurrent cursor coordinates.

◆ Draw() [1/15]

void eVision.Legacy.EShape.Draw ( eVision.EDrawAdapter graphicContext)
abstract

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

Parameters
graphicContextHandle of the device context on which to draw.

◆ Draw() [2/15]

void eVision.Legacy.EShape.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ Draw() [3/15]

void eVision.Legacy.EShape.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ Draw() [4/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext)
abstract

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.

◆ Draw() [5/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ Draw() [6/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ Draw() [7/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext,
eVision.ERGBColor color )
abstract

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.

◆ Draw() [8/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext,
eVision.ERGBColor color,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ Draw() [9/15]

void eVision.Legacy.EShape.Draw ( IntPtr graphicContext,
eVision.ERGBColor color,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ Draw() [10/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext)
abstract

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.

◆ Draw() [11/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ Draw() [12/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ Draw() [13/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color )
abstract

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.

◆ Draw() [14/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ Draw() [15/15]

void eVision.Legacy.EShape.Draw ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ DrawWithCurrentPen() [1/3]

void eVision.Legacy.EShape.DrawWithCurrentPen ( IntPtr graphicContext)
abstract

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

◆ DrawWithCurrentPen() [2/3]

void eVision.Legacy.EShape.DrawWithCurrentPen ( IntPtr graphicContext,
eVision.EDrawingMode drawingMode )
abstract

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.

◆ DrawWithCurrentPen() [3/3]

void eVision.Legacy.EShape.DrawWithCurrentPen ( IntPtr graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )
abstract

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.

◆ 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()

virtual void eVision.Legacy.EShape.EnableTypeFilter ( uint un32Types)
virtual

Enables the filter of the specified shape type.

Parameters
un32TypesThe type of the shape to filter.

Reimplemented in eVision.Legacy.EWorldShape.

◆ GetAllocated()

bool eVision.Legacy.EShape.GetAllocated ( )

Gets the allocated flag.

◆ GetAutoArrange()

bool eVision.Legacy.EShape.GetAutoArrange ( )

◆ GetDaughter()

virtual eVision.Legacy.EShape eVision.Legacy.EShape.GetDaughter ( uint index)
virtual

Returns a pointer to the specified daughter gauge or shape.

Parameters
indexDaughter gauge or shape index.

◆ GetDraggingMode()

eVision.EDraggingMode eVision.Legacy.EShape.GetDraggingMode ( )

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

◆ GetFound()

bool eVision.Legacy.EShape.GetFound ( )

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.

◆ GetInspected()

bool eVision.Legacy.EShape.GetInspected ( )

◆ GetOptionalDraw()

bool eVision.Legacy.EShape.GetOptionalDraw ( )

◆ GetPassed()

bool eVision.Legacy.EShape.GetPassed ( )

◆ GetProperty()

string eVision.Legacy.EShape.GetProperty ( string aProperty)

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 ( )

◆ GetShapeNamed()

eVision.Legacy.EShape eVision.Legacy.EShape.GetShapeNamed ( string name)

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

Parameters
nameName of the daughter gauge or shape.

◆ GetUserFlag()

bool eVision.Legacy.EShape.GetUserFlag ( )

◆ HasProperty()

bool eVision.Legacy.EShape.HasProperty ( string aProperty)

Returns whether a EShape has a property named aProperty.

Parameters
aPropertyThe name of the property.

◆ HasValidPolarityProperty()

bool eVision.Legacy.EShape.HasValidPolarityProperty ( )

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]

bool eVision.Legacy.EShape.HitTest ( )
abstract

Checks if there is a handle under the cursor.

◆ HitTest() [2/2]

bool eVision.Legacy.EShape.HitTest ( bool bDaughters)
abstract

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.

◆ InvalidateWorld()

void eVision.Legacy.EShape.InvalidateWorld ( )

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

◆ IsWorld()

bool eVision.Legacy.EShape.IsWorld ( )

◆ Load() [1/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() [2/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.

◆ Load() [3/4]

void eVision.Legacy.EShape.Load ( string path)

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

Parameters
pathThe file path.

◆ Load() [4/4]

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

◆ LocalToSensor()

eVision.EPoint eVision.Legacy.EShape.LocalToSensor ( 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 ( string aProperty)

Removes the property name aProperty from the EShape.

Parameters
aPropertyThe name of the property.

◆ Save() [1/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() [2/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.

◆ Save() [3/4]

void eVision.Legacy.EShape.Save ( string path)

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

Parameters
pathThe file path.

◆ Save() [4/4]

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

◆ SensorToLocal()

eVision.EPoint eVision.Legacy.EShape.SensorToLocal ( eVision.EPoint SPoint)

Transforms a point from sensor coordinates to local coordinates.

Parameters
SPointThe point in sensor coordinates.

◆ 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 ( int x,
int y )

Sets the cursor current coordinates.

Parameters
xCursor current coordinates.
yCursor current coordinates.

◆ 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]

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

◆ SetFound() [2/2]

virtual 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 )

◆ 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]

virtual 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]

virtual 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]

virtual 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 ( string aProperty,
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 ( string aProperty,
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 )

◆ SetUserFlag() [1/2]

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

◆ SetUserFlag() [2/2]

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

◆ SetZoom() [1/3]

virtual 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]

virtual 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]

virtual 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.

Property Documentation

◆ Active

virtual bool eVision.Legacy.EShape.Active
getset

Flag indicating whether the shape is active or not.

◆ ActiveRecursive

virtual bool eVision.Legacy.EShape.ActiveRecursive
set

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

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.

◆ ActualShape

bool eVision.Legacy.EShape.ActualShape
getset

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

◆ ActualShapeRecursive

bool eVision.Legacy.EShape.ActualShapeRecursive
set

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.

◆ ClosestShape

eVision.Legacy.EShape eVision.Legacy.EShape.ClosestShape
get

Closest shape among the daughters.

Use EShape.Closest to recompute the closest shape.

◆ Dragable

bool eVision.Legacy.EShape.Dragable
getset

Flag indicating whether the shape can be dragged or not.

◆ DragableRecursive

bool eVision.Legacy.EShape.DragableRecursive
set

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

◆ HitHandle

eVision.EDragHandle eVision.Legacy.EShape.HitHandle
get

Handle currently under the cursor.

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

◆ HitShape

eVision.Legacy.EShape eVision.Legacy.EShape.HitShape
get

Pointer to the shape currently under the cursor.

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

◆ Labeled

bool eVision.Legacy.EShape.Labeled
getset

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

◆ LabeledRecursive

bool eVision.Legacy.EShape.LabeledRecursive
set

Sets the flag indicating whether the shape label should be displayed or not. The flag is set in this shape and all its daughters.

◆ Mother

eVision.Legacy.EShape eVision.Legacy.EShape.Mother
get

Pointer to the mother shape.

◆ Name

string eVision.Legacy.EShape.Name
getset

Name of the EShape object.

◆ NumDaughters

uint eVision.Legacy.EShape.NumDaughters
get

Number of daughters attached to the shape.

◆ PanX

virtual float eVision.Legacy.EShape.PanX
get

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

◆ PanY

virtual float eVision.Legacy.EShape.PanY
get

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

◆ Resizable

bool eVision.Legacy.EShape.Resizable
getset

Flag indicating whether the shape can be resized or not.

◆ ResizableRecursive

bool eVision.Legacy.EShape.ResizableRecursive
set

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

◆ Rotatable

bool eVision.Legacy.EShape.Rotatable
getset

Flag indicating whether the shape can be rotated or not.

◆ RotatableRecursive

bool eVision.Legacy.EShape.RotatableRecursive
set

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

◆ Selectable

bool eVision.Legacy.EShape.Selectable
getset

Flag indicating whether the shape can be selected or not.

◆ SelectableRecursive

bool eVision.Legacy.EShape.SelectableRecursive
set

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

◆ Selected

bool eVision.Legacy.EShape.Selected
getset

Flag indicating whether the shape is selected or not.

◆ SelectedRecursive

bool eVision.Legacy.EShape.SelectedRecursive
set

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

◆ Type

eVision.EShapeType eVision.Legacy.EShape.Type
getabstract

Shape type.

◆ Visible

bool eVision.Legacy.EShape.Visible
getset

Flag indicating whether the shape is visible or not.

◆ VisibleRecursive

bool eVision.Legacy.EShape.VisibleRecursive
set

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

◆ WorldShape

eVision.Legacy.EWorldShape eVision.Legacy.EShape.WorldShape
get

World ancestor.

◆ ZoomX

virtual float eVision.Legacy.EShape.ZoomX
get

Current horizontal zooming factor for drawing operations.

◆ ZoomY

virtual float eVision.Legacy.EShape.ZoomY
get

Current vertical zooming factor for drawing operations.