eVision .NET API
Loading...
Searching...
No Matches
eVision.EFrame Class Reference

Represents a geometrical frame of reference. More...

Inheritance diagram for eVision.EFrame:
Collaboration diagram for eVision.EFrame:

Public Member Functions

 EFrame ()
 Constructs a EFrame object.
 EFrame (float centerX, float centerY, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (float centerX, float centerY, float angle, float scaleX)
 Constructs a EFrame object.
 EFrame (float centerX, float centerY, float angle)
 Constructs a EFrame object.
 EFrame (float centerX, float centerY)
 Constructs a EFrame object.
 EFrame (float centerX, float centerY, float angle, float scaleX, float scaleY, eVision.ECameraCalibration calibration)
 Constructs a EFrame object.
 EFrame (eVision.EFrame parent, float centerX, float centerY, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (eVision.EPoint center, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (eVision.EFrame parent, eVision.EPoint center, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (eVision.EPoint center, float angle, float scaleX, float scaleY, eVision.ECameraCalibration calibration)
 Constructs a EFrame object.
 EFrame (eVision.EFrame other)
 Constructs a EFrame object.
 EFrame (eVision.ECameraCalibration calibration)
 Constructs a EFrame object.
void CopyTo (eVision.EFrame other)
 Copies all the data from the current EFrame object into another EFrame object, and returns it.
bool IsCalibrationDirect ()
 Whether the EFrame.CameraCalibration is direct or inverse.
bool IsDirect ()
 Whether the transformation to world coordinates is direct or inverse.
bool IsIdentity ()
 Whether the frame is center on (0,0) with a scale of (1,1), angle of 0° and no calibration.
bool IsIsotropic ()
 Whether the frame is isotropic, i.e. has the scales along the X and Y axis have the same absolute value.
bool IsLocalToSensorAffine ()
 Whether the transformation to sensor coordinates is affine.
bool IsLocalToSensorIsotropic ()
 Whether the transformation to sensor coordinates is affine and isotropic (the scale along the X and Y axis have the same absolute value).
bool IsLocalToSensorDirect ()
 Whether the transformation to sensor coordinates is direct or inverse.
bool IsCalibrated ()
 Whether the frame has a ECameraCalibration or not.
eVision.EPoint LocalToWorld (eVision.EPoint local)
 Transforms a geometrical element from local to world coordinates.
eVision.EFrame LocalToWorld (eVision.EFrame local)
 Transforms a geometrical element from local to world coordinates.
eVision.ELine LocalToWorld (eVision.ELine local)
 Transforms a geometrical element from local to world coordinates.
eVision.EEllipse LocalToWorld (eVision.ECircle local)
 Transforms a geometrical element from local to world coordinates.
eVision.EEllipse LocalToWorld (eVision.EEllipse local)
 Transforms a geometrical element from local to world coordinates.
eVision.EPolygon LocalToWorld (eVision.EPolygon local)
 Transforms a geometrical element from local to world coordinates.
eVision.ECircle LocalToWorldIsotropic (eVision.ECircle local)
 Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.
eVision.EWedge LocalToWorldIsotropic (eVision.EWedge local)
 Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.
eVision.EPoint WorldToLocal (eVision.EPoint world)
 Transforms a geometrical element from world to local coordinates.
eVision.EFrame WorldToLocal (eVision.EFrame world)
 Transforms a geometrical element from world to local coordinates.
eVision.EPolygon WorldToLocal (eVision.EPolygon world)
 Transforms a geometrical element from world to local coordinates.
eVision.EPoint LocalToSensor (eVision.EPoint local)
 Transforms a geometrical element from local to sensor coordinates.
eVision.ELine LocalToSensor (eVision.ELine local)
 Transforms a geometrical element from local to sensor coordinates.
eVision.EEllipse LocalToSensor (eVision.ECircle local)
 Transforms a geometrical element from local to sensor coordinates.
eVision.EEllipse LocalToSensor (eVision.EEllipse local)
 Transforms a geometrical element from local to sensor coordinates.
eVision.EWedge LocalToSensor (eVision.EWedge local)
 Transforms a geometrical element from local to sensor coordinates.
eVision.EPoint SensorToLocal (eVision.EPoint sensor)
 Transforms a geometrical element from sensor to local coordinates.
eVision.EPoint SensorToWorld (eVision.EPoint sensor)
 Transforms a geometrical element from sensor to local coordinates.
void Load (string path)
 Load the EFrame configuration. The given ESerializer must have been created for reading.
void Load (eVision.ESerializer serializer)
 Load the EFrame configuration. The given ESerializer must have been created for reading.
void Save (string path)
 Save the EFrame configuration. The given ESerializer must have been created for writing.
void Save (eVision.ESerializer serializer)
 Save the EFrame configuration. The given ESerializer must have been created for writing.
bool IsDisplaySizeSet ()
 Whether the display size was set using EFrame.DisplaySize or it is a default value.
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 handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, float zoomX, float zoomY, float panX)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, float zoomX)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
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 handles and returns the edition mode represented by the handle.
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 handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, eVision.EFrame frame, float zoomX)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
eVision.EEditionMode HitTest (int x, int y, eVision.EFrame frame)
 Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.
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.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX, float panY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, float zoomX, float zoomY, float panX, float panY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, float zoomX, float zoomY, float panX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, float zoomX, float zoomY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, float zoomX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EFrame frame, float zoomX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EFrame frame)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the world coordinate axis.
void Draw (eVision.EDrawAdapter graphicContext, eVision.ERGBColor xAxisColor, eVision.ERGBColor yAxisColor, eVision.EFrame frame, float zoomX)
 Draws the world coordinate axis.
bool IsEqual (eVision.EFrame other)
 Compares this frame with the other.

Properties

float Angle [get, set]
 Orientation of the frame.
float ScaleX [get, set]
 Scale along the X axis.
float ScaleY [get, set]
 Scale along the Y axis.
float CenterX [get, set]
 Abscissa of the origin point of the frame.
float CenterY [get, set]
 Ordinate of the origin point of the frame.
eVision.EPoint Center [get, set]
 Center coordinates of a EFrame object.
eVision.EPoint SensorCenter [get]
 Coordinates of the center of the frame in the sensor frame.
float SensorCenterX [get]
 X coordinate of the center of the frame in the sensor frame.
float SensorCenterY [get]
 Y coordinate of the center of the frame in the sensor frame.
float SensorScaleX [get]
 Scale along the X axis in the sensor frame at the EFrame.SensorCenter.
float SensorScaleY [get]
 Scale along the Y axis in the sensor frame at the EFrame.SensorCenter.
float SensorAngle [get]
 Orientation of the frame in the sensor frame.
eVision.ECameraCalibration CameraCalibration [get, set]
 Camera calibration of the frame.
eVision.EEditionMode EditionMode [get, set]
 Graphical edition modes.
float DisplaySize [get, set]
 Display size of the axis of the frame (in world unit).

Detailed Description

Represents a geometrical frame of reference.

In the context of a frame, we have the following coordinates:

  • local: coordinates expressed in the frame of reference represented by the object.
  • world: the coordinate systems of the calibrated field of view, represented by a ECameraCalibration object.
  • sensor: the coordinate systems of the image (representing the pixel's coordinates)

The frame of reference can be calibrated or not. When it is calibrated (EFrame.IsCalibrated), the frame is defined with respect to the world frame of reference. In this case, going from a local coordinate to a sensor coordinate (LocalToSensor(x)) is equivalent to WorldToSensor(LocalToWorld(x)). When the frame is not calibrated, we assume that the world and sensor frame are the same.

A frame can be built using a parent frame. The specified parameters are related to the parent frame. However, the frame center, angle and scale will be different from those specified because EFrame.Center, EFrame.Angle, EFrame.ScaleX, and EFrame.ScaleY are expressed with respect to the world frame. Constructing a frame with a parent is equivalent to doing parent.LocalToWorld(child).

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EFrame() [1/12]

eVision.EFrame.EFrame ( )

Constructs a EFrame object.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [2/12]

eVision.EFrame.EFrame ( float centerX,
float centerY,
float angle,
float scaleX,
float scaleY )

Constructs a EFrame object.

Parameters
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [3/12]

eVision.EFrame.EFrame ( float centerX,
float centerY,
float angle,
float scaleX )

Constructs a EFrame object.

Parameters
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [4/12]

eVision.EFrame.EFrame ( float centerX,
float centerY,
float angle )

Constructs a EFrame object.

Parameters
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.
angleOrientation of the frame.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [5/12]

eVision.EFrame.EFrame ( float centerX,
float centerY )

Constructs a EFrame object.

Parameters
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [6/12]

eVision.EFrame.EFrame ( float centerX,
float centerY,
float angle,
float scaleX,
float scaleY,
eVision.ECameraCalibration calibration )

Constructs a EFrame object.

Parameters
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.
calibrationCamera calibration

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [7/12]

eVision.EFrame.EFrame ( eVision.EFrame parent,
float centerX,
float centerY,
float angle,
float scaleX,
float scaleY )

Constructs a EFrame object.

Parameters
parentFrame in which the center, angle and scales are expressed.
centerXAbscissa of the center point of the frame.
centerYOrdinate of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [8/12]

eVision.EFrame.EFrame ( eVision.EPoint center,
float angle,
float scaleX,
float scaleY )

Constructs a EFrame object.

Parameters
centerCoordinates of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [9/12]

eVision.EFrame.EFrame ( eVision.EFrame parent,
eVision.EPoint center,
float angle,
float scaleX,
float scaleY )

Constructs a EFrame object.

Parameters
parentFrame in which the center, angle and scales are expressed.
centerCoordinates of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [10/12]

eVision.EFrame.EFrame ( eVision.EPoint center,
float angle,
float scaleX,
float scaleY,
eVision.ECameraCalibration calibration )

Constructs a EFrame object.

Parameters
centerCoordinates of the center point of the frame.
angleOrientation of the frame.
scaleXHorizontal sensor resolution.
scaleYVertical sensor resolution.
calibrationCamera calibration

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [11/12]

eVision.EFrame.EFrame ( eVision.EFrame other)

Constructs a EFrame object.

Parameters
otherOther EFrame object to copy from.

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

◆ EFrame() [12/12]

eVision.EFrame.EFrame ( eVision.ECameraCalibration calibration)

Constructs a EFrame object.

Parameters
calibrationCamera calibration

When constructing a frame using a parent frame, the specified center, angle and scales are expressed in the parent local frame. The center, angle, and scales of the resulting frame will be computed to be expressed with respect to the world frame.

Member Function Documentation

◆ CopyTo()

void eVision.EFrame.CopyTo ( eVision.EFrame other)

Copies all the data from the current EFrame object into another EFrame object, and returns it.

Parameters
otherPointer to the EFrame object in which the current EFrame object data have to be copied.

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

◆ Drag() [1/10]

void eVision.EFrame.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.

◆ Drag() [2/10]

void eVision.EFrame.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.

◆ Drag() [3/10]

void eVision.EFrame.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.

◆ Drag() [4/10]

void eVision.EFrame.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.

◆ Drag() [5/10]

void eVision.EFrame.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.

◆ Drag() [6/10]

void eVision.EFrame.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.

◆ Drag() [7/10]

void eVision.EFrame.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.

◆ Drag() [8/10]

void eVision.EFrame.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.

◆ Drag() [9/10]

void eVision.EFrame.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.

◆ Drag() [10/10]

void eVision.EFrame.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.

◆ Draw() [1/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext)

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.

◆ Draw() [2/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EFrame frame )

Draws the world coordinate axis.

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

◆ Draw() [3/18]

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

Draws the world coordinate axis.

Parameters
graphicContextHandle 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/18]

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

Draws the world coordinate axis.

Parameters
graphicContextHandle 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/18]

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

Draws the world coordinate axis.

Parameters
graphicContextHandle 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/18]

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

Draws the world coordinate axis.

Parameters
graphicContextHandle 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/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
eVision.EFrame frame,
float zoomX )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
frameFrame of reference in which the shape is defined.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ Draw() [8/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [9/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [10/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [11/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
float zoomX )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
zoomXHorizontal zooming factor. By default, true scale is used.

◆ Draw() [12/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
float zoomX,
float zoomY )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [13/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
float zoomX,
float zoomY,
float panX )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [14/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
eVision.ERGBColor xAxisColor,
eVision.ERGBColor yAxisColor,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the world coordinate axis.

Parameters
graphicContextHandle of the device context on which to draw.
xAxisColorColor with which to draw the X axis (default: red)
yAxisColorColor with which to draw the Y axis (default: blue)
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() [15/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX )

Draws the world coordinate axis.

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

◆ Draw() [16/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY )

Draws the world coordinate axis.

Parameters
graphicContextHandle 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() [17/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY,
float panX )

Draws the world coordinate axis.

Parameters
graphicContextHandle 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() [18/18]

void eVision.EFrame.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the world coordinate axis.

Parameters
graphicContextHandle 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.

◆ HitTest() [1/10]

eVision.EEditionMode eVision.EFrame.HitTest ( int x,
int y )

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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

Returns the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [2/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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

Returns the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [3/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [4/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [5/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [6/10]

eVision.EEditionMode eVision.EFrame.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 handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [7/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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

Returns the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [8/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [9/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ HitTest() [10/10]

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

Detects if the cursor is placed over one of the handles and returns the edition mode represented by the handle.

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 the edition mode corresponding to the handle.

If zooming and/or panning were used when drawing the frame, the same values must be used with EFrame.Drag.

◆ IsCalibrated()

bool eVision.EFrame.IsCalibrated ( )

Whether the frame has a ECameraCalibration or not.

A non-calibrated frame means that its world and sensor frame are the same.

◆ IsCalibrationDirect()

bool eVision.EFrame.IsCalibrationDirect ( )

Whether the EFrame.CameraCalibration is direct or inverse.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards.

When the field of view is not calibrated, the coordinate system is said to be inverse the abscissa extends rightwards and the ordinate extends downwards.

◆ IsDirect()

bool eVision.EFrame.IsDirect ( )

Whether the transformation to world coordinates is direct or inverse.

In a direct transformation, a counter-clockwise rotation is considered positive.

In an inverse transformation, a clockwise rotation is considered positive.

◆ IsDisplaySizeSet()

bool eVision.EFrame.IsDisplaySizeSet ( )

Whether the display size was set using EFrame.DisplaySize or it is a default value.

◆ IsEqual()

bool eVision.EFrame.IsEqual ( eVision.EFrame other)

Compares this frame with the other.

Parameters
otherOther EFrame object.

◆ IsIdentity()

bool eVision.EFrame.IsIdentity ( )

Whether the frame is center on (0,0) with a scale of (1,1), angle of 0° and no calibration.

◆ IsIsotropic()

bool eVision.EFrame.IsIsotropic ( )

Whether the frame is isotropic, i.e. has the scales along the X and Y axis have the same absolute value.

◆ IsLocalToSensorAffine()

bool eVision.EFrame.IsLocalToSensorAffine ( )

Whether the transformation to sensor coordinates is affine.

The transformation is not affine when the frame is calibrated and the calibration modes includes ECalibrationMode.ECalibrationMode_Radial, ECalibrationMode.ECalibrationMode_Advanced, ECalibrationMode.ECalibrationMode_Tilted or ECalibrationMode.ECalibrationMode_Quadratic.

◆ IsLocalToSensorDirect()

bool eVision.EFrame.IsLocalToSensorDirect ( )

Whether the transformation to sensor coordinates is direct or inverse.

In a direct transformation, a counter-clockwise rotation is considered positive. This is the case for a calibrated field of view or the frame of a ZMap.

In an inverse transformation, a clockwise rotation is considered positive. This is the case for a non calibration field of view.

◆ IsLocalToSensorIsotropic()

bool eVision.EFrame.IsLocalToSensorIsotropic ( )

Whether the transformation to sensor coordinates is affine and isotropic (the scale along the X and Y axis have the same absolute value).

◆ Load() [1/2]

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

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

Parameters
serializerThe serializer.

◆ Load() [2/2]

void eVision.EFrame.Load ( string path)

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

Parameters
pathThe file path.

◆ LocalToSensor() [1/5]

eVision.EEllipse eVision.EFrame.LocalToSensor ( eVision.ECircle local)

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [2/5]

eVision.EEllipse eVision.EFrame.LocalToSensor ( eVision.EEllipse local)

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [3/5]

eVision.ELine eVision.EFrame.LocalToSensor ( eVision.ELine local)

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [4/5]

eVision.EPoint eVision.EFrame.LocalToSensor ( eVision.EPoint local)

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [5/5]

eVision.EWedge eVision.EFrame.LocalToSensor ( eVision.EWedge local)

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [1/6]

eVision.EEllipse eVision.EFrame.LocalToWorld ( eVision.ECircle local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [2/6]

eVision.EEllipse eVision.EFrame.LocalToWorld ( eVision.EEllipse local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [3/6]

eVision.EFrame eVision.EFrame.LocalToWorld ( eVision.EFrame local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [4/6]

eVision.ELine eVision.EFrame.LocalToWorld ( eVision.ELine local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [5/6]

eVision.EPoint eVision.EFrame.LocalToWorld ( eVision.EPoint local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [6/6]

eVision.EPolygon eVision.EFrame.LocalToWorld ( eVision.EPolygon local)

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorldIsotropic() [1/2]

eVision.ECircle eVision.EFrame.LocalToWorldIsotropic ( eVision.ECircle local)

Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorldIsotropic() [2/2]

eVision.EWedge eVision.EFrame.LocalToWorldIsotropic ( eVision.EWedge local)

Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.

Parameters
localThe element, expressed in local coordinates.

◆ Save() [1/2]

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

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

Parameters
serializerThe serializer.

◆ Save() [2/2]

void eVision.EFrame.Save ( string path)

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

Parameters
pathThe file path.

◆ SensorToLocal()

eVision.EPoint eVision.EFrame.SensorToLocal ( eVision.EPoint sensor)

Transforms a geometrical element from sensor to local coordinates.

Parameters
sensorThe element, expressed in sensor coordinates.

◆ SensorToWorld()

eVision.EPoint eVision.EFrame.SensorToWorld ( eVision.EPoint sensor)

Transforms a geometrical element from sensor to local coordinates.

Parameters
sensorThe element, expressed in sensor coordinates.

◆ WorldToLocal() [1/3]

eVision.EFrame eVision.EFrame.WorldToLocal ( eVision.EFrame world)

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

◆ WorldToLocal() [2/3]

eVision.EPoint eVision.EFrame.WorldToLocal ( eVision.EPoint world)

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

◆ WorldToLocal() [3/3]

eVision.EPolygon eVision.EFrame.WorldToLocal ( eVision.EPolygon world)

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

Property Documentation

◆ Angle

float eVision.EFrame.Angle
getset

Orientation of the frame.

◆ CameraCalibration

eVision.ECameraCalibration eVision.EFrame.CameraCalibration
getset

Camera calibration of the frame.

◆ Center

eVision.EPoint eVision.EFrame.Center
getset

Center coordinates of a EFrame object.

◆ CenterX

float eVision.EFrame.CenterX
getset

Abscissa of the origin point of the frame.

◆ CenterY

float eVision.EFrame.CenterY
getset

Ordinate of the origin point of the frame.

◆ DisplaySize

float eVision.EFrame.DisplaySize
getset

Display size of the axis of the frame (in world unit).

The default value is

◆ EditionMode

eVision.EEditionMode eVision.EFrame.EditionMode
getset

Graphical edition modes.

◆ ScaleX

float eVision.EFrame.ScaleX
getset

Scale along the X axis.

◆ ScaleY

float eVision.EFrame.ScaleY
getset

Scale along the Y axis.

◆ SensorAngle

float eVision.EFrame.SensorAngle
get

Orientation of the frame in the sensor frame.

◆ SensorCenter

eVision.EPoint eVision.EFrame.SensorCenter
get

Coordinates of the center of the frame in the sensor frame.

◆ SensorCenterX

float eVision.EFrame.SensorCenterX
get

X coordinate of the center of the frame in the sensor frame.

◆ SensorCenterY

float eVision.EFrame.SensorCenterY
get

Y coordinate of the center of the frame in the sensor frame.

◆ SensorScaleX

float eVision.EFrame.SensorScaleX
get

Scale along the X axis in the sensor frame at the EFrame.SensorCenter.

If EFrame.IsLocalToSensorAffine is true, then the scale is the same every where in the image. Otherwise, the scale will change according to perspective or distortion effects.

◆ SensorScaleY

float eVision.EFrame.SensorScaleY
get

Scale along the Y axis in the sensor frame at the EFrame.SensorCenter.

If EFrame.IsLocalToSensorAffine is true, then the scale is the same every where in the image. Otherwise, the scale will change according to perspective or distortion effects.