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

Manages a line shape. More...

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

Public Member Functions

None __init__ (self)
 Constructs a eVision.Legacy.ELineShape object.
None __init__ (self, eVision.EPoint origin, eVision.EPoint end)
 Constructs a eVision.Legacy.ELineShape object.
None __init__ (self, eVision.EPoint center, float length, float angle)
 Constructs a eVision.Legacy.ELineShape object.
None __init__ (self, eVision.EPoint center, float length)
 Constructs a eVision.Legacy.ELineShape object.
None __init__ (self, eVision.EPoint center)
 Constructs a eVision.Legacy.ELineShape object.
None __init__ (self, eVision.Legacy.ELineShape other)
 Constructs a eVision.Legacy.ELineShape object.
None SetCenterXY (self, float centerX, float centerY)
 Sets the center coordinates of a eVision.Legacy.ELineShape object.
None SetFromTwoPoints (self, eVision.EPoint origin, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.
None SetFromOriginAndEnd (self, eVision.EPoint origin, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.
eVision.EPoint GetPoint (self, float fraction)
 Returns the coordinates of a point along the line.
None CopyTo (self, eVision.Legacy.ELineShape other, bool bRecursive)
 Copies all the data of the current eVision.Legacy.ELineShape object into another eVision.Legacy.ELineShape object and returns it.
None CopyTo (self, eVision.Legacy.ELineShape other)
 Copies all the data of the current eVision.Legacy.ELineShape object into another eVision.Legacy.ELineShape object and returns it.
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 Closest (self)
 Find the daughter shape that is the closest to this shape.
bool HitTest (self, bool bDaughters)
 Checks if there is a handle under the cursor.
bool HitTest (self)
 Checks if there is a handle under the cursor.
None Drag (self, int n32CursorX, int n32CursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
eVision.EPoint Center (self)
 Center point of the frame.
 Center (self, eVision.EPoint value)
 Center point of the frame.
float CenterX (self)
 Abscissa of the origin point of the frame.
float CenterY (self)
 Ordinate of the origin point of the frame.
float Angle (self)
 Orientation of the shape.
 Angle (self, float value)
 Orientation of the shape.
float Scale (self)
 Horizontal sensor resolution, in pixels per unit.
 Scale (self, float value)
 Horizontal sensor resolution, in pixels per unit.
float Length (self)
 Length of the eVision.Legacy.ELineShape object.
 Length (self, float value)
 Length of the eVision.Legacy.ELineShape object.
eVision.EPoint Org (self)
 Origin point coordinates of the eVision.Legacy.ELineShape object.
eVision.EPoint End (self)
 End point coordinates of the eVision.Legacy.ELineShape object.
eVision.EShapeType Type (self)
 Shape type.
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.

Protected Member Functions

 _Line__setter (self, eVision.Legacy.ELine value)
 Sets the nominal position, length and rotation angle of the line, according to a known eVision.Legacy.ELine object.
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

 Line
Properties inherited from eVision.Legacy.EShape
 VisibleRecursive
 SelectedRecursive
 SelectableRecursive
 DragableRecursive
 ResizableRecursive
 RotatableRecursive
 LabeledRecursive
 ActiveRecursive
 ActualShapeRecursive

Detailed Description

Manages a line shape.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/6]

None eVision.Legacy.ELineShape.__init__ ( self)

Constructs a eVision.Legacy.ELineShape object.

◆ __init__() [2/6]

None eVision.Legacy.ELineShape.__init__ ( self,
eVision.EPoint origin,
eVision.EPoint end )

Constructs a eVision.Legacy.ELineShape object.

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

◆ __init__() [3/6]

None eVision.Legacy.ELineShape.__init__ ( self,
eVision.EPoint center,
float length,
float angle )

Constructs a eVision.Legacy.ELineShape object.

Parameters
centerCenter coordinates of the line at its nominal position. The default value is (0,0).
lengthNominal length of the line. The default value is 100.
angleNominal rotation angle of the line. The default value is 0.

◆ __init__() [4/6]

None eVision.Legacy.ELineShape.__init__ ( self,
eVision.EPoint center,
float length )

Constructs a eVision.Legacy.ELineShape object.

Parameters
centerCenter coordinates of the line at its nominal position. The default value is (0,0).
lengthNominal length of the line. The default value is 100.

◆ __init__() [5/6]

None eVision.Legacy.ELineShape.__init__ ( self,
eVision.EPoint center )

Constructs a eVision.Legacy.ELineShape object.

Parameters
centerCenter coordinates of the line at its nominal position. The default value is (0,0).

◆ __init__() [6/6]

None eVision.Legacy.ELineShape.__init__ ( self,
eVision.Legacy.ELineShape other )

Constructs a eVision.Legacy.ELineShape object.

Parameters
otherAnother eVision.Legacy.ELineShape object to be copied in the new eVision.Legacy.ELineShape object.

Member Function Documentation

◆ _Line__setter()

eVision.Legacy.ELineShape._Line__setter ( self,
eVision.Legacy.ELine value )
protected

Sets the nominal position, length and rotation angle of the line, according to a known eVision.Legacy.ELine object.

Reimplemented in eVision.Legacy.ELineGauge.

◆ Angle() [1/2]

float eVision.Legacy.ELineShape.Angle ( self)

Orientation of the shape.

◆ Angle() [2/2]

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

Orientation of the shape.

◆ Center() [1/2]

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

Center point of the frame.

◆ Center() [2/2]

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

Center point of the frame.

◆ CenterX()

float eVision.Legacy.ELineShape.CenterX ( self)

Abscissa of the origin point of the frame.

◆ CenterY()

float eVision.Legacy.ELineShape.CenterY ( self)

Ordinate of the origin point of the frame.

◆ Closest()

None eVision.Legacy.ELineShape.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.ELineShape.CopyTo ( self,
eVision.Legacy.ELineShape other )

Copies all the data of the current eVision.Legacy.ELineShape object into another eVision.Legacy.ELineShape object and returns it.

Remarks:

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

Parameters
otherThe other eVision.Legacy.ELineShape that we will copy into this one to.

Reimplemented in eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ CopyTo() [2/2]

None eVision.Legacy.ELineShape.CopyTo ( self,
eVision.Legacy.ELineShape other,
bool bRecursive )

Copies all the data of the current eVision.Legacy.ELineShape object into another eVision.Legacy.ELineShape object and returns it.

Remarks:

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

Parameters
otherThe other eVision.Legacy.ELineShape that we will copy into this one to.
bRecursivetrue if the children shapes have to be copied as well, false otherwise.

Reimplemented in eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ Drag()

None eVision.Legacy.ELineShape.Drag ( self,
int n32CursorX,
int n32CursorY )

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

Parameters
n32CursorXCurrent cursor coordinates.
n32CursorYCurrent cursor coordinates.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge.

◆ Draw() [1/3]

None eVision.Legacy.ELineShape.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.

Reimplemented in eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ Draw() [2/3]

None eVision.Legacy.ELineShape.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 point location or model fitting gauge must be displayed, as defined by eVision.EDrawingMode.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ Draw() [3/3]

None eVision.Legacy.ELineShape.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 point location or model fitting gauge must be displayed, as defined by eVision.EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ End()

eVision.EPoint eVision.Legacy.ELineShape.End ( self)

End point coordinates of the eVision.Legacy.ELineShape object.

◆ GetPoint()

eVision.EPoint eVision.Legacy.ELineShape.GetPoint ( self,
float fraction )

Returns the coordinates of a point along the line.

Parameters
fractionPoint location expressed as a fraction of the line length (range [-1, +1]).

◆ HitTest() [1/2]

bool eVision.Legacy.ELineShape.HitTest ( self)

Checks if there is a handle under the cursor.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ HitTest() [2/2]

bool eVision.Legacy.ELineShape.HitTest ( self,
bool bDaughters )

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.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge, and eVision.Legacy.ELineGauge.

◆ Length() [1/2]

float eVision.Legacy.ELineShape.Length ( self)

Length of the eVision.Legacy.ELineShape object.

Remarks:

By default, the length of the line is 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.

◆ Length() [2/2]

eVision.Legacy.ELineShape.Length ( self,
float value )

Length of the eVision.Legacy.ELineShape object.

Remarks:

By default, the length of the line is 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.

◆ Org()

eVision.EPoint eVision.Legacy.ELineShape.Org ( self)

Origin point coordinates of the eVision.Legacy.ELineShape object.

◆ Scale() [1/2]

float eVision.Legacy.ELineShape.Scale ( self)

Horizontal sensor resolution, in pixels per unit.

◆ Scale() [2/2]

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

Horizontal sensor resolution, in pixels per unit.

◆ SetCenterXY()

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

Sets the center coordinates of a eVision.Legacy.ELineShape object.

Parameters
centerXCenter coordinates of the eVision.Legacy.ELineShape object.
centerYCenter coordinates of the eVision.Legacy.ELineShape object.

◆ SetFromOriginAndEnd()

None eVision.Legacy.ELineShape.SetFromOriginAndEnd ( self,
eVision.EPoint origin,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.

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

◆ SetFromTwoPoints()

None eVision.Legacy.ELineShape.SetFromTwoPoints ( self,
eVision.EPoint origin,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.

Deprecated

Use eVision.Legacy.ELineShape.SetFromOriginAndEnd.

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

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

◆ Type()

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

Shape type.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ELineGauge.

Property Documentation

◆ Line

eVision.Legacy.ELineShape.Line
static
Initial value:
= property(None, _Line__setter, None,
)