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

Manages a circle shape. More...

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

Public Member Functions

None __init__ (self, eVision.Legacy.ECircleShape other)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, float diameter, float originAngle, bool direct)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, float diameter, float originAngle)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, float diameter)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, float diameter, float originAngle, float amplitude)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end, bool fullCircle)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, eVision.EPoint origin, bool fullCircle)
 Constructs a eVision.Legacy.ECircleShape object.
None __init__ (self, eVision.EPoint center, eVision.EPoint origin)
 Constructs a eVision.Legacy.ECircleShape object.
None SetCenterXY (self, float centerX, float centerY)
 Sets the x and y coordinates of the center of the eVision.Legacy.ECircleShape.
eVision.EPoint GetPoint (self, float fraction)
 Returns the coordinates of a particular point specified by its location along the circle arc.
None CopyTo (self, eVision.Legacy.ECircleShape other, bool recursive)
 Copies all the data of the current eVision.Legacy.ECircleShape object into another eVision.Legacy.ECircleShape object, and returns it.
None CopyTo (self, eVision.Legacy.ECircleShape other)
 Copies all the data of the current eVision.Legacy.ECircleShape object into another eVision.Legacy.ECircleShape object, and returns it.
None SetFromCenterAndOrigin (self, eVision.EPoint center, eVision.EPoint origin, bool direct)
 Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.
None SetFromCenterAndOrigin (self, eVision.EPoint center, eVision.EPoint origin)
 Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.
None SetFromOriginMiddleEnd (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end, bool fullCircle)
 Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.
None SetFromOriginMiddleEnd (self, eVision.EPoint origin, eVision.EPoint middle, eVision.EPoint end)
 Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.
None Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None graphicContext)
 Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None Closest (self)
 Find the daughter shape that is the closest to this shape.
bool HitTest (self, bool bDaughters)
 Checks if there is a handle under the cursor.
bool HitTest (self)
 Checks if there is a handle under the cursor.
None Drag (self, int x, int y)
 Moves a handle to a new position and updates the position parameters of the gauge.
float CenterX (self)
 Abscissa of the origin point of the shape.
float CenterY (self)
 Ordinate of the origin point of the shape.
float Angle (self)
 The angle of the frame.
 Angle (self, float value)
 The angle of the frame.
float Scale (self)
 The scale of the frame.
 Scale (self, float value)
 The scale of the frame.
float Amplitude (self)
 Angular amplitude of the eVision.Legacy.ECircleShape object.
 Amplitude (self, float value)
 Angular amplitude of the eVision.Legacy.ECircleShape object.
eVision.EPoint Apex (self)
 Apex point coordinates of a eVision.Legacy.ECircleShape object.
float ApexAngle (self)
 Angular position at the apex of a eVision.Legacy.ECircleShape object.
float ArcLength (self)
 Circle arc length of a eVision.Legacy.ECircleShape object.
eVision.EPoint Center (self)
 Center point of the shape.
 Center (self, eVision.EPoint value)
 Center point of the shape.
float Diameter (self)
 Diameter of a eVision.Legacy.ECircleShape object.
 Diameter (self, float value)
 Diameter of a eVision.Legacy.ECircleShape object.
bool Direct (self)
 Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.
eVision.EPoint End (self)
 End point coordinates of a eVision.Legacy.ECircleShape object.
float EndAngle (self)
 Angular position of the end of a eVision.Legacy.ECircleShape object.
bool Full (self)
 Flag indicating whether the eVision.Legacy.ECircleShape object is a full circle or not.
eVision.EPoint Org (self)
 Origin point coordinates of a eVision.Legacy.ECircleShape object.
float OrgAngle (self)
 Angular position from where the eVision.Legacy.ECircleShape object extents.
float Radius (self)
 Radius of a eVision.Legacy.ECircleShape object.
 Radius (self, float value)
 Radius of a eVision.Legacy.ECircleShape object.
eVision.EShapeType Type (self)
 Shape type.
eVision.Legacy.ECircle Circle (self)
 The circle.
 Circle (self, eVision.Legacy.ECircle value)
 The circle.
Public Member Functions inherited from eVision.Legacy.EShape
eVision.Legacy.EShape|None GetShapeNamed (self, str name)
 Returns a pointer to a daughter gauge or shape specified by its name.
bool GetFound (self)
 Flag indicating whether a measured shape has been found.
bool GetAutoArrange (self)
None SetAutoArrange (self, bool bAutoArrange, bool bDaughters)
None SetAutoArrange (self, bool bAutoArrange)
None SetFound (self, bool bFound, bool bDaughters)
None SetFound (self, bool bFound)
bool GetInspected (self)
None SetInspected (self, bool bFound, bool bDaughters)
None SetInspected (self, bool bFound)
bool GetPassed (self)
None SetPassed (self, bool bFound, bool bDaughters)
None SetPassed (self, bool bFound)
bool GetQuickDraw (self)
None SetQuickDraw (self, bool bFound, bool bDaughters)
None SetQuickDraw (self, bool bFound)
bool GetOptionalDraw (self)
None SetOptionalDraw (self, bool bFound, bool bDaughters)
None SetOptionalDraw (self, bool bFound)
bool GetUserFlag (self)
None SetUserFlag (self, bool bUserFlag, bool bDaughters)
None SetUserFlag (self, bool bUserFlag)
bool GetAllocated (self)
 Gets the allocated flag.
None EnableBehaviorFilter (self, eVision.EShapeBehavior behavior, bool value)
 Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
None EnableBehaviorFilter (self, eVision.EShapeBehavior behavior)
 Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
None DisableBehaviorFilter (self, eVision.EShapeBehavior behavior)
 Disables (i.e.
None Attach (self, eVision.Legacy.EShape|None mother)
 Attaches the gauge to a mother gauge or shape.
None Detach (self)
 Detaches the gauge from its mother gauge or shape.
None DetachDaughters (self)
 Detaches the daughter gauges or shapes.
eVision.Legacy.EShape|None GetDaughter (self, int index)
 Returns a pointer to the specified daughter gauge or shape.
bool IsWorld (self)
None InvalidateWorld (self)
 Invalidates the world shape for this shape and all its ancestors.
eVision.EPoint LocalToSensor (self, eVision.EPoint LPoint)
 Transforms a point from local coordinates to sensor coordinates.
eVision.EPoint SensorToLocal (self, eVision.EPoint SPoint)
 Transforms a point from sensor coordinates to local coordinates.
None SetZoom (self, float zoomX, float zoomY)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self, float zoomX)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetPan (self, float panX, float panY)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self, float panX)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode, bool bDaughters)
 Sets the dragging mode which defines how the shape could be dragged.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode)
 Sets the dragging mode which defines how the shape could be dragged.
eVision.EDraggingMode GetDraggingMode (self)
 Gets the dragging mode which defines how the shape could be dragged.
None SetCursor (self, int x, int y)
 Sets the cursor current coordinates.
None Process (self, eVision.EROIBW8|None pSrc, bool bDaughters)
None Process (self, eVision.EROIBW8|None pSrc)
None Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region, bool bDaughters)
None Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region)
None Save (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Load (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
bool HasProperty (self, str aProperty)
 Returns whether a eVision.Legacy.EShape has a property named aProperty.
str GetProperty (self, str aProperty)
 Gets the value of property aProperty.
None SetProperty (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape.
None SetPropertyRecursive (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape and all of its daughters.
None RemoveProperty (self, str aProperty)
 Removes the property name aProperty from the eVision.Legacy.EShape.
bool HasValidPolarityProperty (self)
 Returns whether the eVision.Legacy.EShape has a valid polarity property.
None EnableTypeFilter (self, int un32Types)
 Enables the filter of the specified shape type.
None DisableTypeFilter (self)
 Enables all shape types.
str Name (self)
 Name of the eVision.Legacy.EShape object.
 Name (self, str value)
 Name of the eVision.Legacy.EShape object.
bool Visible (self)
 Flag indicating whether the shape is visible or not.
 Visible (self, bool value)
 Flag indicating whether the shape is visible or not.
bool Selected (self)
 Flag indicating whether the shape is selected or not.
 Selected (self, bool value)
 Flag indicating whether the shape is selected or not.
bool Selectable (self)
 Flag indicating whether the shape can be selected or not.
 Selectable (self, bool value)
 Flag indicating whether the shape can be selected or not.
bool Dragable (self)
 Flag indicating whether the shape can be dragged or not.
 Dragable (self, bool value)
 Flag indicating whether the shape can be dragged or not.
bool Resizable (self)
 Flag indicating whether the shape can be resized or not.
 Resizable (self, bool value)
 Flag indicating whether the shape can be resized or not.
bool Rotatable (self)
 Flag indicating whether the shape can be rotated or not.
 Rotatable (self, bool value)
 Flag indicating whether the shape can be rotated or not.
bool Labeled (self)
 Flag indicating whether the shape label should be displayed or not.
 Labeled (self, bool value)
 Flag indicating whether the shape label should be displayed or not.
bool Active (self)
 Flag indicating whether the shape is active or not.
 Active (self, bool value)
 Flag indicating whether the shape is active or not.
bool ActualShape (self)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
 ActualShape (self, bool value)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
int NumDaughters (self)
 Number of daughters attached to the shape.
eVision.Legacy.EShape|None Mother (self)
 Pointer to the mother shape.
eVision.Legacy.EWorldShape|None WorldShape (self)
 World ancestor.
float ZoomX (self)
 Current horizontal zooming factor for drawing operations.
float ZoomY (self)
 Current vertical zooming factor for drawing operations.
float PanX (self)
 Current horizontal panning value for drawing operations, expressed in pixels.
float PanY (self)
 Current vertical panning value for drawing operations, expressed in pixels.
eVision.EDragHandle HitHandle (self)
 Handle currently under the cursor.
eVision.Legacy.EShape|None HitShape (self)
 Pointer to the shape currently under the cursor.
eVision.Legacy.EShape|None ClosestShape (self)
 Closest shape among the daughters.

Additional Inherited Members

Protected Member Functions inherited from eVision.Legacy.EShape
 _VisibleRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
 _SelectedRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are selected or not.
 _SelectableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
 _DragableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
 _ResizableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
 _RotatableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
 _LabeledRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape label should be displayed or not.
 _ActiveRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are active or not.
 _ActualShapeRecursive__setter (self, bool value)
 Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
Properties inherited from eVision.Legacy.EShape
 VisibleRecursive
 SelectedRecursive
 SelectableRecursive
 DragableRecursive
 ResizableRecursive
 RotatableRecursive
 LabeledRecursive
 ActiveRecursive
 ActualShapeRecursive

Detailed Description

Manages a circle shape.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/10]

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

Constructs a eVision.Legacy.ECircleShape object.

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

◆ __init__() [2/10]

None eVision.Legacy.ECircleShape.__init__ ( self)

Constructs a eVision.Legacy.ECircleShape object.

◆ __init__() [3/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
float diameter,
float originAngle,
bool direct )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
diameterNominal diameter of the circle. The default value is 100.
originAngleNominal angular origin of the circle. The default value is 0.
directtrue (default) means that angles increase anticlockwisely in a direct coordinate system.

◆ __init__() [4/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
float diameter,
float originAngle )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
diameterNominal diameter of the circle. The default value is 100.
originAngleNominal angular origin of the circle. The default value is 0.

◆ __init__() [5/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
float diameter )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
diameterNominal diameter of the circle. The default value is 100.

◆ __init__() [6/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).

◆ __init__() [7/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
float diameter,
float originAngle,
float amplitude )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
diameterNominal diameter of the circle. The default value is 100.
originAngleNominal angular origin of the circle. The default value is 0.
amplitudeNominal angular amplitude of the circle. The default value is 360.

◆ __init__() [8/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint origin,
eVision.EPoint middle,
eVision.EPoint end,
bool fullCircle )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
originOrigin point coordinates of the circle.
middleMiddle point coordinates of the circle.
endEnd point coordinates of the circle.
fullCircletrue (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ __init__() [9/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
eVision.EPoint origin,
bool fullCircle )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
originOrigin point coordinates of the circle.
fullCircletrue (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ __init__() [10/10]

None eVision.Legacy.ECircleShape.__init__ ( self,
eVision.EPoint center,
eVision.EPoint origin )

Constructs a eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
originOrigin point coordinates of the circle.

Member Function Documentation

◆ Amplitude() [1/2]

float eVision.Legacy.ECircleShape.Amplitude ( self)

Angular amplitude of the eVision.Legacy.ECircleShape object.

Remarks:

The default value is 360. A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • 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. In this case, a clockwise rotation leads to a positive angle value.

◆ Amplitude() [2/2]

eVision.Legacy.ECircleShape.Amplitude ( self,
float value )

Angular amplitude of the eVision.Legacy.ECircleShape object.

Remarks:

The default value is 360. A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • 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. In this case, a clockwise rotation leads to a positive angle value.

◆ Angle() [1/2]

float eVision.Legacy.ECircleShape.Angle ( self)

The angle of the frame.

◆ Angle() [2/2]

eVision.Legacy.ECircleShape.Angle ( self,
float value )

The angle of the frame.

◆ Apex()

eVision.EPoint eVision.Legacy.ECircleShape.Apex ( self)

Apex point coordinates of a eVision.Legacy.ECircleShape object.

◆ ApexAngle()

float eVision.Legacy.ECircleShape.ApexAngle ( self)

Angular position at the apex of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • 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. In this case, a clockwise rotation leads to a positive angle value.

◆ ArcLength()

float eVision.Legacy.ECircleShape.ArcLength ( self)

Circle arc length of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance.

◆ Center() [1/2]

eVision.EPoint eVision.Legacy.ECircleShape.Center ( self)

Center point of the shape.

◆ Center() [2/2]

eVision.Legacy.ECircleShape.Center ( self,
eVision.EPoint value )

Center point of the shape.

◆ CenterX()

float eVision.Legacy.ECircleShape.CenterX ( self)

Abscissa of the origin point of the shape.

◆ CenterY()

float eVision.Legacy.ECircleShape.CenterY ( self)

Ordinate of the origin point of the shape.

◆ Circle() [1/2]

eVision.Legacy.ECircle eVision.Legacy.ECircleShape.Circle ( self)

The circle.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Circle() [2/2]

eVision.Legacy.ECircleShape.Circle ( self,
eVision.Legacy.ECircle value )

The circle.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Closest()

None eVision.Legacy.ECircleShape.Closest ( self)

Find the daughter shape that is the closest to this shape.

To retrieve the closest shape, use eVision.Legacy.EShape.ClosestShape.

Reimplemented from eVision.Legacy.EShape.

◆ CopyTo() [1/2]

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

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

Remarks:

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

Parameters
othereVision.Legacy.ECircleShape object in which the current eVision.Legacy.ECircleShape object data have to be copied.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ CopyTo() [2/2]

None eVision.Legacy.ECircleShape.CopyTo ( self,
eVision.Legacy.ECircleShape other,
bool recursive )

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

Remarks:

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

Parameters
othereVision.Legacy.ECircleShape object in which the current eVision.Legacy.ECircleShape object data have to be copied.
recursivetrue if the children gauges have to be copied as well, false otherwise.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Diameter() [1/2]

float eVision.Legacy.ECircleShape.Diameter ( self)

Diameter of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the diameter is 100, which means 100 pixels when the field of view is not calibrated, and 100 physical units in case of a calibrated field of view.

◆ Diameter() [2/2]

eVision.Legacy.ECircleShape.Diameter ( self,
float value )

Diameter of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the diameter is 100, which means 100 pixels when the field of view is not calibrated, and 100 physical units in case of a calibrated field of view.

◆ Direct()

bool eVision.Legacy.ECircleShape.Direct ( self)

Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.

Remarks:

true (default) means that angles increase anticlockwisely in a direct coordinate system, and clockwisely in an inverse coordinate system.

  • 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.

◆ Drag()

None eVision.Legacy.ECircleShape.Drag ( self,
int x,
int y )

Moves a handle to a new position and updates the position parameters of the gauge.

Parameters
xCursor current X coordinate.
yCursor current Y coordinate.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge.

◆ Draw() [1/3]

None eVision.Legacy.ECircleShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext )

Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Draw() [2/3]

None eVision.Legacy.ECircleShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EDrawingMode drawingMode )

Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by eVision.EDrawingMode.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Draw() [3/3]

None eVision.Legacy.ECircleShape.Draw ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EDrawingMode drawingMode,
bool daughters )

Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by eVision.EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ End()

eVision.EPoint eVision.Legacy.ECircleShape.End ( self)

End point coordinates of a eVision.Legacy.ECircleShape object.

◆ EndAngle()

float eVision.Legacy.ECircleShape.EndAngle ( self)

Angular position of the end of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • 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. In this case, a clockwise rotation leads to a positive angle value.

◆ Full()

bool eVision.Legacy.ECircleShape.Full ( self)

Flag indicating whether the eVision.Legacy.ECircleShape object is a full circle or not.

Remarks:

By default (true), the eVision.Legacy.ECircleShape object is a full circle.

◆ GetPoint()

eVision.EPoint eVision.Legacy.ECircleShape.GetPoint ( self,
float fraction )

Returns the coordinates of a particular point specified by its location along the circle arc.

Parameters
fractionPoint location expressed as a fraction of the circle arc (range [-1, +1]).

◆ HitTest() [1/2]

bool eVision.Legacy.ECircleShape.HitTest ( self)

Checks if there is a handle under the cursor.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ HitTest() [2/2]

bool eVision.Legacy.ECircleShape.HitTest ( self,
bool bDaughters )

Checks if there is a handle under the cursor.

Parameters
bDaughtersIndicates if the check must be done in the whole hierarchy or just this object.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge, and eVision.Legacy.ECircleGauge.

◆ Org()

eVision.EPoint eVision.Legacy.ECircleShape.Org ( self)

Origin point coordinates of a eVision.Legacy.ECircleShape object.

◆ OrgAngle()

float eVision.Legacy.ECircleShape.OrgAngle ( self)

Angular position from where the eVision.Legacy.ECircleShape object extents.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • 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. In this case, a clockwise rotation leads to a positive angle value.

◆ Radius() [1/2]

float eVision.Legacy.ECircleShape.Radius ( self)

Radius of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the radius is 50, which means 50 pixels when the field of view is not calibrated, and 50 physical units in case of a calibrated field of view.

◆ Radius() [2/2]

eVision.Legacy.ECircleShape.Radius ( self,
float value )

Radius of a eVision.Legacy.ECircleShape object.

Remarks:

A eVision.Legacy.ECircleShape object is fully defined knowing its nominal position (its center coordinates), its nominal radius (diameter), the angular position from where it extents, its angular amplitude, and its outline tolerance. By default, the radius is 50, which means 50 pixels when the field of view is not calibrated, and 50 physical units in case of a calibrated field of view.

◆ Scale() [1/2]

float eVision.Legacy.ECircleShape.Scale ( self)

The scale of the frame.

◆ Scale() [2/2]

eVision.Legacy.ECircleShape.Scale ( self,
float value )

The scale of the frame.

◆ SetCenterXY()

None eVision.Legacy.ECircleShape.SetCenterXY ( self,
float centerX,
float centerY )

Sets the x and y coordinates of the center of the eVision.Legacy.ECircleShape.

Parameters
centerXx coordinate of the center
centerYy coordinate of the center

◆ SetFromCenterAndOrigin() [1/2]

None eVision.Legacy.ECircleShape.SetFromCenterAndOrigin ( self,
eVision.EPoint center,
eVision.EPoint origin )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
originOrigin point coordinates of the circle.

◆ SetFromCenterAndOrigin() [2/2]

None eVision.Legacy.ECircleShape.SetFromCenterAndOrigin ( self,
eVision.EPoint center,
eVision.EPoint origin,
bool direct )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.

Parameters
centerCenter coordinates of the circle at its nominal position. The default value is (0,0).
originOrigin point coordinates of the circle.
directtrue (default) means that angles increase anticlockwise in a direct coordinate system.

◆ SetFromOriginMiddleEnd() [1/2]

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

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.

Parameters
originOrigin point coordinates of the circle.
middleMiddle point coordinates of the circle.
endEnd point coordinates of the circle.

◆ SetFromOriginMiddleEnd() [2/2]

None eVision.Legacy.ECircleShape.SetFromOriginMiddleEnd ( self,
eVision.EPoint origin,
eVision.EPoint middle,
eVision.EPoint end,
bool fullCircle )

Sets the geometric parameters (nominal position and diameter, angular position and amplitude) of an eVision.Legacy.ECircleShape object.

Parameters
originOrigin point coordinates of the circle.
middleMiddle point coordinates of the circle.
endEnd point coordinates of the circle.
fullCircletrue (default) in case of a full turn circle. If fullCircle is false, origin and end give the circle's amplitude.

◆ Type()

eVision.EShapeType eVision.Legacy.ECircleShape.Type ( self)

Shape type.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.ECircleGauge.