Represents a geometrical frame of reference as well as the parameters needed to transform from/to local and global coordinates. It contains a point and an angle and serves as a base class for geometrical elements. More...

Inheritance diagram for eVision.Legacy.EFrame:

[legend]

Collaboration diagram for eVision.Legacy.EFrame:

[legend]

Public Member Functions
	EFrame ()
	Constructs a EFrame object.
	EFrame (float centerX, float centerY, float angle, float scale)
	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 (eVision.EPoint center, float angle, float scale)
	Constructs a EFrame object.
	EFrame (eVision.Legacy.EFrame frame)
	Constructs a EFrame object.
void	CopyTo (eVision.Legacy.EFrame other)
	Copies all the data from the current EFrame object into another EFrame object, and returns it.
eVision.EPoint	LocalToGlobal (eVision.EPoint local)
	Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.EFrame	LocalToGlobal (eVision.Legacy.EFrame local)
	Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.ELine	LocalToGlobal (eVision.Legacy.ELine local)
	Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.ECircle	LocalToGlobal (eVision.Legacy.ECircle local)
	Transforms a geometrical element from local to global coordinates (local to world).
eVision.EPoint	GlobalToLocal (eVision.EPoint global)
	Transforms a geometrical element from global to local coordinates (world to local).
eVision.Legacy.EFrame	GlobalToLocal (eVision.Legacy.EFrame global)
	Transforms a geometrical element from global to local coordinates (world to local).
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.
void	SetCenterXY (float centerX, float centerY)
	Sets the center coordinates of a EFrame object.
eVision.EPoint	MidPoint (eVision.EPoint Point)
	Returns the middle coordinate between this EFrame object's center and another EFrame object's center.
eVision.EPoint	Rotate (float angle)
	Returns another EPoint object containing the coordinates of the rotated center point.
float	Square ()
	Compute the sum of the squared coordinates of the center of a EFrame.
float	Modulus ()
	Compute the euclidean modulus of the center of a EFrame.
float	Argument ()
	Compute the polar argument of the center of EFrame object.
float	Dot (eVision.EPoint Point)
	Compute the dot product of the centers of two EFrame objects.
float	Cross (eVision.EPoint Point)
	Compute the cross product of the centers of two EFrame objects.
float	Area (eVision.EPoint Point)
	Compute the oriented area of the parallelogram built on the centers of two EFrame.
eVision.EPoint	Project (eVision.Legacy.ELine shape)
	Compute the orthogonal projection of the center of a EFrame on another shape.
eVision.EPoint	Project (eVision.Legacy.ECircle shape)
	Compute the orthogonal projection of the center of a EFrame on another shape.
float	SquaredDistance (eVision.EPoint Point)
	Compute the squared distance between the centers of two EFrame.
eVision.EPoint	Move (float angle, float distance)
	Return the position by moving the center along angle by distance.
virtual float	Distance (eVision.EPoint point)
	Returns the distance between the addressed point and the center of EFrame object.
virtual float	Distance (eVision.Legacy.ELine line, bool segmentOnly)
	Returns the distance between the addressed point and the center of EFrame object.
virtual float	Distance (eVision.Legacy.ELine line)
	Returns the distance between the addressed point and the center of EFrame object.
virtual float	Distance (eVision.Legacy.ECircle circle, bool arcOnly)
	Returns the distance between the addressed point and the center of EFrame object.
virtual float	Distance (eVision.Legacy.ECircle circle)
	Returns the distance between the addressed point and the center of EFrame object.

Static Public Member Functions
static eVision.EPoint	operator+ (eVision.Legacy.EFrame extraArgument, eVision.EPoint point)
	Returns the addition of the point to the center of the EFrame.
static eVision.EPoint	operator- (eVision.Legacy.EFrame extraArgument, eVision.EPoint point)
	Returns the substraction of the center of the EFrame with the given point.
static eVision.EPoint	operator* (eVision.Legacy.EFrame extraArgument, float scalar)
	Returns the multiplication of the center of the EFrame with the given multiplier.
static eVision.EPoint	operator/ (eVision.Legacy.EFrame extraArgument, float scalar)
	Returns the division of the center of the EFrame with the given divisor.

Properties
float	Angle `[get, set]`
	Orientation of the frame.
float	Scale `[get, set]`
	Horizontal sensor resolution, in pixels per unit.
float	CenterX `[get]`
	Abscissa of the origin point of the frame.
float	CenterY `[get]`
	Ordinate of the origin point of the frame.
virtual eVision.EPoint	Center `[get, set]`
	Center.
float	X `[get, set]`
	Abscissa (X coordinate) of the EFrame object.
float	Y `[get, set]`
	Ordinate (Y coordinate) of the EFrame object.

Detailed Description

Represents a geometrical frame of reference as well as the parameters needed to transform from/to local and global coordinates. It contains a point and an angle and serves as a base class for geometrical elements.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EFrame() [1/6]

eVision.Legacy.EFrame.EFrame ( )

Constructs a EFrame object.

◆ EFrame() [2/6]

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

Constructs a EFrame object.

Parameters

centerX	Abscissa of the center point of the frame.
centerY	Ordinate of the center point of the frame.
angle	Orientation of the frame.
scale	Horizontal sensor resolution.

◆ EFrame() [3/6]

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

Constructs a EFrame object.

Parameters

centerX	Abscissa of the center point of the frame.
centerY	Ordinate of the center point of the frame.
angle	Orientation of the frame.

◆ EFrame() [4/6]

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

Constructs a EFrame object.

Parameters

centerX	Abscissa of the center point of the frame.
centerY	Ordinate of the center point of the frame.

◆ EFrame() [5/6]

eVision.Legacy.EFrame.EFrame	(	eVision.EPoint	center,
		float	angle,
		float	scale )

Constructs a EFrame object.

Parameters

center	Coordinates of the center point of the frame.
angle	Orientation of the frame.
scale	Horizontal sensor resolution.

◆ EFrame() [6/6]

eVision.Legacy.EFrame.EFrame ( eVision.Legacy.EFrame frame )

Constructs a EFrame object.

Parameters

frame Pre-existing EFrame object used by the copy constructor.

Member Function Documentation

◆ Area()

float eVision.Legacy.EFrame.Area ( eVision.EPoint Point )

Compute the oriented area of the parallelogram built on the centers of two EFrame.

Parameters

Point Second edge of the parallelogram.

Compute the oriented area of the parallelogram built on the center of two EFrame. The area is counted as positive if the oriented vector pair ('first edge', 'second edge') is in the same sense that the axis frame. This oriented area can also be viewed as the z-coordinate of a vector product of two 3D vectors obtained in supplementing each edges with a third z-coordinate (set to zero).

◆ Argument()

float eVision.Legacy.EFrame.Argument ( )

Compute the polar argument of the center of EFrame object.

Compute the angle (in radians) between the oriented X-axis and the vector going from the axis origin and the EFrame. If the axis frame is orthogonal, this number is also the polar argument of the EFrame.

◆ CopyTo()

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

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

Parameters

other Pointer 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.

◆ Cross()

float eVision.Legacy.EFrame.Cross ( eVision.EPoint Point )

Compute the cross product of the centers of two EFrame objects.

Parameters

Point Second factor of the cross product.

◆ Distance() [1/5]

virtual float eVision.Legacy.EFrame.Distance ( eVision.EPoint point )

virtual

Returns the distance between the addressed point and the center of EFrame object.

Parameters

point EPoint object with which to calculate the distance.

Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge.Center, EPointGauge.GetMeasuredPoint,...). The EFrame class has its own members to retrieve all the information pertaining to a point. Among them, the Distance method returns the distance between a point pair or between a point and a line segment, a circle arc or a rectangle.

◆ Distance() [2/5]

virtual float eVision.Legacy.EFrame.Distance ( eVision.Legacy.ECircle circle )

virtual

Returns the distance between the addressed point and the center of EFrame object.

Parameters

circle ECircle object with which to calculate the distance.

Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge.Center, EPointGauge.GetMeasuredPoint,...). The EFrame class has its own members to retrieve all the information pertaining to a point. Among them, the Distance method returns the distance between a point pair or between a point and a line segment, a circle arc or a rectangle.

Reimplemented in eVision.Legacy.ECircle.

◆ Distance() [3/5]

virtual float eVision.Legacy.EFrame.Distance	(	eVision.Legacy.ECircle	circle,
		bool	arcOnly )

virtual

Returns the distance between the addressed point and the center of EFrame object.

Parameters

circle	ECircle object with which to calculate the distance.
arcOnly	By default (false), the circle is not restricted to an arc.

Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge.Center, EPointGauge.GetMeasuredPoint,...). The EFrame class has its own members to retrieve all the information pertaining to a point. Among them, the Distance method returns the distance between a point pair or between a point and a line segment, a circle arc or a rectangle.

◆ Distance() [4/5]

virtual float eVision.Legacy.EFrame.Distance ( eVision.Legacy.ELine line )

virtual

Returns the distance between the addressed point and the center of EFrame object.

Parameters

line	ELine object with which to calculate the distance.

Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge.Center, EPointGauge.GetMeasuredPoint,...). The EFrame class has its own members to retrieve all the information pertaining to a point. Among them, the Distance method returns the distance between a point pair or between a point and a line segment, a circle arc or a rectangle.

◆ Distance() [5/5]

virtual float eVision.Legacy.EFrame.Distance	(	eVision.Legacy.ELine	line,
		bool	segmentOnly )

virtual

Returns the distance between the addressed point and the center of EFrame object.

Parameters

line	ELine object with which to calculate the distance.
segmentOnly	By default (false), the line is not restricted to a segment.

Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge.Center, EPointGauge.GetMeasuredPoint,...). The EFrame class has its own members to retrieve all the information pertaining to a point. Among them, the Distance method returns the distance between a point pair or between a point and a line segment, a circle arc or a rectangle.

◆ Dot()

float eVision.Legacy.EFrame.Dot ( eVision.EPoint Point )

Compute the dot product of the centers of two EFrame objects.

Parameters

Point Second factor of the dot product.

◆ GlobalToLocal() [1/2]

eVision.EPoint eVision.Legacy.EFrame.GlobalToLocal ( eVision.EPoint global )

Transforms a geometrical element from global to local coordinates (world to local).

Parameters

global The element, expressed in global coordinates.

◆ GlobalToLocal() [2/2]

eVision.Legacy.EFrame eVision.Legacy.EFrame.GlobalToLocal ( eVision.Legacy.EFrame global )

Transforms a geometrical element from global to local coordinates (world to local).

Parameters

global The element, expressed in global coordinates.

◆ Load() [1/2]

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

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

Parameters

serializer The serializer.

◆ Load() [2/2]

void eVision.Legacy.EFrame.Load ( string path )

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

Parameters

path	The file path.

◆ LocalToGlobal() [1/4]

eVision.EPoint eVision.Legacy.EFrame.LocalToGlobal ( eVision.EPoint local )

Transforms a geometrical element from local to global coordinates (local to world).

Parameters

local The element, expressed in local coordinates.

◆ LocalToGlobal() [2/4]

eVision.Legacy.ECircle eVision.Legacy.EFrame.LocalToGlobal ( eVision.Legacy.ECircle local )

Transforms a geometrical element from local to global coordinates (local to world).

Parameters

local The element, expressed in local coordinates.

◆ LocalToGlobal() [3/4]

eVision.Legacy.EFrame eVision.Legacy.EFrame.LocalToGlobal ( eVision.Legacy.EFrame local )

Transforms a geometrical element from local to global coordinates (local to world).

Parameters

local The element, expressed in local coordinates.

◆ LocalToGlobal() [4/4]

eVision.Legacy.ELine eVision.Legacy.EFrame.LocalToGlobal ( eVision.Legacy.ELine local )

Transforms a geometrical element from local to global coordinates (local to world).

Parameters

local The element, expressed in local coordinates.

◆ MidPoint()

eVision.EPoint eVision.Legacy.EFrame.MidPoint ( eVision.EPoint Point )

Returns the middle coordinate between this EFrame object's center and another EFrame object's center.

Parameters

Point The other point.

◆ Modulus()

float eVision.Legacy.EFrame.Modulus ( )

Compute the euclidean modulus of the center of a EFrame.

Compute the squared root of the sum of the squared coordinates of an EFrame. If the axis frame is orthogonal, this number is also the euclidean norm of the EFrame.

◆ Move()

eVision.EPoint eVision.Legacy.EFrame.Move	(	float	angle,
		float	distance )

Return the position by moving the center along angle by distance.

Parameters

angle	The direction of the displacement, in radians.
distance	The distance of the displacement.

◆ operator*()

eVision.EPoint eVision.Legacy.EFrame.operator*	(	eVision.Legacy.EFrame	extraArgument,
		float	scalar )

static

Returns the multiplication of the center of the EFrame with the given multiplier.

Parameters

scalar The multiplier.

Deprecated

Use EFrame.Center * scalar instead.

Deprecated in version 25.10. Scheduled to be removed in version 27.6.

◆ operator+()

eVision.EPoint eVision.Legacy.EFrame.operator+	(	eVision.Legacy.EFrame	extraArgument,
		eVision.EPoint	point )

static

Returns the addition of the point to the center of the EFrame.

Parameters

point A point.

Deprecated

Use EFrame.Center + point instead.

Deprecated in version 25.10. Scheduled to be removed in version 27.6.

◆ operator-()

eVision.EPoint eVision.Legacy.EFrame.operator-	(	eVision.Legacy.EFrame	extraArgument,
		eVision.EPoint	point )

static

Returns the substraction of the center of the EFrame with the given point.

Parameters

point A point.

Deprecated

Use EFrame.Center - point instead.

Deprecated in version 25.10. Scheduled to be removed in version 27.6.

◆ operator/()

eVision.EPoint eVision.Legacy.EFrame.operator/	(	eVision.Legacy.EFrame	extraArgument,
		float	scalar )

static

Returns the division of the center of the EFrame with the given divisor.

Parameters

scalar The divisor.

Deprecated

Use EFrame.Center / scalar instead.

Deprecated in version 25.10. Scheduled to be removed in version 27.6.

◆ Project() [1/2]

eVision.EPoint eVision.Legacy.EFrame.Project ( eVision.Legacy.ECircle shape )

Compute the orthogonal projection of the center of a EFrame on another shape.

Parameters

shape Shape object to which point is projected

Compute the orthogonal projection of a EFrame on another shape. This computation is only valid when the axis frame is orthogonal.

◆ Project() [2/2]

eVision.EPoint eVision.Legacy.EFrame.Project ( eVision.Legacy.ELine shape )

Compute the orthogonal projection of the center of a EFrame on another shape.

Parameters

shape Shape object to which point is projected

Compute the orthogonal projection of a EFrame on another shape. This computation is only valid when the axis frame is orthogonal.

◆ Rotate()

eVision.EPoint eVision.Legacy.EFrame.Rotate ( float angle )

Returns another EPoint object containing the coordinates of the rotated center point.

Parameters

angle Rotation angle (in radians)

Rotates a EFrame around the origin (0, 0) by an angle of angle radians. By definition, the smallest (in absolute value) rotation of the oriented X-Axis toward the oriented Y-Axis is chosen as the positive sense of rotation. In a direct frame, this is also the trigonometric sense (counter clockwise).

◆ Save() [1/2]

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

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

Parameters

serializer The serializer.

◆ Save() [2/2]

void eVision.Legacy.EFrame.Save ( string path )

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

Parameters

path	The file path.

◆ SetCenterXY()

void eVision.Legacy.EFrame.SetCenterXY	(	float	centerX,
		float	centerY )

Sets the center coordinates of a EFrame object.

Parameters

centerX	Center coordinates of the origin.
centerY	Center coordinates of the origin.

◆ Square()

float eVision.Legacy.EFrame.Square ( )

Compute the sum of the squared coordinates of the center of a EFrame.

Compute the sum of the squared coordinates of a EFrame. If the axis frame is orthogonal, this sum of squares is also the squared euclidean norm of the EFrame object.

◆ SquaredDistance()

float eVision.Legacy.EFrame.SquaredDistance ( eVision.EPoint Point )

Compute the squared distance between the centers of two EFrame.

Parameters

Point Second EFrame.

Compute the sum of squared coordinates differences of two EFrame. If the axis frame is orthogonal, this number is also the squared euclidean distance between two EFrame.

Property Documentation

◆ Angle

float eVision.Legacy.EFrame.Angle

getset

Orientation of the frame.

◆ Center

virtual eVision.EPoint eVision.Legacy.EFrame.Center

getset

Center.

◆ CenterX

float eVision.Legacy.EFrame.CenterX

get

Abscissa of the origin point of the frame.

◆ CenterY

float eVision.Legacy.EFrame.CenterY

get

Ordinate of the origin point of the frame.

◆ Scale

float eVision.Legacy.EFrame.Scale

getset

Horizontal sensor resolution, in pixels per unit.

◆ X

float eVision.Legacy.EFrame.X

getset

Abscissa (X coordinate) of the EFrame object.

◆ Y

float eVision.Legacy.EFrame.Y

getset

Ordinate (Y coordinate) of the EFrame object.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EFrame() [1/6]

◆ EFrame() [2/6]

◆ EFrame() [3/6]

◆ EFrame() [4/6]

◆ EFrame() [5/6]

◆ EFrame() [6/6]

Member Function Documentation

◆ Area()

◆ Argument()

◆ CopyTo()

◆ Cross()

◆ Distance() [1/5]

◆ Distance() [2/5]

◆ Distance() [3/5]

◆ Distance() [4/5]

◆ Distance() [5/5]

◆ Dot()

◆ GlobalToLocal() [1/2]

◆ GlobalToLocal() [2/2]

◆ Load() [1/2]

◆ Load() [2/2]

◆ LocalToGlobal() [1/4]

◆ LocalToGlobal() [2/4]

◆ LocalToGlobal() [3/4]

◆ LocalToGlobal() [4/4]

◆ MidPoint()

◆ Modulus()

◆ Move()

◆ operator*()

◆ operator+()

◆ operator-()

◆ operator/()

◆ Project() [1/2]

◆ Project() [2/2]

◆ Rotate()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetCenterXY()

◆ Square()

◆ SquaredDistance()

Property Documentation

◆ Angle

◆ Center

◆ CenterX

◆ CenterY

◆ Scale

◆ X

◆ Y