eVision .NET API
Loading...
Searching...
No Matches
eVision.EShape Class Referenceabstract

Base class for geometrical shapes. More...

Inheritance diagram for eVision.EShape:
Collaboration diagram for eVision.EShape:

Public Member Functions

void Load (string path)
 Load the EShape configuration. The given ESerializer must have been created for reading.
void Load (eVision.ESerializer serializer)
 Load the EShape configuration. The given ESerializer must have been created for reading.
void Save (string path)
 Save the EShape configuration. The given ESerializer must have been created for writing.
void Save (eVision.ESerializer serializer)
 Save the EShape configuration. The given ESerializer must have been created for writing.
void Draw (eVision.EDrawAdapter drawAdapter, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, float zoomX, float zoomY, float panX)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, float zoomX, float zoomY)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, float zoomX)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame, float zoomX)
 Draws the EShape shape.
void Draw (eVision.EDrawAdapter drawAdapter, eVision.EFrame frame)
 Draws the EShape shape.
eVision.EEditionMode HitTest (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 (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 (int x, int y, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (int x, int y, float zoomX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode HitTest (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 (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 (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 (int x, int y, eVision.EFrame frame, float zoomX)
 Detects if the cursor is placed over one of the dragging handles.
void Drag (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.
void Drag (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.
void Drag (int x, int y, float zoomX, float zoomY)
 Moves the specified handle to a new position and updates all placement parameters of the region.
void Drag (int x, int y, float zoomX)
 Moves the specified handle to a new position and updates all placement parameters of the region.
void Drag (int x, int y)
 Moves the specified handle to a new position and updates all placement parameters of the region.
void Drag (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.
void Drag (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.
void Drag (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.
void Drag (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.
void Drag (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 (bool useAngle, eVision.EFrameScaling frameScaling)
 Converts the shape to a frame.
eVision.EFrame ToFrame (bool useAngle, eVision.EFrameScaling frameScaling, eVision.EFrame shapeFrame)
 Converts the shape to a frame.

Properties

eVision.EEditionMode EditionMode [get, set]
 Current edition mode for the shape. Default: EEditionMode_None.
eVision.EEditionMode AvailableEditionModes [get]
 Available edition modes for the shape.
string Description [get]
 Textual description of the shape and its parameters.

Detailed Description

Base class for geometrical shapes.

License(s): BasicTypes

Member Function Documentation

◆ Drag() [1/10]

void eVision.EShape.Drag ( int x,
int y )

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.

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

◆ Drag() [2/10]

void eVision.EShape.Drag ( int x,
int y,
eVision.EFrame frame )

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.

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

◆ Drag() [3/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.

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

◆ Drag() [4/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

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

◆ Drag() [5/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.

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

◆ Drag() [6/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.
panYVertical pan offset. By default, no pan is added.

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

◆ Drag() [7/10]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.

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

◆ Drag() [8/10]

void eVision.EShape.Drag ( int x,
int y,
float zoomX,
float zoomY )

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

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

◆ Drag() [9/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.

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

◆ Drag() [10/10]

void eVision.EShape.Drag ( 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.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.
panYVertical pan offset. By default, no pan is added.

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

◆ Draw() [1/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter)

Draws the EShape shape.

Parameters
drawAdapterHandle of the device context on which to draw.

◆ Draw() [2/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame )

Draws the EShape shape.

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

◆ Draw() [3/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame,
float zoomX )

Draws the EShape shape.

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

◆ Draw() [4/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws the EShape shape.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the shape 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.

◆ Draw() [5/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws the EShape shape.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the shape 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.

◆ Draw() [6/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the EShape shape.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the shape 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.

◆ Draw() [7/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY,
bool drawDiagonals )

Draws the EShape shape.

Parameters
drawAdapterHandle of the device context on which to draw.
frameFrame of reference in which the shape 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.
drawDiagonalsIf relevant, draw the diagonals of the shape. By default, the diagonals are not drawn.

◆ Draw() [8/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
float zoomX )

Draws the EShape shape.

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

◆ Draw() [9/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
float zoomX,
float zoomY )

Draws the EShape shape.

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.

◆ Draw() [10/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws the EShape shape.

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.

◆ Draw() [11/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the EShape shape.

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.

◆ Draw() [12/12]

void eVision.EShape.Draw ( eVision.EDrawAdapter drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY,
bool drawDiagonals )

Draws the EShape shape.

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.
drawDiagonalsIf relevant, draw the diagonals of the shape. By default, the diagonals are not drawn.

◆ HitTest() [1/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [2/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [3/8]

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [4/8]

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
frameFrame of reference in which the shape is defined.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.
panYVertical pan offset. By default, no pan is added.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [5/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [6/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [7/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ HitTest() [8/8]

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

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

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal pan offset. By default, no pan is added.
panYVertical pan offset. By default, no pan is added.

Returns an 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 EShape.HitTest and EShape.Drag.

◆ Load() [1/2]

void eVision.EShape.Load ( eVision.ESerializer serializer)

Load the EShape configuration. The given ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ Load() [2/2]

void eVision.EShape.Load ( string path)

Load the EShape configuration. The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Save() [1/2]

void eVision.EShape.Save ( eVision.ESerializer serializer)

Save the EShape configuration. The given ESerializer must have been created for writing.

Parameters
serializerThe serializer.

◆ Save() [2/2]

void eVision.EShape.Save ( string path)

Save the EShape configuration. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ ToFrame() [1/2]

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

Converts the shape to a frame.

Parameters
useAngleWhether to use the angle of the shape as the orientation of the frame
frameScalingHow to change the scaling of the frame.

◆ ToFrame() [2/2]

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

Converts the shape to a frame.

Parameters
useAngleWhether to use the angle of the shape as the orientation of the frame
frameScalingHow to change the scaling of the frame.
shapeFrameThe frame in which the shape is defined

Property Documentation

◆ AvailableEditionModes

eVision.EEditionMode eVision.EShape.AvailableEditionModes
getabstract

Available edition modes for the shape.

◆ Description

string eVision.EShape.Description
getabstract

Textual description of the shape and its parameters.

◆ EditionMode

eVision.EEditionMode eVision.EShape.EditionMode
getset

Current edition mode for the shape. Default: EEditionMode_None.