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...
#include <eVision/Easy/Legacy/EFrame.h>
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 (const eVision::EPoint ¢er, float angle, float scale) | |
| Constructs a EFrame object. | |
| EFrame (const eVision::Legacy::EFrame &frame) | |
| Constructs a EFrame object. | |
| virtual | ~EFrame () throw () |
| eVision::Legacy::EFrame & | operator= (const eVision::Legacy::EFrame &frame) |
| Copies all the data from another EFrame object into the current EFrame object. | |
| eVision::EPoint | operator+ (const eVision::EPoint &point) const |
| Returns the addition of the point to the center of the EFrame. | |
| eVision::EPoint | operator- (const eVision::EPoint &point) const |
| Returns the substraction of the center of the EFrame with the given point. | |
| eVision::EPoint | operator* (float scalar) const |
| Returns the multiplication of the center of the EFrame with the given multiplier. | |
| eVision::EPoint | operator/ (float scalar) const |
| Returns the division of the center of the EFrame with the given divisor. | |
| bool | operator== (const eVision::Legacy::EFrame &frame) const |
| Compares the current EFrame center coordinates with the center coordinates of another EFrame object. | |
| bool | operator!= (const eVision::Legacy::EFrame &frame) const |
| Compares the current EFrame center coordinates with the center coordinates of another EFrame object. | |
| void | CopyTo (eVision::Legacy::EFrame &other) const |
| Copies all the data from the current EFrame object into another EFrame object, and returns it. | |
| eVision::Legacy::EFrame * | CopyTo (eVision::Legacy::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. | |
| void | SetScale (float scale) |
| Horizontal sensor resolution, in pixels per unit. | |
| float | GetCenterX () const |
| Abscissa of the origin point of the frame. | |
| float | GetCenterY () const |
| Ordinate of the origin point of the frame. | |
| float | GetAngle () const |
| Orientation of the frame. | |
| float | GetScale () const |
| Horizontal sensor resolution, in pixels per unit. | |
| eVision::EPoint | LocalToGlobal (const eVision::EPoint &local) const |
| Transforms a geometrical element from local to global coordinates (local to world). | |
| eVision::Legacy::EFrame | LocalToGlobal (const eVision::Legacy::EFrame &local) const |
| Transforms a geometrical element from local to global coordinates (local to world). | |
| eVision::Legacy::ELine | LocalToGlobal (const eVision::Legacy::ELine &local) const |
| Transforms a geometrical element from local to global coordinates (local to world). | |
| eVision::Legacy::ECircle | LocalToGlobal (const eVision::Legacy::ECircle &local) const |
| Transforms a geometrical element from local to global coordinates (local to world). | |
| eVision::EPoint | GlobalToLocal (const eVision::EPoint &global) const |
| Transforms a geometrical element from global to local coordinates (world to local). | |
| eVision::Legacy::EFrame | GlobalToLocal (const eVision::Legacy::EFrame &global) const |
| Transforms a geometrical element from global to local coordinates (world to local). | |
| 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. | |
| virtual void | SetCenter (const eVision::EPoint ¢er) |
| Center coordinates of a EFrame object. | |
| virtual eVision::EPoint | GetCenter () const |
| Center. | |
| void | SetCenterXY (float centerX, float centerY) |
| Sets the center coordinates of a EFrame object. | |
| float | GetX () const |
| Abscissa (X coordinate) of the EFrame object. | |
| void | SetX (float value) |
| Abscissa (X coordinate) of the EFrame object. | |
| float | GetY () const |
| Ordinate (Y coordinate) of the EFrame object. | |
| void | SetY (float value) |
| Ordinate (Y coordinate) of the EFrame object. | |
| eVision::EPoint | MidPoint (const eVision::EPoint &Point) const |
| Returns the middle coordinate between this EFrame object's center and another EFrame object's center. | |
| eVision::EPoint | Rotate (float angle) const |
| Returns another EPoint object containing the coordinates of the rotated center point. | |
| float | Square () const |
| Compute the sum of the squared coordinates of the center of a EFrame. | |
| float | Modulus () const |
| Compute the euclidean modulus of the center of a EFrame. | |
| float | Argument () const |
| Compute the polar argument of the center of EFrame object. | |
| float | Dot (const eVision::EPoint &Point) const |
| Compute the dot product of the centers of two EFrame objects. | |
| float | Cross (const eVision::EPoint &Point) const |
| Compute the cross product of the centers of two EFrame objects. | |
| float | Area (const eVision::EPoint &Point) const |
| Compute the oriented area of the parallelogram built on the centers of two EFrame. | |
| eVision::EPoint | Project (const eVision::Legacy::ELine &shape) const |
| Compute the orthogonal projection of the center of a EFrame on another shape. | |
| eVision::EPoint | Project (const eVision::Legacy::ECircle &shape) const |
| Compute the orthogonal projection of the center of a EFrame on another shape. | |
| float | SquaredDistance (const eVision::EPoint &Point) const |
| Compute the squared distance between the centers of two EFrame. | |
| eVision::EPoint | Move (float angle, float distance) const |
| Return the position by moving the center along angle by distance. | |
| virtual float | Distance (const eVision::EPoint &point) const |
| Returns the distance between the addressed point and the center of EFrame object. | |
| virtual float | Distance (const eVision::Legacy::ELine &line, bool segmentOnly) const |
| Returns the distance between the addressed point and the center of EFrame object. | |
| virtual float | Distance (const eVision::Legacy::ELine &line) const |
| Returns the distance between the addressed point and the center of EFrame object. | |
| virtual float | Distance (const eVision::Legacy::ECircle &circle, bool arcOnly) const |
| Returns the distance between the addressed point and the center of EFrame object. | |
| virtual float | Distance (const eVision::Legacy::ECircle &circle) const |
| Returns the distance between the addressed point and the center of EFrame object. | |
| EFrame (CppWrapperInternal::InternalConstructor) | |
Public Attributes | |
| CppWrapperInternal::WrappedClass | wrappedClass_ |
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
| eVision::Legacy::EFrame::EFrame | ( | ) |
Constructs a EFrame object.
| eVision::Legacy::EFrame::EFrame | ( | float | centerX, |
| float | centerY, | ||
| float | angle, | ||
| float | scale ) |
Constructs a EFrame object.
| 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. |
| eVision::Legacy::EFrame::EFrame | ( | float | centerX, |
| float | centerY, | ||
| float | angle ) |
Constructs a EFrame object.
| centerX | Abscissa of the center point of the frame. |
| centerY | Ordinate of the center point of the frame. |
| angle | Orientation of the frame. |
| eVision::Legacy::EFrame::EFrame | ( | float | centerX, |
| float | centerY ) |
Constructs a EFrame object.
| centerX | Abscissa of the center point of the frame. |
| centerY | Ordinate of the center point of the frame. |
| eVision::Legacy::EFrame::EFrame | ( | const eVision::EPoint & | center, |
| float | angle, | ||
| float | scale ) |
Constructs a EFrame object.
| center | Coordinates of the center point of the frame. |
| angle | Orientation of the frame. |
| scale | Horizontal sensor resolution. |
| eVision::Legacy::EFrame::EFrame | ( | const eVision::Legacy::EFrame & | frame | ) |
|
virtual | ||||||||||||
| eVision::Legacy::EFrame::EFrame | ( | CppWrapperInternal::InternalConstructor | ) |
| float eVision::Legacy::EFrame::Area | ( | const eVision::EPoint & | Point | ) | const |
Compute the oriented area of the parallelogram built on the centers of two EFrame.
| 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).
| float eVision::Legacy::EFrame::Argument | ( | ) | const |
| void eVision::Legacy::EFrame::CopyTo | ( | eVision::Legacy::EFrame & | other | ) | const |
Copies all the data from the current EFrame object into another EFrame object, and returns it.
| 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.
| eVision::Legacy::EFrame * eVision::Legacy::EFrame::CopyTo | ( | eVision::Legacy::EFrame * | other | ) | const |
Copies all the data from the current EFrame object into another EFrame object, and returns it.
| 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.
Use the overload taking a reference.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| float eVision::Legacy::EFrame::Cross | ( | const eVision::EPoint & | Point | ) | const |
Compute the cross product of the centers of two EFrame objects.
| Point | Second factor of the cross product. |
|
virtual |
Returns the distance between the addressed point and the center of EFrame object.
| point | EPoint object with which to calculate the distance. |
Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge::SetCenter, 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.
|
virtual |
Returns the distance between the addressed point and the center of EFrame object.
| circle | ECircle object with which to calculate the distance. |
Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge::SetCenter, 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.
|
virtual |
Returns the distance between the addressed point and the center of EFrame object.
| 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::SetCenter, 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.
|
virtual |
Returns the distance between the addressed point and the center of EFrame object.
| line | ELine object with which to calculate the distance. |
Many EasyGauge members provide measurement result as a EPoint object (see EPointGauge::SetCenter, 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.
|
virtual |
Returns the distance between the addressed point and the center of EFrame object.
| 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::SetCenter, 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.
| float eVision::Legacy::EFrame::Dot | ( | const eVision::EPoint & | Point | ) | const |
Compute the dot product of the centers of two EFrame objects.
| Point | Second factor of the dot product. |
| float eVision::Legacy::EFrame::GetAngle | ( | ) | const |
Orientation of the frame.
|
virtual |
Center.
| float eVision::Legacy::EFrame::GetCenterX | ( | ) | const |
Abscissa of the origin point of the frame.
| float eVision::Legacy::EFrame::GetCenterY | ( | ) | const |
Ordinate of the origin point of the frame.
| float eVision::Legacy::EFrame::GetScale | ( | ) | const |
Horizontal sensor resolution, in pixels per unit.
| float eVision::Legacy::EFrame::GetX | ( | ) | const |
Abscissa (X coordinate) of the EFrame object.
| float eVision::Legacy::EFrame::GetY | ( | ) | const |
Ordinate (Y coordinate) of the EFrame object.
| eVision::EPoint eVision::Legacy::EFrame::GlobalToLocal | ( | const eVision::EPoint & | global | ) | const |
Transforms a geometrical element from global to local coordinates (world to local).
| global | The element, expressed in global coordinates. |
| eVision::Legacy::EFrame eVision::Legacy::EFrame::GlobalToLocal | ( | const eVision::Legacy::EFrame & | global | ) | const |
Transforms a geometrical element from global to local coordinates (world to local).
| global | The element, expressed in global coordinates. |
| void eVision::Legacy::EFrame::Load | ( | const std::string & | path | ) |
Load the EFrame configuration. The given ESerializer must have been created for reading.
| path | The file path. |
| void eVision::Legacy::EFrame::Load | ( | eVision::ESerializer * | serializer | ) |
Load the EFrame configuration. The given ESerializer must have been created for reading.
| serializer | The serializer. |
| eVision::EPoint eVision::Legacy::EFrame::LocalToGlobal | ( | const eVision::EPoint & | local | ) | const |
Transforms a geometrical element from local to global coordinates (local to world).
| local | The element, expressed in local coordinates. |
| eVision::Legacy::ECircle eVision::Legacy::EFrame::LocalToGlobal | ( | const eVision::Legacy::ECircle & | local | ) | const |
Transforms a geometrical element from local to global coordinates (local to world).
| local | The element, expressed in local coordinates. |
| eVision::Legacy::EFrame eVision::Legacy::EFrame::LocalToGlobal | ( | const eVision::Legacy::EFrame & | local | ) | const |
Transforms a geometrical element from local to global coordinates (local to world).
| local | The element, expressed in local coordinates. |
| eVision::Legacy::ELine eVision::Legacy::EFrame::LocalToGlobal | ( | const eVision::Legacy::ELine & | local | ) | const |
Transforms a geometrical element from local to global coordinates (local to world).
| local | The element, expressed in local coordinates. |
| eVision::EPoint eVision::Legacy::EFrame::MidPoint | ( | const eVision::EPoint & | Point | ) | const |
| float eVision::Legacy::EFrame::Modulus | ( | ) | const |
| eVision::EPoint eVision::Legacy::EFrame::Move | ( | float | angle, |
| float | distance ) const |
Return the position by moving the center along angle by distance.
| angle | The direction of the displacement, in radians. |
| distance | The distance of the displacement. |
| bool eVision::Legacy::EFrame::operator!= | ( | const eVision::Legacy::EFrame & | frame | ) | const |
Compares the current EFrame center coordinates with the center coordinates of another EFrame object.
| frame | The other EFrame object. |
Returns true if EFrame::GetX or EFrame::GetY are respectively different.
Compare EFrame::SetCenter instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::EPoint eVision::Legacy::EFrame::operator* | ( | float | scalar | ) | const |
Returns the multiplication of the center of the EFrame with the given multiplier.
| scalar | The multiplier. |
Use EFrame::SetCenter * scalar instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::EPoint eVision::Legacy::EFrame::operator+ | ( | const eVision::EPoint & | point | ) | const |
Returns the addition of the point to the center of the EFrame.
| point | A point. |
Use EFrame::SetCenter + point instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::EPoint eVision::Legacy::EFrame::operator- | ( | const eVision::EPoint & | point | ) | const |
Returns the substraction of the center of the EFrame with the given point.
| point | A point. |
Use EFrame::SetCenter - point instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::EPoint eVision::Legacy::EFrame::operator/ | ( | float | scalar | ) | const |
Returns the division of the center of the EFrame with the given divisor.
| scalar | The divisor. |
Use EFrame::SetCenter / scalar instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::Legacy::EFrame & eVision::Legacy::EFrame::operator= | ( | const eVision::Legacy::EFrame & | frame | ) |
| bool eVision::Legacy::EFrame::operator== | ( | const eVision::Legacy::EFrame & | frame | ) | const |
Compares the current EFrame center coordinates with the center coordinates of another EFrame object.
| frame | The other EFrame object. |
Returns true if both EFrame::GetX and EFrame::GetY are respectively the same.
Compare EFrame::SetCenter instead.
Deprecated in version 25.10. Scheduled to be removed in version 27.6.
| eVision::EPoint eVision::Legacy::EFrame::Project | ( | const eVision::Legacy::ECircle & | shape | ) | const |
| eVision::EPoint eVision::Legacy::EFrame::Project | ( | const eVision::Legacy::ELine & | shape | ) | const |
| eVision::EPoint eVision::Legacy::EFrame::Rotate | ( | float | angle | ) | const |
Returns another EPoint object containing the coordinates of the rotated center point.
| 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).
| void eVision::Legacy::EFrame::Save | ( | const std::string & | path | ) |
Save the EFrame configuration. The given ESerializer must have been created for writing.
| path | The file path. |
| void eVision::Legacy::EFrame::Save | ( | eVision::ESerializer * | serializer | ) |
Save the EFrame configuration. The given ESerializer must have been created for writing.
| serializer | The serializer. |
| void eVision::Legacy::EFrame::SetAngle | ( | float | angle | ) |
Orientation of the frame.
| angle | Rotation angle of the frame. The default value is 0. |
|
virtual |
Center coordinates of a EFrame object.
| void eVision::Legacy::EFrame::SetCenterXY | ( | float | centerX, |
| float | centerY ) |
Sets the center coordinates of a EFrame object.
| centerX | Center coordinates of the origin. |
| centerY | Center coordinates of the origin. |
| void eVision::Legacy::EFrame::SetScale | ( | float | scale | ) |
Horizontal sensor resolution, in pixels per unit.
| scale | New value for the property. |
| void eVision::Legacy::EFrame::SetX | ( | float | value | ) |
Abscissa (X coordinate) of the EFrame object.
| void eVision::Legacy::EFrame::SetY | ( | float | value | ) |
Ordinate (Y coordinate) of the EFrame object.
| float eVision::Legacy::EFrame::Square | ( | ) | const |
| float eVision::Legacy::EFrame::SquaredDistance | ( | const eVision::EPoint & | Point | ) | const |
| CppWrapperInternal::WrappedClass eVision::Legacy::EFrame::wrappedClass_ |