eVision Python API
Loading...
Searching...
No Matches
eVision.Legacy.EFrameShape Class Reference

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

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

Public Member Functions

None __init__ (self)
 Construct a eVision.Legacy.EFrameShape object.
None __init__ (self, eVision.Legacy.EFrameShape frameShape)
 Construct a eVision.Legacy.EFrameShape object.
None CopyTo (self, eVision.Legacy.EFrameShape other, bool recursive)
 Copy operator.
None CopyTo (self, eVision.Legacy.EFrameShape other)
 Copy operator.
None SetCenterXY (self, float centerX, float centerY)
 Sets the origin point coordinates of the frame.
None Set (self, eVision.EPoint center, float angle, float scale)
 Sets the coordinates of the origin point and the orientation of the frame.
None Set (self, eVision.EPoint center, float angle)
 Sets the coordinates of the origin point and the orientation of the frame.
None Set (self, eVision.EPoint center)
 Sets the coordinates of the origin point and the orientation of the frame.
None SetSize (self, float sizeX, float sizeY)
 Sets the frame size.
None SetSize (self, float sizeX)
 Sets the frame size.
None Closest (self)
 Find the daughter shape that is the closest to this shape.
bool HitTest (self, bool daughter)
 Checks whether the cursor is positioned over a handle (true) or not (false).
bool HitTest (self)
 Checks whether the cursor is positioned over a handle (true) or not (false).
None Drag (self, int cursorX, int cursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
None Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None graphicContext)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax, int un32NumXIntervals, int un32NumYIntervals)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax, int un32NumXIntervals)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin, float f32XMax, float f32YMin, float f32YMax)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin, float f32XMax, float f32YMin)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin, float f32XMax)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float f32XMin)
None DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext)
eVision.EShapeType Type (self)
 Type of the frame.
eVision.EPoint Center (self)
 Origin point coordinates of the frame.
 Center (self, eVision.EPoint value)
 Origin point coordinates of the frame.
float CenterX (self)
 Gets the origin point abscissa of the frame.
float CenterY (self)
 Gets the origin point ordinate of the frame.
float Angle (self)
 The angle of the frame.
 Angle (self, float value)
 The angle of the frame.
float Scale (self)
 The scale of the frame.
 Scale (self, float value)
 The scale of the frame.
float SizeX (self)
 Frame X-axis length.
float SizeY (self)
 Frame Y-axis length.
Public Member Functions inherited from eVision.Legacy.EShape
eVision.Legacy.EShape|None GetShapeNamed (self, str name)
 Returns a pointer to a daughter gauge or shape specified by its name.
bool GetFound (self)
 Flag indicating whether a measured shape has been found.
bool GetAutoArrange (self)
None SetAutoArrange (self, bool bAutoArrange, bool bDaughters)
None SetAutoArrange (self, bool bAutoArrange)
None SetFound (self, bool bFound, bool bDaughters)
None SetFound (self, bool bFound)
bool GetInspected (self)
None SetInspected (self, bool bFound, bool bDaughters)
None SetInspected (self, bool bFound)
bool GetPassed (self)
None SetPassed (self, bool bFound, bool bDaughters)
None SetPassed (self, bool bFound)
bool GetQuickDraw (self)
None SetQuickDraw (self, bool bFound, bool bDaughters)
None SetQuickDraw (self, bool bFound)
bool GetOptionalDraw (self)
None SetOptionalDraw (self, bool bFound, bool bDaughters)
None SetOptionalDraw (self, bool bFound)
bool GetUserFlag (self)
None SetUserFlag (self, bool bUserFlag, bool bDaughters)
None SetUserFlag (self, bool bUserFlag)
bool GetAllocated (self)
 Gets the allocated flag.
None EnableBehaviorFilter (self, 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.
None EnableBehaviorFilter (self, 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.
None DisableBehaviorFilter (self, eVision.EShapeBehavior behavior)
 Disables (i.e.
None Attach (self, eVision.Legacy.EShape|None mother)
 Attaches the gauge to a mother gauge or shape.
None Detach (self)
 Detaches the gauge from its mother gauge or shape.
None DetachDaughters (self)
 Detaches the daughter gauges or shapes.
eVision.Legacy.EShape|None GetDaughter (self, int index)
 Returns a pointer to the specified daughter gauge or shape.
bool IsWorld (self)
None InvalidateWorld (self)
 Invalidates the world shape for this shape and all its ancestors.
eVision.EPoint LocalToSensor (self, eVision.EPoint LPoint)
 Transforms a point from local coordinates to sensor coordinates.
eVision.EPoint SensorToLocal (self, eVision.EPoint SPoint)
 Transforms a point from sensor coordinates to local coordinates.
None SetZoom (self, float zoomX, float zoomY)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self, float zoomX)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetPan (self, float panX, float panY)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self, float panX)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode, bool bDaughters)
 Sets the dragging mode which defines how the shape could be dragged.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode)
 Sets the dragging mode which defines how the shape could be dragged.
eVision.EDraggingMode GetDraggingMode (self)
 Gets the dragging mode which defines how the shape could be dragged.
None SetCursor (self, int x, int y)
 Sets the cursor current coordinates.
None Process (self, eVision.EROIBW8|None pSrc, bool bDaughters)
None Process (self, eVision.EROIBW8|None pSrc)
None Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region, bool bDaughters)
None Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region)
None Save (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Load (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
bool HasProperty (self, str aProperty)
 Returns whether a eVision.Legacy.EShape has a property named aProperty.
str GetProperty (self, str aProperty)
 Gets the value of property aProperty.
None SetProperty (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape.
None SetPropertyRecursive (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape and all of its daughters.
None RemoveProperty (self, str aProperty)
 Removes the property name aProperty from the eVision.Legacy.EShape.
bool HasValidPolarityProperty (self)
 Returns whether the eVision.Legacy.EShape has a valid polarity property.
None EnableTypeFilter (self, int un32Types)
 Enables the filter of the specified shape type.
None DisableTypeFilter (self)
 Enables all shape types.
str Name (self)
 Name of the eVision.Legacy.EShape object.
 Name (self, str value)
 Name of the eVision.Legacy.EShape object.
bool Visible (self)
 Flag indicating whether the shape is visible or not.
 Visible (self, bool value)
 Flag indicating whether the shape is visible or not.
bool Selected (self)
 Flag indicating whether the shape is selected or not.
 Selected (self, bool value)
 Flag indicating whether the shape is selected or not.
bool Selectable (self)
 Flag indicating whether the shape can be selected or not.
 Selectable (self, bool value)
 Flag indicating whether the shape can be selected or not.
bool Dragable (self)
 Flag indicating whether the shape can be dragged or not.
 Dragable (self, bool value)
 Flag indicating whether the shape can be dragged or not.
bool Resizable (self)
 Flag indicating whether the shape can be resized or not.
 Resizable (self, bool value)
 Flag indicating whether the shape can be resized or not.
bool Rotatable (self)
 Flag indicating whether the shape can be rotated or not.
 Rotatable (self, bool value)
 Flag indicating whether the shape can be rotated or not.
bool Labeled (self)
 Flag indicating whether the shape label should be displayed or not.
 Labeled (self, bool value)
 Flag indicating whether the shape label should be displayed or not.
bool Active (self)
 Flag indicating whether the shape is active or not.
 Active (self, bool value)
 Flag indicating whether the shape is active or not.
bool ActualShape (self)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
 ActualShape (self, bool value)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
int NumDaughters (self)
 Number of daughters attached to the shape.
eVision.Legacy.EShape|None Mother (self)
 Pointer to the mother shape.
eVision.Legacy.EWorldShape|None WorldShape (self)
 World ancestor.
float ZoomX (self)
 Current horizontal zooming factor for drawing operations.
float ZoomY (self)
 Current vertical zooming factor for drawing operations.
float PanX (self)
 Current horizontal panning value for drawing operations, expressed in pixels.
float PanY (self)
 Current vertical panning value for drawing operations, expressed in pixels.
eVision.EDragHandle HitHandle (self)
 Handle currently under the cursor.
eVision.Legacy.EShape|None HitShape (self)
 Pointer to the shape currently under the cursor.
eVision.Legacy.EShape|None ClosestShape (self)
 Closest shape among the daughters.

Additional Inherited Members

Protected Member Functions inherited from eVision.Legacy.EShape
 _VisibleRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
 _SelectedRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are selected or not.
 _SelectableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
 _DragableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
 _ResizableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
 _RotatableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
 _LabeledRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape label should be displayed or not.
 _ActiveRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are active or not.
 _ActualShapeRecursive__setter (self, bool value)
 Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
Properties inherited from eVision.Legacy.EShape
 VisibleRecursive
 SelectedRecursive
 SelectableRecursive
 DragableRecursive
 ResizableRecursive
 RotatableRecursive
 LabeledRecursive
 ActiveRecursive
 ActualShapeRecursive

Detailed Description

Manages a complete context for measuring frame shapes.

Remarks:

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

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.Legacy.EFrameShape.__init__ ( self)

Construct a eVision.Legacy.EFrameShape object.

Remarks:

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

◆ __init__() [2/2]

None eVision.Legacy.EFrameShape.__init__ ( self,
eVision.Legacy.EFrameShape frameShape )

Construct a eVision.Legacy.EFrameShape object.

Remarks:

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

Parameters
frameShapePre-existing eVision.Legacy.EFrameShape object used by the copy constructor.

Member Function Documentation

◆ Angle() [1/2]

float eVision.Legacy.EFrameShape.Angle ( self)

The angle of the frame.

◆ Angle() [2/2]

eVision.Legacy.EFrameShape.Angle ( self,
float value )

The angle of the frame.

◆ Center() [1/2]

eVision.EPoint eVision.Legacy.EFrameShape.Center ( self)

Origin point coordinates of the frame.

◆ Center() [2/2]

eVision.Legacy.EFrameShape.Center ( self,
eVision.EPoint value )

Origin point coordinates of the frame.

◆ CenterX()

float eVision.Legacy.EFrameShape.CenterX ( self)

Gets the origin point abscissa of the frame.

◆ CenterY()

float eVision.Legacy.EFrameShape.CenterY ( self)

Gets the origin point ordinate of the frame.

◆ Closest()

None eVision.Legacy.EFrameShape.Closest ( self)

Find the daughter shape that is the closest to this shape.

To retrieve the closest shape, use eVision.Legacy.EShape.ClosestShape.

Reimplemented from eVision.Legacy.EShape.

◆ CopyTo() [1/2]

None eVision.Legacy.EFrameShape.CopyTo ( self,
eVision.Legacy.EFrameShape other )

Copy operator.

Remarks:

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

Parameters
othereVision.Legacy.EFrameShape object to copy to.

◆ CopyTo() [2/2]

None eVision.Legacy.EFrameShape.CopyTo ( self,
eVision.Legacy.EFrameShape other,
bool recursive )

Copy operator.

Remarks:

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

Parameters
othereVision.Legacy.EFrameShape object to copy to.
recursivetrue if the daughter shapes have to be copied as well, false otherwise.

◆ Drag()

None eVision.Legacy.EFrameShape.Drag ( self,
int cursorX,
int cursorY )

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

Parameters
cursorXCurrent cursor coordinates.
cursorYCurrent cursor coordinates.

Reimplemented from eVision.Legacy.EShape.

◆ Draw() [1/3]

None eVision.Legacy.EFrameShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext )

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

Parameters
graphicContextHandle of the device context on which to draw.

Reimplemented from eVision.Legacy.EShape.

◆ Draw() [2/3]

None eVision.Legacy.EFrameShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EDrawingMode drawingMode )

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the shape must be displayed, as defined by eVision.EDrawingMode.

Reimplemented from eVision.Legacy.EShape.

◆ Draw() [3/3]

None eVision.Legacy.EFrameShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )

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

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the shape must be displayed, as defined by eVision.EDrawingMode.
daughterstrue if the daughter shapes are to be displayed also.

Reimplemented from eVision.Legacy.EShape.

◆ DrawCrossGrid() [1/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext )

◆ DrawCrossGrid() [2/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin )

◆ DrawCrossGrid() [3/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin,
float f32XMax )

◆ DrawCrossGrid() [4/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin,
float f32XMax,
float f32YMin )

◆ DrawCrossGrid() [5/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin,
float f32XMax,
float f32YMin,
float f32YMax )

◆ DrawCrossGrid() [6/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin,
float f32XMax,
float f32YMin,
float f32YMax,
int un32NumXIntervals )

◆ DrawCrossGrid() [7/7]

None eVision.Legacy.EFrameShape.DrawCrossGrid ( self,
eVision.EDrawAdapter | None graphicContext,
float f32XMin,
float f32XMax,
float f32YMin,
float f32YMax,
int un32NumXIntervals,
int un32NumYIntervals )

◆ HitTest() [1/2]

bool eVision.Legacy.EFrameShape.HitTest ( self)

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

Reimplemented from eVision.Legacy.EShape.

◆ HitTest() [2/2]

bool eVision.Legacy.EFrameShape.HitTest ( self,
bool daughter )

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

Parameters
daughtertrue if the daughters shapes handles have to be considered as well.

Reimplemented from eVision.Legacy.EShape.

◆ Scale() [1/2]

float eVision.Legacy.EFrameShape.Scale ( self)

The scale of the frame.

◆ Scale() [2/2]

eVision.Legacy.EFrameShape.Scale ( self,
float value )

The scale of the frame.

◆ Set() [1/3]

None eVision.Legacy.EFrameShape.Set ( self,
eVision.EPoint center )

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

Parameters
centerCoordinates of the origin point of the frame. The default value is (0,0).

◆ Set() [2/3]

None eVision.Legacy.EFrameShape.Set ( self,
eVision.EPoint center,
float angle )

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

Parameters
centerCoordinates of the origin point of the frame. The default value is (0,0).
angleRotation angle of the frame. The default value is 0.

◆ Set() [3/3]

None eVision.Legacy.EFrameShape.Set ( self,
eVision.EPoint center,
float angle,
float scale )

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

Parameters
centerCoordinates of the origin point of the frame. The default value is (0,0).
angleRotation angle of the frame. The default value is 0.
scaleHorizontal sensor resolution, in pixels per unit

◆ SetCenterXY()

None eVision.Legacy.EFrameShape.SetCenterXY ( self,
float centerX,
float centerY )

Sets the origin point coordinates of the frame.

Parameters
centerXAbscissa of the origin point of the frame. Default value is 0.
centerYOrdinate of the origin point of the frame. Default value is 0.

◆ SetSize() [1/2]

None eVision.Legacy.EFrameShape.SetSize ( self,
float sizeX )

Sets the frame size.

Remarks:

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

Parameters
sizeXFrame X-axis length. The default value is 100.

◆ SetSize() [2/2]

None eVision.Legacy.EFrameShape.SetSize ( self,
float sizeX,
float sizeY )

Sets the frame size.

Remarks:

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

Parameters
sizeXFrame X-axis length. The default value is 100.
sizeYFrame Y-axis length. By default, both axes have the same length.

◆ SizeX()

float eVision.Legacy.EFrameShape.SizeX ( self)

Frame X-axis length.

Remarks:

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

◆ SizeY()

float eVision.Legacy.EFrameShape.SizeY ( self)

Frame Y-axis length.

Remarks:

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

◆ Type()

eVision.EShapeType eVision.Legacy.EFrameShape.Type ( self)

Type of the frame.

Reimplemented from eVision.Legacy.EShape.