eVision Python API
Loading...
Searching...
No Matches
eVision.Legacy.ERectangle Class Reference

Represents a model of a rectangle. More...

Inheritance diagram for eVision.Legacy.ERectangle:
Collaboration diagram for eVision.Legacy.ERectangle:

Public Member Functions

None __init__ (self)
 Constructs a eVision.Legacy.ERectangle.
None __init__ (self, eVision.EPoint center, float sizeX, float sizeY, float angle)
 Constructs a eVision.Legacy.ERectangle.
None __init__ (self, eVision.EPoint center, float sizeX, float sizeY)
 Constructs a eVision.Legacy.ERectangle.
None __init__ (self, eVision.EPoint origin, eVision.EPoint end)
 Constructs a eVision.Legacy.ERectangle.
None __init__ (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end)
 Constructs a eVision.Legacy.ERectangle.
None __init__ (self, eVision.Legacy.ERectangle other)
 Constructs a eVision.Legacy.ERectangle.
None CopyTo (self, eVision.Legacy.ERectangle other)
 Copies all the data of the current eVision.Legacy.ERectangle object into another eVision.Legacy.ERectangle object, and returns it.
None SetFromOppositeCorners (self, eVision.EPoint origin, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.
None SetFromThreeCorners (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.
None SetFromTwoPoints (self, eVision.EPoint origin, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.
None SetFromOriginMiddleEnd (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end)
 Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.
None SetSize (self, float sizeX, float sizeY)
 Sets the size of a eVision.Legacy.ERectangle object.
eVision.EPoint GetPoint (self, float fractionX, float fractionY)
 Returns the coordinates of a particular point, specified by its location in the eVision.Legacy.ERectangle area.
None GetMidEdges (self, eVision.EPoint x, eVision.EPoint XX, eVision.EPoint y, eVision.EPoint YY)
 Retrieves the center coordinates of each edge of a eVision.Legacy.ERectangle object.
None GetCorners (self, eVision.EPoint xy, eVision.EPoint XXy, eVision.EPoint xYY, eVision.EPoint XXYY)
 Retrieves the coordinates of each corner of a eVision.Legacy.ERectangle object.
None GetEdges (self, eVision.Legacy.ELine x, eVision.Legacy.ELine XX, eVision.Legacy.ELine y, eVision.Legacy.ELine YY)
 Retrieves each edge of a eVision.Legacy.ERectangle object.
float SizeX (self)
 X size of the eVision.Legacy.ERectangle.
float SizeY (self)
 Y size of the eVision.Legacy.ERectangle.
Public Member Functions inherited from eVision.Legacy.EFrame
None __init__ (self)
 Constructs a eVision.Legacy.EFrame object.
None __init__ (self, float centerX, float centerY, float angle, float scale)
 Constructs a eVision.Legacy.EFrame object.
None __init__ (self, float centerX, float centerY, float angle)
 Constructs a eVision.Legacy.EFrame object.
None __init__ (self, float centerX, float centerY)
 Constructs a eVision.Legacy.EFrame object.
None __init__ (self, eVision.EPoint center, float angle, float scale)
 Constructs a eVision.Legacy.EFrame object.
None __init__ (self, eVision.Legacy.EFrame frame)
 Constructs a eVision.Legacy.EFrame object.
eVision.EPoint LocalToGlobal (self, eVision.EPoint local)
 Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.ELine LocalToGlobal (self, eVision.Legacy.ELine local)
 Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.ECircle LocalToGlobal (self, eVision.Legacy.ECircle local)
 Transforms a geometrical element from local to global coordinates (local to world).
eVision.Legacy.EFrame LocalToGlobal (self, eVision.Legacy.EFrame local)
 Transforms a geometrical element from local to global coordinates (local to world).
eVision.EPoint GlobalToLocal (self, eVision.EPoint global_)
 Transforms a geometrical element from global to local coordinates (world to local).
eVision.Legacy.EFrame GlobalToLocal (self, eVision.Legacy.EFrame global_)
 Transforms a geometrical element from global to local coordinates (world to local).
None Load (self, str path)
 Load the eVision.Legacy.EFrame configuration.
None Load (self, eVision.ESerializer|None serializer)
 Load the eVision.Legacy.EFrame configuration.
None Save (self, str path)
 Save the eVision.Legacy.EFrame configuration.
None Save (self, eVision.ESerializer|None serializer)
 Save the eVision.Legacy.EFrame configuration.
None SetCenterXY (self, float centerX, float centerY)
 Sets the center coordinates of a eVision.Legacy.EFrame object.
eVision.EPoint MidPoint (self, eVision.EPoint Point)
 Returns the middle coordinate between this eVision.Legacy.EFrame object's center and another eVision.Legacy.EFrame object's center.
eVision.EPoint Rotate (self, float angle)
 Returns another eVision.EPoint object containing the coordinates of the rotated center point.
float Square (self)
 Compute the sum of the squared coordinates of the center of a eVision.Legacy.EFrame.
float Modulus (self)
 Compute the euclidean modulus of the center of a eVision.Legacy.EFrame.
float Argument (self)
 Compute the polar argument of the center of eVision.Legacy.EFrame object.
float Dot (self, eVision.EPoint Point)
 Compute the dot product of the centers of two eVision.Legacy.EFrame objects.
float Cross (self, eVision.EPoint Point)
 Compute the cross product of the centers of two eVision.Legacy.EFrame objects.
float Area (self, eVision.EPoint Point)
 Compute the oriented area of the parallelogram built on the centers of two eVision.Legacy.EFrame.
eVision.EPoint Project (self, eVision.Legacy.ELine shape)
 Compute the orthogonal projection of the center of a eVision.Legacy.EFrame on another shape.
eVision.EPoint Project (self, eVision.Legacy.ECircle shape)
 Compute the orthogonal projection of the center of a eVision.Legacy.EFrame on another shape.
float SquaredDistance (self, eVision.EPoint Point)
 Compute the squared distance between the centers of two eVision.Legacy.EFrame.
eVision.EPoint Move (self, float angle, float distance)
 Return the position by moving the center along angle by distance.
float Distance (self, eVision.EPoint point)
 Returns the distance between the addressed point and the center of eVision.Legacy.EFrame object.
float Distance (self, eVision.Legacy.ELine line, bool segmentOnly)
 Returns the distance between the addressed point and the center of eVision.Legacy.EFrame object.
float Distance (self, eVision.Legacy.ELine line)
 Returns the distance between the addressed point and the center of eVision.Legacy.EFrame object.
float Distance (self, eVision.Legacy.ECircle circle, bool arcOnly)
 Returns the distance between the addressed point and the center of eVision.Legacy.EFrame object.
float Distance (self, eVision.Legacy.ECircle circle)
 Returns the distance between the addressed point and the center of eVision.Legacy.EFrame object.
float Angle (self)
 Orientation of the frame.
 Angle (self, float value)
 Orientation of the frame.
float Scale (self)
 Horizontal sensor resolution, in pixels per unit.
 Scale (self, float value)
 Horizontal sensor resolution, in pixels per unit.
float CenterX (self)
 Abscissa of the origin point of the frame.
float CenterY (self)
 Ordinate of the origin point of the frame.
eVision.EPoint Center (self)
 Center.
 Center (self, eVision.EPoint value)
 Center.
float X (self)
 Abscissa (X coordinate) of the eVision.Legacy.EFrame object.
 X (self, float value)
 Abscissa (X coordinate) of the eVision.Legacy.EFrame object.
float Y (self)
 Ordinate (Y coordinate) of the eVision.Legacy.EFrame object.
 Y (self, float value)
 Ordinate (Y coordinate) of the eVision.Legacy.EFrame object.

Detailed Description

Represents a model of a rectangle.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/6]

None eVision.Legacy.ERectangle.__init__ ( self)

◆ __init__() [2/6]

None eVision.Legacy.ERectangle.__init__ ( self,
eVision.EPoint center,
float sizeX,
float sizeY,
float angle )

Constructs a eVision.Legacy.ERectangle.

Parameters
centerCenter coordinates of the rectangle at its nominal position. The default value is (0,0).
sizeXNominal size X/Y of the rectangle. Both default values are 100.
sizeYNominal size X/Y of the rectangle. Both default values are 100.
angleNominal rotation angle of the rectangle. The default value is 0.

◆ __init__() [3/6]

None eVision.Legacy.ERectangle.__init__ ( self,
eVision.EPoint center,
float sizeX,
float sizeY )

Constructs a eVision.Legacy.ERectangle.

Parameters
centerCenter coordinates of the rectangle at its nominal position. The default value is (0,0).
sizeXNominal size X/Y of the rectangle. Both default values are 100.
sizeYNominal size X/Y of the rectangle. Both default values are 100.

◆ __init__() [4/6]

None eVision.Legacy.ERectangle.__init__ ( self,
eVision.EPoint origin,
eVision.EPoint end )

Constructs a eVision.Legacy.ERectangle.

Parameters
originUpper left point coordinates of the rectangle.
endLower right point coordinates of the rectangle.

◆ __init__() [5/6]

None eVision.Legacy.ERectangle.__init__ ( self,
eVision.EPoint origin,
eVision.EPoint middle,
eVision.EPoint end )

Constructs a eVision.Legacy.ERectangle.

Parameters
originUpper left point coordinates of the rectangle.
middleA third corner point coordinates.
endLower right point coordinates of the rectangle.

◆ __init__() [6/6]

None eVision.Legacy.ERectangle.__init__ ( self,
eVision.Legacy.ERectangle other )

Constructs a eVision.Legacy.ERectangle.

Parameters
otherAnother eVision.Legacy.ERectangle object to be copied in the new eVision.Legacy.ERectangle object.

Member Function Documentation

◆ CopyTo()

None eVision.Legacy.ERectangle.CopyTo ( self,
eVision.Legacy.ERectangle other )

Copies all the data of the current eVision.Legacy.ERectangle object into another eVision.Legacy.ERectangle object, and returns it.

Remarks:

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

Parameters
otherPointer to the eVision.Legacy.ERectangle object in which the current eVision.Legacy.ERectangle object data have to be copied.

Reimplemented from eVision.Legacy.EFrame.

◆ GetCorners()

None eVision.Legacy.ERectangle.GetCorners ( self,
eVision.EPoint xy,
eVision.EPoint XXy,
eVision.EPoint xYY,
eVision.EPoint XXYY )

Retrieves the coordinates of each corner of a eVision.Legacy.ERectangle object.

Parameters
xyCoordinates of the lower leftmost corner of the eVision.Legacy.ERectangle object.
XXyCoordinates of the lower rightmost corner of the eVision.Legacy.ERectangle object.
xYYCoordinates of the upper leftmost corner of the eVision.Legacy.ERectangle object.
XXYYCoordinates of the upper rightmost corner of the eVision.Legacy.ERectangle object.

◆ GetEdges()

None eVision.Legacy.ERectangle.GetEdges ( self,
eVision.Legacy.ELine x,
eVision.Legacy.ELine XX,
eVision.Legacy.ELine y,
eVision.Legacy.ELine YY )

Retrieves each edge of a eVision.Legacy.ERectangle object.

Parameters
xLeftmost edge of the eVision.Legacy.ERectangle object.
XXRightmost edge of the eVision.Legacy.ERectangle object.
yLower edge of the eVision.Legacy.ERectangle object.
YYUpper edge of the eVision.Legacy.ERectangle object.

◆ GetMidEdges()

None eVision.Legacy.ERectangle.GetMidEdges ( self,
eVision.EPoint x,
eVision.EPoint XX,
eVision.EPoint y,
eVision.EPoint YY )

Retrieves the center coordinates of each edge of a eVision.Legacy.ERectangle object.

Parameters
xCenter coordinates of the leftmost edge of the eVision.Legacy.ERectangle object.
XXCenter coordinates of the rightmost edge of the eVision.Legacy.ERectangle object.
yCenter coordinates of the lower edge of the eVision.Legacy.ERectangle object.
YYCenter coordinates of the upper edge of the eVision.Legacy.ERectangle object.

◆ GetPoint()

eVision.EPoint eVision.Legacy.ERectangle.GetPoint ( self,
float fractionX,
float fractionY )

Returns the coordinates of a particular point, specified by its location in the eVision.Legacy.ERectangle area.

Parameters
fractionXPoint location expressed as a fraction of the eVision.Legacy.ERectangle vertical edges (range -1, +1).
fractionYPoint location expressed as a fraction of the eVision.Legacy.ERectangle horizontal edges (range -1, +1).

◆ SetFromOppositeCorners()

None eVision.Legacy.ERectangle.SetFromOppositeCorners ( self,
eVision.EPoint origin,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.

Parameters
originUpper left point coordinates of the rectangle.
endLower right point coordinates of the rectangle.

◆ SetFromOriginMiddleEnd()

None eVision.Legacy.ERectangle.SetFromOriginMiddleEnd ( self,
eVision.EPoint origin,
eVision.EPoint middle,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.

Deprecated

Use eVision.Legacy.ERectangle.SetFromThreeCorners instead.

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

Parameters
originUpper left point coordinates of the rectangle.
middleA third corner point coordinates.
endLower right point coordinates of the rectangle.

◆ SetFromThreeCorners()

None eVision.Legacy.ERectangle.SetFromThreeCorners ( self,
eVision.EPoint origin,
eVision.EPoint middle,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.

Parameters
originUpper left point coordinates of the rectangle.
middleA third corner point coordinates.
endLower right point coordinates of the rectangle.

◆ SetFromTwoPoints()

None eVision.Legacy.ERectangle.SetFromTwoPoints ( self,
eVision.EPoint origin,
eVision.EPoint end )

Sets the geometric parameters (center coordinates, size, and rotation angle) of an eVision.Legacy.ERectangle object.

Deprecated

Use eVision.Legacy.ERectangle.SetFromOppositeCorners instead.

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

Parameters
originUpper left point coordinates of the rectangle.
endLower right point coordinates of the rectangle.

◆ SetSize()

None eVision.Legacy.ERectangle.SetSize ( self,
float sizeX,
float sizeY )

Sets the size of a eVision.Legacy.ERectangle object.

Remarks:

A eVision.Legacy.ERectangle object is fully defined knowing its nominal position (given by the coordinates of its center), its nominal size, its rotation angle and its outline tolerance. By default, the width and height values are 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

Parameters
sizeXNominal size X of the eVision.Legacy.ERectangle object. Default values is 100.
sizeYNominal size Y of the eVision.Legacy.ERectangle object. Default values is 100.

◆ SizeX()

float eVision.Legacy.ERectangle.SizeX ( self)

X size of the eVision.Legacy.ERectangle.

◆ SizeY()

float eVision.Legacy.ERectangle.SizeY ( self)

Y size of the eVision.Legacy.ERectangle.