Manages a line shape. More...

Inheritance diagram for eVision.Legacy.ELineShape:

[legend]

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.
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
	Center = property(_Center__getter, _Center__setter)
	Center point of the frame.
	CenterX = property(_CenterX__getter, None)
	Abscissa of the origin point of the frame.
	CenterY = property(_CenterY__getter, None)
	Ordinate of the origin point of the frame.
	Angle = property(_Angle__getter, _Angle__setter)
	Orientation of the shape.
	Scale = property(_Scale__getter, _Scale__setter)
	Horizontal sensor resolution, in pixels per unit.
	Line = property(None, _Line__setter)
	Sets the nominal position, length and rotation angle of the line, according to a known eVision.Legacy.ELine object.
	Length = property(_Length__getter, _Length__setter)
	Length of the eVision.Legacy.ELineShape object.
	Org = property(_Org__getter, None)
	Origin point coordinates of the eVision.Legacy.ELineShape object.
	End = property(_End__getter, None)
	End point coordinates of the eVision.Legacy.ELineShape object.
	Type = property(_Type__getter, None)
	Shape type.
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 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

origin	Origin point coordinates of the line.
end	End 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

center	Center coordinates of the line at its nominal position. The default value is (0,0).
length	Nominal length of the line. The default value is 100.
angle	Nominal 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

center	Center coordinates of the line at its nominal position. The default value is (0,0).
length	Nominal 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

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

other Another eVision.Legacy.ELineShape object to be copied in the new eVision.Legacy.ELineShape object.

Member Function Documentation

◆ 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

other The 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

other	The other eVision.Legacy.ELineShape that we will copy into this one to.
bRecursive	true 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

n32CursorX	Current cursor coordinates.
n32CursorY	Current 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

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

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

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

◆ GetPoint()

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

Returns the coordinates of a point along the line.

Parameters

fraction Point 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

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

◆ SetCenterXY()

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

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

Parameters

centerX	Center coordinates of the eVision.Legacy.ELineShape object.
centerY	Center 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

origin	Origin point coordinates of the line.
end	End 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

origin	Origin point coordinates of the line.
end	End point coordinates of the line.

Property Documentation

◆ Angle

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

static

Orientation of the shape.

◆ Center

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

static

Center point of the frame.

◆ CenterX

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

static

Abscissa of the origin point of the frame.

◆ CenterY

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

static

Ordinate of the origin point of the frame.

◆ End

eVision.Legacy.ELineShape.End = property(_End__getter, None)

static

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

◆ Length

eVision.Legacy.ELineShape.Length = property(_Length__getter, _Length__setter)

static

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.

◆ Line

eVision.Legacy.ELineShape.Line = property(None, _Line__setter)

static

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

◆ Org

eVision.Legacy.ELineShape.Org = property(_Org__getter, None)

static

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

◆ Scale

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

static

Horizontal sensor resolution, in pixels per unit.

◆ Type

eVision.Legacy.ELineShape.Type = property(_Type__getter, None)

static

Shape type.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/6]

◆ __init__() [2/6]

◆ __init__() [3/6]

◆ __init__() [4/6]

◆ __init__() [5/6]

◆ __init__() [6/6]

Member Function Documentation

◆ Closest()

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Drag()

◆ Draw() [1/3]

◆ Draw() [2/3]

◆ Draw() [3/3]

◆ GetPoint()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ SetCenterXY()

◆ SetFromOriginAndEnd()

◆ SetFromTwoPoints()

Property Documentation

◆ Angle

◆ Center

◆ CenterX

◆ CenterY

◆ End

◆ Length

◆ Line

◆ Org

◆ Scale

◆ Type

◆ init() [1/6]

◆ init() [2/6]

◆ init() [3/6]

◆ init() [4/6]

◆ init() [5/6]

◆ init() [6/6]