eVision Python API
Loading...
Searching...
No Matches
eVision.ELine Class Reference

Represents a model of a line segment. More...

Inheritance diagram for eVision.ELine:
Collaboration diagram for eVision.ELine:

Public Member Functions

None __init__ (self)
 Constructs a eVision.ELine object.
None __init__ (self, eVision.EPoint center, float length, float angle)
 Constructs a eVision.ELine object.
None __init__ (self, eVision.EPoint center, float length)
 Constructs a eVision.ELine object.
None __init__ (self, eVision.EPoint origin, eVision.EPoint end)
 Constructs a eVision.ELine object.
None __init__ (self, eVision.ELine other)
 Constructs a eVision.ELine object.
None __init__ (self, eVision.Legacy.ELine other)
 Constructs a eVision.ELine object.
None CopyTo (self, eVision.ELine other)
 Copy the eVision.ELine to other.
None SetFromOriginAndEnd (self, eVision.EPoint origin, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.ELine object.
eVision.EPoint GetPoint (self, float fraction)
 Returns the coordinates of a point along the line.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, float zoomX)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOrigin (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
 Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
 Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, float zoomX)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None DrawOriginEnd (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
 Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.
None Load (self, str path)
 Load the eVision.ELine configuration.
None Load (self, eVision.ESerializer|None serializer)
 Load the eVision.ELine configuration.
None Save (self, str path)
 Save the eVision.ELine configuration.
None Save (self, eVision.ESerializer|None serializer)
 Save the eVision.ELine configuration.
Public Member Functions inherited from eVision.EShape
None Draw (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, float zoomX)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
 Draws the eVision.EShape shape.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
 Draws the eVision.EShape shape.
eVision.EEditionMode HitTest (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, float zoomX, float zoomY, float panX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, float zoomX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (self, int x, int y, eVision.EFrame frame, float zoomX)
 Detects if the cursor is placed over one of the dragging handles.
None Drag (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, float zoomX, float zoomY, float panX)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, float zoomX, float zoomY)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, float zoomX)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, eVision.EFrame frame, float zoomX)
 Moves the specified handle to a new position and updates all placement parameters of the region.
None Drag (self, int x, int y, eVision.EFrame frame)
 Moves the specified handle to a new position and updates all placement parameters of the region.
eVision.EFrame ToFrame (self, bool useAngle, eVision.EFrameScaling frameScaling)
 Converts the shape to a frame.
eVision.EFrame ToFrame (self, bool useAngle, eVision.EFrameScaling frameScaling, eVision.EFrame shapeFrame)
 Converts the shape to a frame.
list[eVision._eVision.EFrame] CreateFramesOnShape (self, int numFrames, float startOffset, float stopOffset, eVision.EFramesOrientation orientation)
 Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame] CreateFramesOnShape (self, int numFrames, float startOffset, float stopOffset)
 Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame] CreateFramesOnShape (self, int numFrames, float startOffset)
 Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame] CreateFramesOnShape (self, int numFrames)
 Distributes eVision.EFrames evenly along this shape's path or perimeter.

Static Public Member Functions

float GetAngleBetweenLines (eVision.ELine line1, eVision.ELine line2)
 Computes the angle between two lines.
float GetDistanceBetweenPointAndLine (eVision.EPoint pt, eVision.ELine line, bool limited)
 Computes the distance between a point and a line.
float GetDistanceBetweenPointAndLine (eVision.EPoint pt, eVision.ELine line)
 Computes the distance between a point and a line.
eVision.EPoint GetProjectionOfPointOnLine (eVision.EPoint pt, eVision.ELine line, bool limited)
 Computes the projection of a point on a line.
eVision.EPoint GetProjectionOfPointOnLine (eVision.EPoint pt, eVision.ELine line)
 Computes the projection of a point on a line.
int GetIntersectionOfLines (eVision.ELine line1, eVision.ELine line2, eVision.EPoint intersection, bool limited)
 Computes the intersection between two lines.
int GetIntersectionOfLines (eVision.ELine line1, eVision.ELine line2, eVision.EPoint intersection)
 Computes the intersection between two lines.

Properties

 Center = property(_Center__getter, _Center__setter)
 Center of the line.
 CenterX = property(_CenterX__getter, _CenterX__setter)
 Abscissa of the center of the eVision.ELine.
 CenterY = property(_CenterY__getter, _CenterY__setter)
 Ordinate of the center of the eVision.ELine.
 Angle = property(_Angle__getter, _Angle__setter)
 Orientation of the line.
 Length = property(_Length__getter, _Length__setter)
 Length of the eVision.ELine object.
 Org = property(_Org__getter, None)
 Origin point coordinates of the eVision.ELine object.
 End = property(_End__getter, None)
 End point coordinates of the eVision.ELine object.
 AvailableEditionModes = property(_AvailableEditionModes__getter, None)
 Available edition modes for the shape.
 Description = property(_Description__getter, None)
 Textual description of the shape and its parameters.
Properties inherited from eVision.EShape
 EditionMode = property(_EditionMode__getter, _EditionMode__setter)
 Current edition mode for the shape.
 AvailableEditionModes = property(_AvailableEditionModes__getter, None)
 Available edition modes for the shape.
 Description = property(_Description__getter, None)
 Textual description of the shape and its parameters.

Detailed Description

Represents a model of a line segment.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/6]

None eVision.ELine.__init__ ( self)

Constructs a eVision.ELine object.

◆ __init__() [2/6]

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

Constructs a eVision.ELine 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__() [3/6]

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

Constructs a eVision.ELine 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__() [4/6]

None eVision.ELine.__init__ ( self,
eVision.EPoint origin,
eVision.EPoint end )

Constructs a eVision.ELine object.

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

◆ __init__() [5/6]

None eVision.ELine.__init__ ( self,
eVision.ELine other )

Constructs a eVision.ELine object.

Parameters
otherAnother eVision.ELine object to be copied in the new eVision.ELine object.

◆ __init__() [6/6]

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

Constructs a eVision.ELine object.

Parameters
otherAnother eVision.ELine object to be copied in the new eVision.ELine object.

Member Function Documentation

◆ CopyTo()

None eVision.ELine.CopyTo ( self,
eVision.ELine other )

Copy the eVision.ELine to other.

Parameters
othereVision.ELine object in which the current eVision.ELine object data have to be copied.

◆ DrawEnd() [1/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.

◆ DrawEnd() [2/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.

◆ DrawEnd() [3/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawEnd() [4/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawEnd() [5/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawEnd() [6/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawEnd() [7/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawEnd() [8/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawEnd() [9/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawEnd() [10/10]

None eVision.ELine.DrawEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the end of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawOrigin() [1/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.

◆ DrawOrigin() [2/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.

◆ DrawOrigin() [3/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawOrigin() [4/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawOrigin() [5/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawOrigin() [6/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawOrigin() [7/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawOrigin() [8/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawOrigin() [9/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawOrigin() [10/10]

None eVision.ELine.DrawOrigin ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the origin of the eVision.ELine object as a small rectangle oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawOriginEnd() [1/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.

◆ DrawOriginEnd() [2/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.

◆ DrawOriginEnd() [3/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawOriginEnd() [4/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawOriginEnd() [5/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawOriginEnd() [6/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the line is defined.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawOriginEnd() [7/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawOriginEnd() [8/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawOriginEnd() [9/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawOriginEnd() [10/10]

None eVision.ELine.DrawOriginEnd ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws both the origin and the end of the eVision.ELine object as small rectangles oriented along the line, using the current pen and brush of the draw adapter.

Parameters
drawAdapterHandle of the device context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ GetAngleBetweenLines()

float eVision.ELine.GetAngleBetweenLines ( eVision.ELine line1,
eVision.ELine line2 )
static

Computes the angle between two lines.

Remarks:

The angle returned by this function is signed in the trigonometric sense, meaning that angle(1,2) = -angle(2,1).

Parameters
line1First line
line2Second line

◆ GetDistanceBetweenPointAndLine() [1/2]

float eVision.ELine.GetDistanceBetweenPointAndLine ( eVision.EPoint pt,
eVision.ELine line )
static

Computes the distance between a point and a line.

Remarks:

When the line is restricted to a segment and the orthogonal projection of the point onto the line falls outside this segment, the distance to the closest endpoint of the segment is returned instead.

Parameters
ptThe point.
lineThe line.

◆ GetDistanceBetweenPointAndLine() [2/2]

float eVision.ELine.GetDistanceBetweenPointAndLine ( eVision.EPoint pt,
eVision.ELine line,
bool limited )
static

Computes the distance between a point and a line.

Remarks:

When the line is restricted to a segment and the orthogonal projection of the point onto the line falls outside this segment, the distance to the closest endpoint of the segment is returned instead.

Parameters
ptThe point.
lineThe line.
limitedIndicates if the line parameter should be considered as an infinite line or as a segment.

◆ GetIntersectionOfLines() [1/2]

int eVision.ELine.GetIntersectionOfLines ( eVision.ELine line1,
eVision.ELine line2,
eVision.EPoint intersection )
static

Computes the intersection between two lines.

Remarks:

The function returns the number of intersections found. It will return -1 if the two lines are overlapping.

Parameters
line1First line.
line2Second line.
intersectionFound intersection.

◆ GetIntersectionOfLines() [2/2]

int eVision.ELine.GetIntersectionOfLines ( eVision.ELine line1,
eVision.ELine line2,
eVision.EPoint intersection,
bool limited )
static

Computes the intersection between two lines.

Remarks:

The function returns the number of intersections found. It will return -1 if the two lines are overlapping.

Parameters
line1First line.
line2Second line.
intersectionFound intersection.
limitedIndicates if the line parameters should be considered as infinite lines or as a segments.

◆ GetPoint()

eVision.EPoint eVision.ELine.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]).

◆ GetProjectionOfPointOnLine() [1/2]

eVision.EPoint eVision.ELine.GetProjectionOfPointOnLine ( eVision.EPoint pt,
eVision.ELine line )
static

Computes the projection of a point on a line.

Remarks:

When the line is restricted to a segment and the orthogonal projection of the point onto the line falls outside this segment, the closest endpoint of the segment is returned instead.

Parameters
ptThe point.
lineThe line.

◆ GetProjectionOfPointOnLine() [2/2]

eVision.EPoint eVision.ELine.GetProjectionOfPointOnLine ( eVision.EPoint pt,
eVision.ELine line,
bool limited )
static

Computes the projection of a point on a line.

Remarks:

When the line is restricted to a segment and the orthogonal projection of the point onto the line falls outside this segment, the closest endpoint of the segment is returned instead.

Parameters
ptThe point.
lineThe line.
limitedIndicates if the line parameter should be considered as an infinite line or as a segment.

◆ Load() [1/2]

None eVision.ELine.Load ( self,
eVision.ESerializer | None serializer )

Load the eVision.ELine configuration.

The given eVision.ESerializer must have been created for reading.

Parameters
serializerThe serializer.

Reimplemented from eVision.EShape.

◆ Load() [2/2]

None eVision.ELine.Load ( self,
str path )

Load the eVision.ELine configuration.

The given eVision.ESerializer must have been created for reading.

Parameters
pathThe file path.

Reimplemented from eVision.EShape.

◆ Save() [1/2]

None eVision.ELine.Save ( self,
eVision.ESerializer | None serializer )

Save the eVision.ELine configuration.

The given eVision.ESerializer must have been created for writing.

Parameters
serializerThe serializer.

Reimplemented from eVision.EShape.

◆ Save() [2/2]

None eVision.ELine.Save ( self,
str path )

Save the eVision.ELine configuration.

The given eVision.ESerializer must have been created for writing.

Parameters
pathThe file path.

Reimplemented from eVision.EShape.

◆ SetFromOriginAndEnd()

None eVision.ELine.SetFromOriginAndEnd ( self,
eVision.EPoint origin,
eVision.EPoint end )

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

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

Property Documentation

◆ Angle

eVision.ELine.Angle = property(_Angle__getter, _Angle__setter)
static

Orientation of the line.

◆ AvailableEditionModes

eVision.ELine.AvailableEditionModes = property(_AvailableEditionModes__getter, None)
static

Available edition modes for the shape.

◆ Center

eVision.ELine.Center = property(_Center__getter, _Center__setter)
static

Center of the line.

◆ CenterX

eVision.ELine.CenterX = property(_CenterX__getter, _CenterX__setter)
static

Abscissa of the center of the eVision.ELine.

◆ CenterY

eVision.ELine.CenterY = property(_CenterY__getter, _CenterY__setter)
static

Ordinate of the center of the eVision.ELine.

◆ Description

eVision.ELine.Description = property(_Description__getter, None)
static

Textual description of the shape and its parameters.

◆ End

eVision.ELine.End = property(_End__getter, None)
static

End point coordinates of the eVision.ELine object.

◆ Length

eVision.ELine.Length = property(_Length__getter, _Length__setter)
static

Length of the eVision.ELine 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.ELine.Org = property(_Org__getter, None)
static

Origin point coordinates of the eVision.ELine object.