Base class for geometrical shapes. More...

Inheritance diagram for eVision.EShape:

[legend]

Public Member Functions
None	Load (self, str path)
	Load the eVision.EShape configuration.
None	Load (self, eVision.ESerializer\|None serializer)
	Load the eVision.EShape configuration.
None	Save (self, str path)
	Save the eVision.EShape configuration.
None	Save (self, eVision.ESerializer\|None serializer)
	Save the eVision.EShape configuration.
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.

Properties
	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

Base class for geometrical shapes.

Remarks:

License(s): BasicTypes

Member Function Documentation

◆ CreateFramesOnShape() [1/4]

list[eVision._eVision.EFrame] eVision.EShape.CreateFramesOnShape	(		self,
		int	numFrames )

Distributes eVision.EFrames evenly along this shape's path or perimeter.

Remarks:

The numFrames frames are evenly distributed on the sub-path defined by startOffset and stopOffset:

When shape[startOffset] != shape[stopOffset]: The first frame is at startOffset * L and the last frame at stopOffset * L (where L is the total path length). The spacing between two consecutive frames is (stopOffset - startOffset) * L / (numFrames - 1).
When shape[startOffset] == shape[stopOffset]: The first frame is at startOffset * L and the spacing between two consecutive frames is L / numFrames (where L is the total path length).

Use eVision.EGrid.CreateFramesOnGrid to Create Frames in a grid.

Parameters

numFrames Number of frames to generate.

◆ CreateFramesOnShape() [2/4]

list[eVision._eVision.EFrame] eVision.EShape.CreateFramesOnShape	(		self,
		int	numFrames,
		float	startOffset )

Distributes eVision.EFrames evenly along this shape's path or perimeter.

Remarks:

The numFrames frames are evenly distributed on the sub-path defined by startOffset and stopOffset:

When shape[startOffset] != shape[stopOffset]: The first frame is at startOffset * L and the last frame at stopOffset * L (where L is the total path length). The spacing between two consecutive frames is (stopOffset - startOffset) * L / (numFrames - 1).
When shape[startOffset] == shape[stopOffset]: The first frame is at startOffset * L and the spacing between two consecutive frames is L / numFrames (where L is the total path length).

Use eVision.EGrid.CreateFramesOnGrid to Create Frames in a grid.

Parameters

numFrames	Number of frames to generate.
startOffset	Fractional position in [0, 1] of the first frame along the path. Defaults to 0.

◆ CreateFramesOnShape() [3/4]

list[eVision._eVision.EFrame] eVision.EShape.CreateFramesOnShape	(		self,
		int	numFrames,
		float	startOffset,
		float	stopOffset )

Distributes eVision.EFrames evenly along this shape's path or perimeter.

Remarks:

The numFrames frames are evenly distributed on the sub-path defined by startOffset and stopOffset:

When shape[startOffset] != shape[stopOffset]: The first frame is at startOffset * L and the last frame at stopOffset * L (where L is the total path length). The spacing between two consecutive frames is (stopOffset - startOffset) * L / (numFrames - 1).
When shape[startOffset] == shape[stopOffset]: The first frame is at startOffset * L and the spacing between two consecutive frames is L / numFrames (where L is the total path length).

Use eVision.EGrid.CreateFramesOnGrid to Create Frames in a grid.

Parameters

numFrames	Number of frames to generate.
startOffset	Fractional position in [0, 1] of the first frame along the path. Defaults to 0.
stopOffset	Fractional position in [0, 1] of the last frame along the path. Must be >= startOffset. Defaults to 1.

◆ CreateFramesOnShape() [4/4]

list[eVision._eVision.EFrame] eVision.EShape.CreateFramesOnShape	(		self,
		int	numFrames,
		float	startOffset,
		float	stopOffset,
		eVision.EFramesOrientation	orientation )

Distributes eVision.EFrames evenly along this shape's path or perimeter.

Remarks:

The numFrames frames are evenly distributed on the sub-path defined by startOffset and stopOffset:

When shape[startOffset] != shape[stopOffset]: The first frame is at startOffset * L and the last frame at stopOffset * L (where L is the total path length). The spacing between two consecutive frames is (stopOffset - startOffset) * L / (numFrames - 1).
When shape[startOffset] == shape[stopOffset]: The first frame is at startOffset * L and the spacing between two consecutive frames is L / numFrames (where L is the total path length).

Use eVision.EGrid.CreateFramesOnGrid to Create Frames in a grid.

Parameters

numFrames	Number of frames to generate.
startOffset	Fractional position in [0, 1] of the first frame along the path. Defaults to 0.
stopOffset	Fractional position in [0, 1] of the last frame along the path. Must be >= startOffset. Defaults to 1.
orientation	Whether each frame keeps the shape's base angle (eVision.EFramesOrientation.AlignedOnShape), follows the local tangent of the path (eVision.EFramesOrientation.AlignedLocally) or uses an angle of 0° (eVision.EFramesOrientation.Fixed). Defaults to eVision.EFramesOrientation.Fixed.

◆ Drag() [1/10]

None eVision.EShape.Drag	(		self,
		int	x,
		int	y )

Moves the specified handle to a new position and updates all placement parameters of the region.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.

◆ Drag() [2/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.

◆ Drag() [3/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ Drag() [4/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ Drag() [5/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ Drag() [6/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ Drag() [7/10]

None eVision.EShape.Drag	(		self,
		int	x,
		int	y,
		float	zoomX )

Moves the specified handle to a new position and updates all placement parameters of the region.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ Drag() [8/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ Drag() [9/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ Drag() [10/10]

None eVision.EShape.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.

Remarks:

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ Draw() [1/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter )

Draws the eVision.EShape shape.

Parameters

drawAdapter Handle of the device context on which to draw.

◆ Draw() [2/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.

◆ Draw() [3/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zooming factor. By default, true scale is used.

◆ Draw() [4/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ Draw() [5/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [6/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [7/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY,
		bool	drawDiagonals )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.
drawDiagonals	If relevant, draw the diagonals of the shape. By default, the diagonals are not drawn.

◆ Draw() [8/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	zoomX )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.

◆ Draw() [9/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	zoomX,
		float	zoomY )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ Draw() [10/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [11/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [12/12]

None eVision.EShape.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY,
		bool	drawDiagonals )

Draws the eVision.EShape shape.

Parameters

drawAdapter	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.
drawDiagonals	If relevant, draw the diagonals of the shape. By default, the diagonals are not drawn.

◆ HitTest() [1/8]

eVision.EEditionMode eVision.EShape.HitTest	(		self,
		int	x,
		int	y,
		eVision.EFrame	frame,
		float	zoomX )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ HitTest() [2/8]

eVision.EEditionMode eVision.EShape.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.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ HitTest() [3/8]

eVision.EEditionMode eVision.EShape.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.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ HitTest() [4/8]

eVision.EEditionMode eVision.EShape.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.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
frame	Frame of reference in which the shape is defined.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ HitTest() [5/8]

eVision.EEditionMode eVision.EShape.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ HitTest() [6/8]

eVision.EEditionMode eVision.EShape.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ HitTest() [7/8]

eVision.EEditionMode eVision.EShape.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY,
		float	panX )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

◆ HitTest() [8/8]

eVision.EEditionMode eVision.EShape.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.

Remarks:

Returns an eVision.EEditionMode indicating the type of handle under the mouse.

If zooming and/or panning were used when drawing the region, the same values must be used with eVision.EShape.HitTest and eVision.EShape.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

◆ Load() [1/2]

None eVision.EShape.Load	(		self,
		eVision.ESerializer \| None	serializer )

Load the eVision.EShape configuration.

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

Parameters

serializer The serializer.

Reimplemented in eVision.ELine, and eVision.ELine.

◆ Load() [2/2]

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

Load the eVision.EShape configuration.

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

Parameters

path	The file path.

Reimplemented in eVision.ELine, and eVision.ELine.

◆ Save() [1/2]

None eVision.EShape.Save	(		self,
		eVision.ESerializer \| None	serializer )

Save the eVision.EShape configuration.

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

Parameters

serializer The serializer.

Reimplemented in eVision.ELine, and eVision.ELine.

◆ Save() [2/2]

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

Save the eVision.EShape configuration.

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

Parameters

path	The file path.

Reimplemented in eVision.ELine, and eVision.ELine.

◆ ToFrame() [1/2]

eVision.EFrame eVision.EShape.ToFrame	(		self,
		bool	useAngle,
		eVision.EFrameScaling	frameScaling )

Converts the shape to a frame.

Parameters

useAngle	Whether to use the angle of the shape as the orientation of the frame
frameScaling	How to change the scaling of the frame.

◆ ToFrame() [2/2]

eVision.EFrame eVision.EShape.ToFrame	(		self,
		bool	useAngle,
		eVision.EFrameScaling	frameScaling,
		eVision.EFrame	shapeFrame )

Converts the shape to a frame.

Parameters

useAngle	Whether to use the angle of the shape as the orientation of the frame
frameScaling	How to change the scaling of the frame.
shapeFrame	The frame in which the shape is defined

Property Documentation

◆ AvailableEditionModes

eVision.EShape.AvailableEditionModes = property(_AvailableEditionModes__getter, None)

static

Available edition modes for the shape.

◆ Description

eVision.EShape.Description = property(_Description__getter, None)

static

Textual description of the shape and its parameters.

◆ EditionMode

eVision.EShape.EditionMode = property(_EditionMode__getter, _EditionMode__setter)

static

Current edition mode for the shape.

Default: EEditionMode_None.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateFramesOnShape() [1/4]

◆ CreateFramesOnShape() [2/4]

◆ CreateFramesOnShape() [3/4]

◆ CreateFramesOnShape() [4/4]

◆ Drag() [1/10]

◆ Drag() [2/10]

◆ Drag() [3/10]

◆ Drag() [4/10]

◆ Drag() [5/10]

◆ Drag() [6/10]

◆ Drag() [7/10]

◆ Drag() [8/10]

◆ Drag() [9/10]

◆ Drag() [10/10]

◆ Draw() [1/12]

◆ Draw() [2/12]

◆ Draw() [3/12]

◆ Draw() [4/12]

◆ Draw() [5/12]

◆ Draw() [6/12]

◆ Draw() [7/12]

◆ Draw() [8/12]

◆ Draw() [9/12]

◆ Draw() [10/12]

◆ Draw() [11/12]

◆ Draw() [12/12]

◆ HitTest() [1/8]

◆ HitTest() [2/8]

◆ HitTest() [3/8]

◆ HitTest() [4/8]

◆ HitTest() [5/8]

◆ HitTest() [6/8]

◆ HitTest() [7/8]

◆ HitTest() [8/8]

◆ Load() [1/2]

◆ Load() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ ToFrame() [1/2]

◆ ToFrame() [2/2]

Property Documentation

◆ AvailableEditionModes

◆ Description

◆ EditionMode