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

Properties
	Type = property(_Type__getter, None)
	Type of the frame.
	Center = property(_Center__getter, _Center__setter)
	Origin point coordinates of the frame.
	CenterX = property(_CenterX__getter, None)
	Gets the origin point abscissa of the frame.
	CenterY = property(_CenterY__getter, None)
	Gets the origin point ordinate of the frame.
	Angle = property(_Angle__getter, _Angle__setter)
	The angle of the frame.
	Scale = property(_Scale__getter, _Scale__setter)
	The scale of the frame.
	SizeX = property(_SizeX__getter, None)
	Frame X-axis length.
	SizeY = property(_SizeY__getter, None)
	Frame Y-axis length.
Properties inherited from eVision.Legacy.EShape
	Type = property(_Type__getter, None)
	Shape type.
	Name = property(_Name__getter, _Name__setter)
	Name of the eVision.Legacy.EShape object.
	Visible = property(_Visible__getter, _Visible__setter)
	Flag indicating whether the shape is visible or not.
	VisibleRecursive = property(None, _VisibleRecursive__setter)
	Sets the flag indicating whether the shape and its daughter shapes are visible or not.
	Selected = property(_Selected__getter, _Selected__setter)
	Flag indicating whether the shape is selected or not.
	SelectedRecursive = property(None, _SelectedRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters are selected or not.
	Selectable = property(_Selectable__getter, _Selectable__setter)
	Flag indicating whether the shape can be selected or not.
	SelectableRecursive = property(None, _SelectableRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters can be selected or not.
	Dragable = property(_Dragable__getter, _Dragable__setter)
	Flag indicating whether the shape can be dragged or not.
	DragableRecursive = property(None, _DragableRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters can be dragged or not.
	Resizable = property(_Resizable__getter, _Resizable__setter)
	Flag indicating whether the shape can be resized or not.
	ResizableRecursive = property(None, _ResizableRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters can be resized or not.
	Rotatable = property(_Rotatable__getter, _Rotatable__setter)
	Flag indicating whether the shape can be rotated or not.
	RotatableRecursive = property(None, _RotatableRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters can be rotated or not.
	Labeled = property(_Labeled__getter, _Labeled__setter)
	Flag indicating whether the shape label should be displayed or not.
	LabeledRecursive = property(None, _LabeledRecursive__setter)
	Sets the flag indicating whether the shape label should be displayed or not.
	Active = property(_Active__getter, _Active__setter)
	Flag indicating whether the shape is active or not.
	ActiveRecursive = property(None, _ActiveRecursive__setter)
	Sets the flag indicating whether the shape and all its daughters are active or not.
	ActualShape = property(_ActualShape__getter, _ActualShape__setter)
	Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
	ActualShapeRecursive = property(None, _ActualShapeRecursive__setter)
	Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
	NumDaughters = property(_NumDaughters__getter, None)
	Number of daughters attached to the shape.
	Mother = property(_Mother__getter, None)
	Pointer to the mother shape.
	WorldShape = property(_WorldShape__getter, None)
	World ancestor.
	ZoomX = property(_ZoomX__getter, None)
	Current horizontal zooming factor for drawing operations.
	ZoomY = property(_ZoomY__getter, None)
	Current vertical zooming factor for drawing operations.
	PanX = property(_PanX__getter, None)
	Current horizontal panning value for drawing operations, expressed in pixels.
	PanY = property(_PanY__getter, None)
	Current vertical panning value for drawing operations, expressed in pixels.
	HitHandle = property(_HitHandle__getter, None)
	Handle currently under the cursor.
	HitShape = property(_HitShape__getter, None)
	Pointer to the shape currently under the cursor.
	ClosestShape = property(_ClosestShape__getter, None)
	Closest shape among the daughters.

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

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

Member Function Documentation

◆ 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

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

other	eVision.Legacy.EFrameShape object to copy to.
recursive	true 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

cursorX	Current cursor coordinates.
cursorY	Current 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

graphicContext Handle 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

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates 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

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the shape must be displayed, as defined by eVision.EDrawingMode.
daughters	true 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

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

Reimplemented from eVision.Legacy.EShape.

◆ 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

center Coordinates 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

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

◆ Set() [3/3]

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

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

◆ SetCenterXY()

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

Sets the origin point coordinates of the frame.

Parameters

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

◆ 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

sizeX Frame 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

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

Property Documentation

◆ Angle

eVision.Legacy.EFrameShape.Angle = property(_Angle__getter, _Angle__setter)

static

The angle of the frame.

◆ Center

eVision.Legacy.EFrameShape.Center = property(_Center__getter, _Center__setter)

static

Origin point coordinates of the frame.

◆ CenterX

eVision.Legacy.EFrameShape.CenterX = property(_CenterX__getter, None)

static

Gets the origin point abscissa of the frame.

◆ CenterY

eVision.Legacy.EFrameShape.CenterY = property(_CenterY__getter, None)

static

Gets the origin point ordinate of the frame.

◆ Scale

eVision.Legacy.EFrameShape.Scale = property(_Scale__getter, _Scale__setter)

static

The scale of the frame.

◆ SizeX

eVision.Legacy.EFrameShape.SizeX = property(_SizeX__getter, None)

static

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

eVision.Legacy.EFrameShape.SizeY = property(_SizeY__getter, None)

static

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.Legacy.EFrameShape.Type = property(_Type__getter, None)

static

Type of the frame.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ Closest()

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Drag()

◆ Draw() [1/3]

◆ Draw() [2/3]

◆ Draw() [3/3]

◆ DrawCrossGrid() [1/7]

◆ DrawCrossGrid() [2/7]

◆ DrawCrossGrid() [3/7]

◆ DrawCrossGrid() [4/7]

◆ DrawCrossGrid() [5/7]

◆ DrawCrossGrid() [6/7]

◆ DrawCrossGrid() [7/7]

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetCenterXY()

◆ SetSize() [1/2]

◆ SetSize() [2/2]

Property Documentation

◆ Angle

◆ Center

◆ CenterX

◆ CenterY

◆ Scale

◆ SizeX

◆ SizeY

◆ Type

◆ init() [1/2]

◆ init() [2/2]