eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EFrame Class Reference

Represents a geometrical frame of reference. More...

#include <eVision/Easy/EFrame.h>

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, const eVision::ECameraCalibration &calibration)
 Constructs a EFrame object.
 EFrame (const eVision::EFrame &parent, float centerX, float centerY, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (const eVision::EPoint &center, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (const eVision::EFrame &parent, const eVision::EPoint &center, float angle, float scaleX, float scaleY)
 Constructs a EFrame object.
 EFrame (const eVision::EPoint &center, float angle, float scaleX, float scaleY, const eVision::ECameraCalibration &calibration)
 Constructs a EFrame object.
 EFrame (const eVision::EFrame &other)
 Constructs a EFrame object.
 EFrame (const eVision::ECameraCalibration &calibration)
 Constructs a EFrame object.
virtual ~EFrame () throw ()
eVision::EFrame & operator= (const eVision::EFrame &frame)
 Copies all the data from another EFrame object into the current EFrame object.
void CopyTo (eVision::EFrame &other) const
 Copies all the data from the current EFrame object into another EFrame object, and returns it.
void SetAngle (float angle)
 Orientation of the frame.
float GetAngle () const
 Orientation of the frame.
void SetScaleX (float scale)
 Scale along the X axis.
float GetScaleX () const
 Scale along the X axis.
void SetScaleY (float scale)
 Scale along the Y axis.
float GetScaleY () const
 Scale along the Y axis.
float GetCenterX () const
 Abscissa of the origin point of the frame.
void SetCenterX (float centerX)
 Abscissa of the origin point of the frame.
float GetCenterY () const
 Ordinate of the origin point of the frame.
void SetCenterY (float centerY)
 Ordinate of the origin point of the frame.
void SetCenter (const eVision::EPoint &center)
 Center coordinates of a EFrame object.
eVision::EPoint GetCenter () const
 Center coordinates of a EFrame object.
eVision::EPoint GetSensorCenter () const
 Coordinates of the center of the frame in the sensor frame.
float GetSensorCenterX () const
 X coordinate of the center of the frame in the sensor frame.
float GetSensorCenterY () const
 Y coordinate of the center of the frame in the sensor frame.
float GetSensorScaleX () const
 Scale along the X axis in the sensor frame at the EFrame::GetSensorCenter.
float GetSensorScaleY () const
 Scale along the Y axis in the sensor frame at the EFrame::GetSensorCenter.
float GetSensorAngle () const
 Orientation of the frame in the sensor frame.
std::unique_ptr< eVision::ECameraCalibration > GetCameraCalibration () const
 Camera calibration of the frame.
void SetCameraCalibration (const eVision::ECameraCalibration &calibration)
 Camera calibration of the frame.
bool IsCalibrationDirect () const
 Whether the EFrame::GetCameraCalibration is direct or inverse.
bool IsDirect () const
 Whether the transformation to world coordinates is direct or inverse.
bool IsIdentity () const
 Whether the frame is center on (0,0) with a scale of (1,1), angle of 0° and no calibration.
bool IsIsotropic () const
 Whether the frame is isotropic, i.e. has the scales along the X and Y axis have the same absolute value.
bool IsLocalToSensorAffine () const
 Whether the transformation to sensor coordinates is affine.
bool IsLocalToSensorIsotropic () const
 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 () const
 Whether the transformation to sensor coordinates is direct or inverse.
bool IsCalibrated () const
 Whether the frame has a ECameraCalibration or not.
eVision::EPoint LocalToWorld (const eVision::EPoint &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::EFrame LocalToWorld (const eVision::EFrame &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::ELine LocalToWorld (const eVision::ELine &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::EEllipse LocalToWorld (const eVision::ECircle &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::EEllipse LocalToWorld (const eVision::EEllipse &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::EPolygon LocalToWorld (const eVision::EPolygon &local) const
 Transforms a geometrical element from local to world coordinates.
eVision::ECircle LocalToWorldIsotropic (const eVision::ECircle &local) const
 Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.
eVision::EWedge LocalToWorldIsotropic (const eVision::EWedge &local) const
 Transforms an ECircle or an EWedge from local to world coordinates in an isotropic EFrame.
eVision::EPoint WorldToLocal (const eVision::EPoint &world) const
 Transforms a geometrical element from world to local coordinates.
eVision::EFrame WorldToLocal (const eVision::EFrame &world) const
 Transforms a geometrical element from world to local coordinates.
eVision::EPolygon WorldToLocal (const eVision::EPolygon &world) const
 Transforms a geometrical element from world to local coordinates.
eVision::EPoint LocalToSensor (const eVision::EPoint &local) const
 Transforms a geometrical element from local to sensor coordinates.
eVision::ELine LocalToSensor (const eVision::ELine &local) const
 Transforms a geometrical element from local to sensor coordinates.
eVision::EEllipse LocalToSensor (const eVision::ECircle &local) const
 Transforms a geometrical element from local to sensor coordinates.
eVision::EEllipse LocalToSensor (const eVision::EEllipse &local) const
 Transforms a geometrical element from local to sensor coordinates.
eVision::EWedge LocalToSensor (const eVision::EWedge &local) const
 Transforms a geometrical element from local to sensor coordinates.
eVision::EPoint SensorToLocal (const eVision::EPoint &sensor) const
 Transforms a geometrical element from sensor to local coordinates.
eVision::EPoint SensorToWorld (const eVision::EPoint &sensor) const
 Transforms a geometrical element from sensor to local coordinates.
void Load (const std::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 (const std::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.
void SetEditionMode (eVision::EEditionMode mode)
 Graphical edition modes.
eVision::EEditionMode GetEditionMode () const
 Graphical edition modes.
void SetDisplaySize (float size)
 Display size of the axis of the frame (in world unit).
float GetDisplaySize () const
 Display size of the axis of the frame (in world unit).
bool IsDisplaySizeSet () const
 Whether the display size was set using EFrame::SetDisplaySize 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, const 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, const 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, const 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, const 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, const 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, const 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, const 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, const 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, const 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, const 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) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, float zoomX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, float zoomX, float zoomY, float panX, float panY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, float zoomX, float zoomY, float panX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, float zoomX, float zoomY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, float zoomX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, const eVision::EFrame &frame, float zoomX, float zoomY) const
 Draws the world coordinate axis.
void Draw (eVision::EDrawAdapter *graphicContext, const eVision::ERGBColor &xAxisColor, const eVision::ERGBColor &yAxisColor, const eVision::EFrame &frame, float zoomX) const
 Draws the world coordinate axis.
bool IsEqual (const eVision::EFrame &other) const
 Compares this frame with the other.
 EFrame (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

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::SetCenter, EFrame::SetAngle, EFrame::SetScaleX, and EFrame::SetScaleY 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/13]

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/13]

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/13]

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/13]

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/13]

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/13]

eVision::EFrame::EFrame ( float centerX,
float centerY,
float angle,
float scaleX,
float scaleY,
const 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/13]

eVision::EFrame::EFrame ( const 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/13]

eVision::EFrame::EFrame ( const 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/13]

eVision::EFrame::EFrame ( const eVision::EFrame & parent,
const 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/13]

eVision::EFrame::EFrame ( const eVision::EPoint & center,
float angle,
float scaleX,
float scaleY,
const 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/13]

eVision::EFrame::EFrame ( const 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/13]

eVision::EFrame::EFrame ( const 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.

◆ ~EFrame()

eVision::EFrame::~EFrame ( )
throw ( )
virtual

◆ EFrame() [13/13]

eVision::EFrame::EFrame ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ CopyTo()

void eVision::EFrame::CopyTo ( eVision::EFrame & other) const

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,
const 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,
const 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,
const 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,
const 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,
const 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) const

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,
const eVision::EFrame & frame ) const

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,
const eVision::EFrame & frame,
float zoomX ) const

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,
const eVision::EFrame & frame,
float zoomX,
float zoomY ) const

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,
const eVision::EFrame & frame,
float zoomX,
float zoomY,
float panX ) const

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,
const eVision::EFrame & frame,
float zoomX,
float zoomY,
float panX,
float panY ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
const eVision::EFrame & frame,
float zoomX ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
const eVision::EFrame & frame,
float zoomX,
float zoomY ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
const eVision::EFrame & frame,
float zoomX,
float zoomY,
float panX ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
const eVision::EFrame & frame,
float zoomX,
float zoomY,
float panX,
float panY ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
float zoomX ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
float zoomX,
float zoomY ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
float zoomX,
float zoomY,
float panX ) const

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,
const eVision::ERGBColor & xAxisColor,
const eVision::ERGBColor & yAxisColor,
float zoomX,
float zoomY,
float panX,
float panY ) const

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 ) const

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 ) const

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 ) const

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 ) const

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.

◆ GetAngle()

float eVision::EFrame::GetAngle ( ) const

Orientation of the frame.

◆ GetCameraCalibration()

std::unique_ptr< eVision::ECameraCalibration > eVision::EFrame::GetCameraCalibration ( ) const

Camera calibration of the frame.

◆ GetCenter()

eVision::EPoint eVision::EFrame::GetCenter ( ) const

Center coordinates of a EFrame object.

◆ GetCenterX()

float eVision::EFrame::GetCenterX ( ) const

Abscissa of the origin point of the frame.

◆ GetCenterY()

float eVision::EFrame::GetCenterY ( ) const

Ordinate of the origin point of the frame.

◆ GetDisplaySize()

float eVision::EFrame::GetDisplaySize ( ) const

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

The default value is

◆ GetEditionMode()

eVision::EEditionMode eVision::EFrame::GetEditionMode ( ) const

Graphical edition modes.

◆ GetScaleX()

float eVision::EFrame::GetScaleX ( ) const

Scale along the X axis.

◆ GetScaleY()

float eVision::EFrame::GetScaleY ( ) const

Scale along the Y axis.

◆ GetSensorAngle()

float eVision::EFrame::GetSensorAngle ( ) const

Orientation of the frame in the sensor frame.

◆ GetSensorCenter()

eVision::EPoint eVision::EFrame::GetSensorCenter ( ) const

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

◆ GetSensorCenterX()

float eVision::EFrame::GetSensorCenterX ( ) const

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

◆ GetSensorCenterY()

float eVision::EFrame::GetSensorCenterY ( ) const

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

◆ GetSensorScaleX()

float eVision::EFrame::GetSensorScaleX ( ) const

Scale along the X axis in the sensor frame at the EFrame::GetSensorCenter.

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.

◆ GetSensorScaleY()

float eVision::EFrame::GetSensorScaleY ( ) const

Scale along the Y axis in the sensor frame at the EFrame::GetSensorCenter.

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.

◆ 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,
const 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,
const 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,
const 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,
const 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,
const 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 ( ) const

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 ( ) const

Whether the EFrame::GetCameraCalibration 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 ( ) const

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 ( ) const

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

◆ IsEqual()

bool eVision::EFrame::IsEqual ( const eVision::EFrame & other) const

Compares this frame with the other.

Parameters
otherOther EFrame object.

◆ IsIdentity()

bool eVision::EFrame::IsIdentity ( ) const

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 ( ) const

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 ( ) const

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 ( ) const

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 ( ) const

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 ( const std::string & path)

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

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::EFrame::Load ( eVision::ESerializer * serializer)

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

Parameters
serializerThe serializer.

◆ LocalToSensor() [1/5]

eVision::EEllipse eVision::EFrame::LocalToSensor ( const eVision::ECircle & local) const

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [2/5]

eVision::EEllipse eVision::EFrame::LocalToSensor ( const eVision::EEllipse & local) const

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [3/5]

eVision::ELine eVision::EFrame::LocalToSensor ( const eVision::ELine & local) const

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [4/5]

eVision::EPoint eVision::EFrame::LocalToSensor ( const eVision::EPoint & local) const

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToSensor() [5/5]

eVision::EWedge eVision::EFrame::LocalToSensor ( const eVision::EWedge & local) const

Transforms a geometrical element from local to sensor coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [1/6]

eVision::EEllipse eVision::EFrame::LocalToWorld ( const eVision::ECircle & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [2/6]

eVision::EEllipse eVision::EFrame::LocalToWorld ( const eVision::EEllipse & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [3/6]

eVision::EFrame eVision::EFrame::LocalToWorld ( const eVision::EFrame & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [4/6]

eVision::ELine eVision::EFrame::LocalToWorld ( const eVision::ELine & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [5/6]

eVision::EPoint eVision::EFrame::LocalToWorld ( const eVision::EPoint & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorld() [6/6]

eVision::EPolygon eVision::EFrame::LocalToWorld ( const eVision::EPolygon & local) const

Transforms a geometrical element from local to world coordinates.

Parameters
localThe element, expressed in local coordinates.

◆ LocalToWorldIsotropic() [1/2]

eVision::ECircle eVision::EFrame::LocalToWorldIsotropic ( const eVision::ECircle & local) const

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 ( const eVision::EWedge & local) const

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

Parameters
localThe element, expressed in local coordinates.

◆ operator=()

eVision::EFrame & eVision::EFrame::operator= ( const eVision::EFrame & frame)

Copies all the data from another EFrame object into the current EFrame object.

Parameters
frameEFrame object to be copied.

◆ Save() [1/2]

void eVision::EFrame::Save ( const std::string & path)

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

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::EFrame::Save ( eVision::ESerializer * serializer)

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

Parameters
serializerThe serializer.

◆ SensorToLocal()

eVision::EPoint eVision::EFrame::SensorToLocal ( const eVision::EPoint & sensor) const

Transforms a geometrical element from sensor to local coordinates.

Parameters
sensorThe element, expressed in sensor coordinates.

◆ SensorToWorld()

eVision::EPoint eVision::EFrame::SensorToWorld ( const eVision::EPoint & sensor) const

Transforms a geometrical element from sensor to local coordinates.

Parameters
sensorThe element, expressed in sensor coordinates.

◆ SetAngle()

void eVision::EFrame::SetAngle ( float angle)

Orientation of the frame.

Parameters
angleRotation angle of the frame. The default value is 0.

◆ SetCameraCalibration()

void eVision::EFrame::SetCameraCalibration ( const eVision::ECameraCalibration & calibration)

Camera calibration of the frame.

◆ SetCenter()

void eVision::EFrame::SetCenter ( const eVision::EPoint & center)

Center coordinates of a EFrame object.

◆ SetCenterX()

void eVision::EFrame::SetCenterX ( float centerX)

Abscissa of the origin point of the frame.

Parameters
centerXX coordinate of the origin point of the frame

◆ SetCenterY()

void eVision::EFrame::SetCenterY ( float centerY)

Ordinate of the origin point of the frame.

Parameters
centerYY coordinate of the origin point of the frame

◆ SetDisplaySize()

void eVision::EFrame::SetDisplaySize ( float size)

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

The default value is

Parameters
sizeNew display size in world unit.

◆ SetEditionMode()

void eVision::EFrame::SetEditionMode ( eVision::EEditionMode mode)

Graphical edition modes.

Parameters
modeEEditionMode flags

◆ SetScaleX()

void eVision::EFrame::SetScaleX ( float scale)

Scale along the X axis.

Parameters
scaleNew value for the property.

◆ SetScaleY()

void eVision::EFrame::SetScaleY ( float scale)

Scale along the Y axis.

Parameters
scaleNew value for the property.

◆ WorldToLocal() [1/3]

eVision::EFrame eVision::EFrame::WorldToLocal ( const eVision::EFrame & world) const

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

◆ WorldToLocal() [2/3]

eVision::EPoint eVision::EFrame::WorldToLocal ( const eVision::EPoint & world) const

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

◆ WorldToLocal() [3/3]

eVision::EPolygon eVision::EFrame::WorldToLocal ( const eVision::EPolygon & world) const

Transforms a geometrical element from world to local coordinates.

Parameters
worldThe element, expressed in world coordinates.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EFrame::wrappedClass_