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

Manages a polygonal shape. More...

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

Public Member Functions

None __init__ (self)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, eVision.Legacy.EPolygonShape other)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, list[eVision._eVision.EPoint] vertices, bool closed)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, list[eVision._eVision.EPoint] vertices)
 Constructs a eVision.Legacy.EPolygonShape.
None AddVertexAtDisplayPosition (self, int x, int y)
 Add a vertex to the polygon at a position depending on a display coordinate.
None RemoveVertexAtDisplayPosition (self, int x, int y)
 Remove the closest vertex to the display position (x,y).
None SetCenterXY (self, float centerX, float centerY)
 Sets the center coordinates of a eVision.Legacy.EPolygonShape object.
eVision.EPoint GetVertex (self, int index)
 Gets a polygon vertex.
None SetVertex (self, int index, eVision.EPoint pt)
 Sets a polygon vertex.
None AppendVertex (self, eVision.EPoint pt)
 Append a polygon vertex after the last.
None CopyTo (self, eVision.Legacy.EPolygonShape other, bool bRecursive)
 Copies all the data of the current eVision.Legacy.EPolygonShape object into another eVision.Legacy.EPolygonShape object and returns it.
None CopyTo (self, eVision.Legacy.EPolygonShape other)
 Copies all the data of the current eVision.Legacy.EPolygonShape object into another eVision.Legacy.EPolygonShape object and returns it.
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 n32CursorX, int n32CursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
eVision.EPoint Center (self)
 Center point of the shape.
 Center (self, eVision.EPoint value)
 Center point of the shape.
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)
 Orientation of the shape.
 Angle (self, float value)
 Orientation of the shape.
float Scale (self)
 Scale of the polygon.
 Scale (self, float value)
 Scale of the polygon.
float Length (self)
 Returns the length (perimeter) of the polygon.
bool IsClosed (self)
 The polygon close attribute.
 IsClosed (self, bool value)
 The polygon close attribute.
eVision.Legacy.EPolygon Polygon (self)
 Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.
 Polygon (self, eVision.Legacy.EPolygon value)
 Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.
int NumVertices (self)
 Returns the number of polygon's vertices.
int NumEdges (self)
 Returns the number of polygon's edges (or sides).
eVision.EShapeType Type (self)
 Shape type.
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 polygonal shape.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/4]

None eVision.Legacy.EPolygonShape.__init__ ( self)

◆ __init__() [2/4]

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

Constructs a eVision.Legacy.EPolygonShape.

Parameters
otherReference to the eVision.Legacy.EPolygonShape used for the initialization.

◆ __init__() [3/4]

None eVision.Legacy.EPolygonShape.__init__ ( self,
list[eVision._eVision.EPoint] vertices,
bool closed )

Constructs a eVision.Legacy.EPolygonShape.

Parameters
verticesA vector of at least 3 points.
closedAn optional parameter to set the closed properties. When closed, an edge exists between the last and first points of the polygon. By default, created polygons are closed.

◆ __init__() [4/4]

None eVision.Legacy.EPolygonShape.__init__ ( self,
list[eVision._eVision.EPoint] vertices )

Constructs a eVision.Legacy.EPolygonShape.

Parameters
verticesA vector of at least 3 points.

Member Function Documentation

◆ AddVertexAtDisplayPosition()

None eVision.Legacy.EPolygonShape.AddVertexAtDisplayPosition ( self,
int x,
int y )

Add a vertex to the polygon at a position depending on a display coordinate.

The current display parameters (zoom and pan) are used to find the best insert position.

Parameters
xThe X coordinate in display space
yThe Y coordinate in display space

◆ Angle() [1/2]

float eVision.Legacy.EPolygonShape.Angle ( self)

Orientation of the shape.

◆ Angle() [2/2]

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

Orientation of the shape.

◆ AppendVertex()

None eVision.Legacy.EPolygonShape.AppendVertex ( self,
eVision.EPoint pt )

Append a polygon vertex after the last.

Parameters
ptThe point to append.

◆ Center() [1/2]

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

Center point of the shape.

◆ Center() [2/2]

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

Center point of the shape.

◆ CenterX()

float eVision.Legacy.EPolygonShape.CenterX ( self)

Abscissa of the origin point of the shape.

◆ CenterY()

float eVision.Legacy.EPolygonShape.CenterY ( self)

Ordinate of the origin point of the shape.

◆ Closest()

None eVision.Legacy.EPolygonShape.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.EPolygonShape.CopyTo ( self,
eVision.Legacy.EPolygonShape other )

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

Remarks:

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

Parameters
otherThe other eVision.Legacy.EPolygonShape that we will copy into this one.

Reimplemented in eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ CopyTo() [2/2]

None eVision.Legacy.EPolygonShape.CopyTo ( self,
eVision.Legacy.EPolygonShape other,
bool bRecursive )

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

Remarks:

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

Parameters
otherThe other eVision.Legacy.EPolygonShape that we will copy into this one.
bRecursivetrue if the children shapes have to be copied as well, false otherwise.

Reimplemented in eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ Drag()

None eVision.Legacy.EPolygonShape.Drag ( self,
int n32CursorX,
int n32CursorY )

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

Parameters
n32CursorXCurrent cursor coordinates.
n32CursorYCurrent cursor coordinates.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.EPolygonGauge.

◆ Draw() [1/3]

None eVision.Legacy.EPolygonShape.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.EPolygonGauge, eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ Draw() [2/3]

None eVision.Legacy.EPolygonShape.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.EPolygonGauge, eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ Draw() [3/3]

None eVision.Legacy.EPolygonShape.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.EPolygonGauge, eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ GetVertex()

eVision.EPoint eVision.Legacy.EPolygonShape.GetVertex ( self,
int index )

Gets a polygon vertex.

Parameters
indexThe index of the vertex.

◆ HitTest() [1/2]

bool eVision.Legacy.EPolygonShape.HitTest ( self)

Checks if there is a handle under the cursor.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ HitTest() [2/2]

bool eVision.Legacy.EPolygonShape.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.EPolygonGauge, and eVision.Legacy.EPolygonGauge.

◆ IsClosed() [1/2]

bool eVision.Legacy.EPolygonShape.IsClosed ( self)

The polygon close attribute.

◆ IsClosed() [2/2]

eVision.Legacy.EPolygonShape.IsClosed ( self,
bool value )

The polygon close attribute.

◆ Length()

float eVision.Legacy.EPolygonShape.Length ( self)

Returns the length (perimeter) of the polygon.

◆ NumEdges()

int eVision.Legacy.EPolygonShape.NumEdges ( self)

Returns the number of polygon's edges (or sides).

Depends on the eVision.Legacy.EPolygon.IsClosed status.

◆ NumVertices()

int eVision.Legacy.EPolygonShape.NumVertices ( self)

Returns the number of polygon's vertices.

◆ Polygon() [1/2]

eVision.Legacy.EPolygon eVision.Legacy.EPolygonShape.Polygon ( self)

Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.

◆ Polygon() [2/2]

eVision.Legacy.EPolygonShape.Polygon ( self,
eVision.Legacy.EPolygon value )

Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.

◆ RemoveVertexAtDisplayPosition()

None eVision.Legacy.EPolygonShape.RemoveVertexAtDisplayPosition ( self,
int x,
int y )

Remove the closest vertex to the display position (x,y).

Parameters
xThe X coordinate in display space
yThe Y coordinate in display space

◆ Scale() [1/2]

float eVision.Legacy.EPolygonShape.Scale ( self)

Scale of the polygon.

◆ Scale() [2/2]

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

Scale of the polygon.

◆ SetCenterXY()

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

Sets the center coordinates of a eVision.Legacy.EPolygonShape object.

Parameters
centerXCenter coordinates of the eVision.Legacy.EPolygonShape object.
centerYCenter coordinates of the eVision.Legacy.EPolygonShape object.

◆ SetVertex()

None eVision.Legacy.EPolygonShape.SetVertex ( self,
int index,
eVision.EPoint pt )

Sets a polygon vertex.

Parameters
indexThe index of the vertex.
ptThe vertex position.

◆ Type()

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

Shape type.

Reimplemented from eVision.Legacy.EShape.

Reimplemented in eVision.Legacy.EPolygonGauge.