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

Abstract class to federate the classes that can be hierarchically attached together (from a geometrical point of view). More...

Inheritance diagram for eVision.Legacy.EShape:

Public Member Functions

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 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 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.
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 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 Drag (self, int n32CursorX, int n32CursorY)
 Moves a handle to a new position and updates the position parameters of the shape.
None Closest (self)
 Find the daughter shape that is the closest to this shape.
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.
eVision.EShapeType Type (self)
 Shape type.
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.

Protected Member Functions

 _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

 VisibleRecursive
 SelectedRecursive
 SelectableRecursive
 DragableRecursive
 ResizableRecursive
 RotatableRecursive
 LabeledRecursive
 ActiveRecursive
 ActualShapeRecursive

Detailed Description

Abstract class to federate the classes that can be hierarchically attached together (from a geometrical point of view).

Remarks:

License(s): BasicTypes

Member Function Documentation

◆ _ActiveRecursive__setter()

eVision.Legacy.EShape._ActiveRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters are active or not.

Remarks:

When complex gauging is required, several gauges can be grouped together. Applying Process() to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

◆ _ActualShapeRecursive__setter()

eVision.Legacy.EShape._ActualShapeRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

The flag is set in this shape and all its daughters.

◆ _DragableRecursive__setter()

eVision.Legacy.EShape._DragableRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters can be dragged or not.

◆ _LabeledRecursive__setter()

eVision.Legacy.EShape._LabeledRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape label should be displayed or not.

The flag is set in this shape and all its daughters.

◆ _ResizableRecursive__setter()

eVision.Legacy.EShape._ResizableRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters can be resized or not.

◆ _RotatableRecursive__setter()

eVision.Legacy.EShape._RotatableRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters can be rotated or not.

◆ _SelectableRecursive__setter()

eVision.Legacy.EShape._SelectableRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters can be selected or not.

◆ _SelectedRecursive__setter()

eVision.Legacy.EShape._SelectedRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and all its daughters are selected or not.

◆ _VisibleRecursive__setter()

eVision.Legacy.EShape._VisibleRecursive__setter ( self,
bool value )
protected

Sets the flag indicating whether the shape and its daughter shapes are visible or not.

◆ Active() [1/2]

◆ Active() [2/2]

◆ ActualShape() [1/2]

bool eVision.Legacy.EShape.ActualShape ( self)

Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

◆ ActualShape() [2/2]

eVision.Legacy.EShape.ActualShape ( self,
bool value )

Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

◆ Attach()

None eVision.Legacy.EShape.Attach ( self,
eVision.Legacy.EShape | None mother )

Attaches the gauge to a mother gauge or shape.

Remarks:

When attached to a mother gauge, be aware that daughter gauges are not positioned according to the nominal mother gauge position, but to its corresponding fitted model.

Parameters
motherPointer to the mother gauge or shape.

◆ Closest()

None eVision.Legacy.EShape.Closest ( self)

◆ ClosestShape()

eVision.Legacy.EShape | None eVision.Legacy.EShape.ClosestShape ( self)

Closest shape among the daughters.

Remarks:

Use eVision.Legacy.EShape.Closest to recompute the closest shape.

◆ Detach()

None eVision.Legacy.EShape.Detach ( self)

Detaches the gauge from its mother gauge or shape.

◆ DetachDaughters()

None eVision.Legacy.EShape.DetachDaughters ( self)

Detaches the daughter gauges or shapes.

◆ DisableBehaviorFilter()

None eVision.Legacy.EShape.DisableBehaviorFilter ( self,
eVision.EShapeBehavior behavior )

Disables (i.e.

removes) a condition from the list of conditions in the behavior filter.

Remarks:

The condition to be disabled is identified by the behavior about which the condition is. Disabling a behavior leads to less restrictive conditions for the Draw and HitTest methods to be actually carried on.

Parameters
behaviorThe behavior of the shape to be removed from the behavior filter.

◆ DisableTypeFilter()

None eVision.Legacy.EShape.DisableTypeFilter ( self)

Enables all shape types.

Reimplemented in eVision.Legacy.EWorldShape.

◆ Drag()

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

◆ Dragable() [1/2]

bool eVision.Legacy.EShape.Dragable ( self)

Flag indicating whether the shape can be dragged or not.

◆ Dragable() [2/2]

eVision.Legacy.EShape.Dragable ( self,
bool value )

Flag indicating whether the shape can be dragged or not.

◆ Draw() [1/3]

◆ Draw() [2/3]

None eVision.Legacy.EShape.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 in eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleShape, eVision.Legacy.ECircleShape, eVision.Legacy.ECircleShape, eVision.Legacy.EFrameShape, eVision.Legacy.EFrameShape, eVision.Legacy.EFrameShape, eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, eVision.Legacy.ELineShape, eVision.Legacy.ELineShape, eVision.Legacy.ELineShape, eVision.Legacy.EPointGauge, eVision.Legacy.EPointGauge, eVision.Legacy.EPointGauge, eVision.Legacy.EPointShape, eVision.Legacy.EPointShape, eVision.Legacy.EPointShape, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonShape, eVision.Legacy.EPolygonShape, eVision.Legacy.EPolygonShape, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleShape, eVision.Legacy.ERectangleShape, eVision.Legacy.ERectangleShape, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeShape, eVision.Legacy.EWedgeShape, eVision.Legacy.EWedgeShape, eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ Draw() [3/3]

None eVision.Legacy.EShape.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 in eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleGauge, eVision.Legacy.ECircleShape, eVision.Legacy.ECircleShape, eVision.Legacy.ECircleShape, eVision.Legacy.EFrameShape, eVision.Legacy.EFrameShape, eVision.Legacy.EFrameShape, eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, eVision.Legacy.ELineGauge, eVision.Legacy.ELineShape, eVision.Legacy.ELineShape, eVision.Legacy.ELineShape, eVision.Legacy.EPointGauge, eVision.Legacy.EPointGauge, eVision.Legacy.EPointGauge, eVision.Legacy.EPointShape, eVision.Legacy.EPointShape, eVision.Legacy.EPointShape, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonGauge, eVision.Legacy.EPolygonShape, eVision.Legacy.EPolygonShape, eVision.Legacy.EPolygonShape, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleGauge, eVision.Legacy.ERectangleShape, eVision.Legacy.ERectangleShape, eVision.Legacy.ERectangleShape, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeGauge, eVision.Legacy.EWedgeShape, eVision.Legacy.EWedgeShape, eVision.Legacy.EWedgeShape, eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ EnableBehaviorFilter() [1/2]

None eVision.Legacy.EShape.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.

Remarks:

This method registers a new necessary condition for the Draw and HitTest families of methods to be actually carried on. Such a condition is about the behavior of the shape, as specified by the behavior argument. Initially, the behavior filter contains an empty list of conditions, which means that the Draw and HitTest methods will always be executed. Adding a new condition through eVision.Legacy.EShape.EnableBehaviorFilter will introduce a new restriction on the effective execution of these methods. Use eVision.Legacy.EShape.DisableBehaviorFilter to remove a condition from the behavior filter.

Parameters
behaviorThe behavior of the shape to be tested.

◆ EnableBehaviorFilter() [2/2]

None eVision.Legacy.EShape.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.

Remarks:

This method registers a new necessary condition for the Draw and HitTest families of methods to be actually carried on. Such a condition is about the behavior of the shape, as specified by the behavior argument. Initially, the behavior filter contains an empty list of conditions, which means that the Draw and HitTest methods will always be executed. Adding a new condition through eVision.Legacy.EShape.EnableBehaviorFilter will introduce a new restriction on the effective execution of these methods. Use eVision.Legacy.EShape.DisableBehaviorFilter to remove a condition from the behavior filter.

Parameters
behaviorThe behavior of the shape to be tested.
valueThe value at which the behavior property should be set to pass the test. By default, equals True.

◆ EnableTypeFilter()

None eVision.Legacy.EShape.EnableTypeFilter ( self,
int un32Types )

Enables the filter of the specified shape type.

Parameters
un32TypesThe type of the shape to filter.

Reimplemented in eVision.Legacy.EWorldShape.

◆ GetAllocated()

bool eVision.Legacy.EShape.GetAllocated ( self)

Gets the allocated flag.

◆ GetAutoArrange()

bool eVision.Legacy.EShape.GetAutoArrange ( self)

◆ GetDaughter()

eVision.Legacy.EShape | None eVision.Legacy.EShape.GetDaughter ( self,
int index )

Returns a pointer to the specified daughter gauge or shape.

Parameters
indexDaughter gauge or shape index.

◆ GetDraggingMode()

eVision.EDraggingMode eVision.Legacy.EShape.GetDraggingMode ( self)

Gets the dragging mode which defines how the shape could be dragged.

◆ GetFound()

bool eVision.Legacy.EShape.GetFound ( self)

Flag indicating whether a measured shape has been found.

Remarks:

After calling Process() or Measure() on a gauge object, use GetFound() to get the status of the measurement.

◆ GetInspected()

bool eVision.Legacy.EShape.GetInspected ( self)

◆ GetOptionalDraw()

bool eVision.Legacy.EShape.GetOptionalDraw ( self)

◆ GetPassed()

bool eVision.Legacy.EShape.GetPassed ( self)

◆ GetProperty()

str eVision.Legacy.EShape.GetProperty ( self,
str aProperty )

Gets the value of property aProperty.

Throws an exception if no such property exists.

Parameters
aPropertyThe name of the property.

◆ GetQuickDraw()

bool eVision.Legacy.EShape.GetQuickDraw ( self)

◆ GetShapeNamed()

eVision.Legacy.EShape | None eVision.Legacy.EShape.GetShapeNamed ( self,
str name )

Returns a pointer to a daughter gauge or shape specified by its name.

Parameters
nameName of the daughter gauge or shape.

◆ GetUserFlag()

bool eVision.Legacy.EShape.GetUserFlag ( self)

◆ HasProperty()

bool eVision.Legacy.EShape.HasProperty ( self,
str aProperty )

Returns whether a eVision.Legacy.EShape has a property named aProperty.

Parameters
aPropertyThe name of the property.

◆ HasValidPolarityProperty()

bool eVision.Legacy.EShape.HasValidPolarityProperty ( self)

Returns whether the eVision.Legacy.EShape has a valid polarity property.

I.e. if it has a property named "polarity" whose value is either "inverted" or "direct".

Remarks:

The "polarity" property is mostly used to define the orientation of the gradient in a shape of a eVision.EVectorModel.

◆ HitHandle()

eVision.EDragHandle eVision.Legacy.EShape.HitHandle ( self)

Handle currently under the cursor.

Remarks:

When the cursor is over a particular handle, its shape could be changed for feedback.

◆ HitShape()

eVision.Legacy.EShape | None eVision.Legacy.EShape.HitShape ( self)

Pointer to the shape currently under the cursor.

Remarks:

When the cursor is over a particular shape, its shape could be changed for feedback.

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ InvalidateWorld()

None eVision.Legacy.EShape.InvalidateWorld ( self)

Invalidates the world shape for this shape and all its ancestors.

◆ IsWorld()

bool eVision.Legacy.EShape.IsWorld ( self)

◆ Labeled() [1/2]

bool eVision.Legacy.EShape.Labeled ( self)

Flag indicating whether the shape label should be displayed or not.

◆ Labeled() [2/2]

eVision.Legacy.EShape.Labeled ( self,
bool value )

Flag indicating whether the shape label should be displayed or not.

◆ Load() [1/4]

None eVision.Legacy.EShape.Load ( self,
eVision.ESerializer | None serializer )

Loads a Shape.The given eVision.ESerializer must have been created for reading.

Parameters
serializerPointer to the eVision.ESerializer created for reading.

◆ Load() [2/4]

None eVision.Legacy.EShape.Load ( self,
eVision.ESerializer | None serializer,
bool daughters )

Loads a Shape.The given eVision.ESerializer must have been created for reading.

Parameters
serializerPointer to the eVision.ESerializer created for reading.
daughtersIndicates if the load must be done on the whole hierarchy or just this object.

◆ Load() [3/4]

None eVision.Legacy.EShape.Load ( self,
str path )

Loads a Shape.The given eVision.ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [4/4]

None eVision.Legacy.EShape.Load ( self,
str path,
bool daughters )

Loads a Shape.The given eVision.ESerializer must have been created for reading.

Parameters
pathThe file path.
daughtersIndicates if the load must be done on the whole hierarchy or just this object.

◆ LocalToSensor()

eVision.EPoint eVision.Legacy.EShape.LocalToSensor ( self,
eVision.EPoint LPoint )

Transforms a point from local coordinates to sensor coordinates.

Parameters
LPointThe point in local coordinates.

◆ Mother()

eVision.Legacy.EShape | None eVision.Legacy.EShape.Mother ( self)

Pointer to the mother shape.

◆ Name() [1/2]

str eVision.Legacy.EShape.Name ( self)

Name of the eVision.Legacy.EShape object.

◆ Name() [2/2]

eVision.Legacy.EShape.Name ( self,
str value )

Name of the eVision.Legacy.EShape object.

◆ NumDaughters()

int eVision.Legacy.EShape.NumDaughters ( self)

Number of daughters attached to the shape.

◆ PanX()

float eVision.Legacy.EShape.PanX ( self)

Current horizontal panning value for drawing operations, expressed in pixels.

By default, no panning occurs.

Reimplemented in eVision.Legacy.EWorldShape.

◆ PanY()

float eVision.Legacy.EShape.PanY ( self)

Current vertical panning value for drawing operations, expressed in pixels.

By default, no panning occurs.

Reimplemented in eVision.Legacy.EWorldShape.

◆ Process() [1/4]

◆ Process() [2/4]

◆ Process() [3/4]

◆ Process() [4/4]

◆ RemoveProperty()

None eVision.Legacy.EShape.RemoveProperty ( self,
str aProperty )

Removes the property name aProperty from the eVision.Legacy.EShape.

Parameters
aPropertyThe name of the property.

◆ Resizable() [1/2]

bool eVision.Legacy.EShape.Resizable ( self)

Flag indicating whether the shape can be resized or not.

◆ Resizable() [2/2]

eVision.Legacy.EShape.Resizable ( self,
bool value )

Flag indicating whether the shape can be resized or not.

◆ Rotatable() [1/2]

bool eVision.Legacy.EShape.Rotatable ( self)

Flag indicating whether the shape can be rotated or not.

◆ Rotatable() [2/2]

eVision.Legacy.EShape.Rotatable ( self,
bool value )

Flag indicating whether the shape can be rotated or not.

◆ Save() [1/4]

None eVision.Legacy.EShape.Save ( self,
eVision.ESerializer | None serializer )

Loads a Shape.The given eVision.ESerializer must have been created for writing.

Parameters
serializerPointer to the eVision.ESerializer created for writing.

◆ Save() [2/4]

None eVision.Legacy.EShape.Save ( self,
eVision.ESerializer | None serializer,
bool daughters )

Loads a Shape.The given eVision.ESerializer must have been created for writing.

Parameters
serializerPointer to the eVision.ESerializer created for writing.
daughtersIndicates if the save must be done on the whole hierarchy or just this object.

◆ Save() [3/4]

None eVision.Legacy.EShape.Save ( self,
str path )

Loads a Shape.The given eVision.ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [4/4]

None eVision.Legacy.EShape.Save ( self,
str path,
bool daughters )

Loads a Shape.The given eVision.ESerializer must have been created for writing.

Parameters
pathThe file path.
daughtersIndicates if the save must be done on the whole hierarchy or just this object.

◆ Selectable() [1/2]

bool eVision.Legacy.EShape.Selectable ( self)

Flag indicating whether the shape can be selected or not.

◆ Selectable() [2/2]

eVision.Legacy.EShape.Selectable ( self,
bool value )

Flag indicating whether the shape can be selected or not.

◆ Selected() [1/2]

bool eVision.Legacy.EShape.Selected ( self)

Flag indicating whether the shape is selected or not.

◆ Selected() [2/2]

eVision.Legacy.EShape.Selected ( self,
bool value )

Flag indicating whether the shape is selected or not.

◆ SensorToLocal()

eVision.EPoint eVision.Legacy.EShape.SensorToLocal ( self,
eVision.EPoint SPoint )

Transforms a point from sensor coordinates to local coordinates.

Parameters
SPointThe point in sensor coordinates.

◆ SetAutoArrange() [1/2]

None eVision.Legacy.EShape.SetAutoArrange ( self,
bool bAutoArrange )

◆ SetAutoArrange() [2/2]

None eVision.Legacy.EShape.SetAutoArrange ( self,
bool bAutoArrange,
bool bDaughters )

◆ SetCursor()

None eVision.Legacy.EShape.SetCursor ( self,
int x,
int y )

Sets the cursor current coordinates.

Parameters
xCursor current coordinates.
yCursor current coordinates.

◆ SetDraggingMode() [1/2]

None eVision.Legacy.EShape.SetDraggingMode ( self,
eVision.EDraggingMode eDraggingMode )

Sets the dragging mode which defines how the shape could be dragged.

Parameters
eDraggingModeThe draggingMode.

◆ SetDraggingMode() [2/2]

None eVision.Legacy.EShape.SetDraggingMode ( self,
eVision.EDraggingMode eDraggingMode,
bool bDaughters )

Sets the dragging mode which defines how the shape could be dragged.

Parameters
eDraggingModeThe draggingMode.
bDaughtersIndicates if the set must be done in the whole hierarchy or just this object.

◆ SetFound() [1/2]

None eVision.Legacy.EShape.SetFound ( self,
bool bFound )

◆ SetFound() [2/2]

None eVision.Legacy.EShape.SetFound ( self,
bool bFound,
bool bDaughters )

◆ SetInspected() [1/2]

None eVision.Legacy.EShape.SetInspected ( self,
bool bFound )

◆ SetInspected() [2/2]

None eVision.Legacy.EShape.SetInspected ( self,
bool bFound,
bool bDaughters )

◆ SetOptionalDraw() [1/2]

None eVision.Legacy.EShape.SetOptionalDraw ( self,
bool bFound )

◆ SetOptionalDraw() [2/2]

None eVision.Legacy.EShape.SetOptionalDraw ( self,
bool bFound,
bool bDaughters )

◆ SetPan() [1/3]

None eVision.Legacy.EShape.SetPan ( self)

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape object inherit of the same panning factor.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ SetPan() [2/3]

None eVision.Legacy.EShape.SetPan ( self,
float panX )

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape object inherit of the same panning factor.

Parameters
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ SetPan() [3/3]

None eVision.Legacy.EShape.SetPan ( self,
float panX,
float panY )

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape object inherit of the same panning factor.

Parameters
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ SetPassed() [1/2]

None eVision.Legacy.EShape.SetPassed ( self,
bool bFound )

◆ SetPassed() [2/2]

None eVision.Legacy.EShape.SetPassed ( self,
bool bFound,
bool bDaughters )

◆ SetProperty()

None eVision.Legacy.EShape.SetProperty ( self,
str aProperty,
str aValue )

Sets the value of property aProperty to aValue for this eVision.Legacy.EShape.

Remarks:

You may use a shape property to define the orientation of the gradient in a shape of a eVision.EVectorModel. This is done by setting a property named "polarity" to "inverted" or "direct".

Additionally, you may set any property to any value for your own needs.

Parameters
aPropertyThe name of the property.
aValueThe value of the property.

◆ SetPropertyRecursive()

None eVision.Legacy.EShape.SetPropertyRecursive ( self,
str aProperty,
str aValue )

Sets the value of property aProperty to aValue for this eVision.Legacy.EShape and all of its daughters.

Parameters
aPropertyThe name of the property.
aValueThe value of the property.

◆ SetQuickDraw() [1/2]

None eVision.Legacy.EShape.SetQuickDraw ( self,
bool bFound )

◆ SetQuickDraw() [2/2]

None eVision.Legacy.EShape.SetQuickDraw ( self,
bool bFound,
bool bDaughters )

◆ SetUserFlag() [1/2]

None eVision.Legacy.EShape.SetUserFlag ( self,
bool bUserFlag )

◆ SetUserFlag() [2/2]

None eVision.Legacy.EShape.SetUserFlag ( self,
bool bUserFlag,
bool bDaughters )

◆ SetZoom() [1/3]

None eVision.Legacy.EShape.SetZoom ( self)

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape inherit of the same zooming factor.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ SetZoom() [2/3]

None eVision.Legacy.EShape.SetZoom ( self,
float zoomX )

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape inherit of the same zooming factor.

Parameters
zoomXHorizontal zooming factor. By default, true scale is used.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ SetZoom() [3/3]

None eVision.Legacy.EShape.SetZoom ( self,
float zoomX,
float zoomY )

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape inherit of the same zooming factor.

Parameters
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0, the default value, the horizontal zooming factor is used instead, so as to provide isotropic zooming.

Reimplemented in eVision.Legacy.EWorldShape, eVision.Legacy.EWorldShape, and eVision.Legacy.EWorldShape.

◆ Type()

◆ Visible() [1/2]

bool eVision.Legacy.EShape.Visible ( self)

Flag indicating whether the shape is visible or not.

◆ Visible() [2/2]

eVision.Legacy.EShape.Visible ( self,
bool value )

Flag indicating whether the shape is visible or not.

◆ WorldShape()

eVision.Legacy.EWorldShape | None eVision.Legacy.EShape.WorldShape ( self)

World ancestor.

◆ ZoomX()

float eVision.Legacy.EShape.ZoomX ( self)

Current horizontal zooming factor for drawing operations.

Reimplemented in eVision.Legacy.EWorldShape.

◆ ZoomY()

float eVision.Legacy.EShape.ZoomY ( self)

Current vertical zooming factor for drawing operations.

Reimplemented in eVision.Legacy.EWorldShape.

Property Documentation

◆ ActiveRecursive

eVision.Legacy.EShape.ActiveRecursive
static
Initial value:
= property(None, _ActiveRecursive__setter, None,
)

◆ ActualShapeRecursive

eVision.Legacy.EShape.ActualShapeRecursive
static
Initial value:
= property(None, _ActualShapeRecursive__setter, None,
)

◆ DragableRecursive

eVision.Legacy.EShape.DragableRecursive
static
Initial value:
= property(None, _DragableRecursive__setter, None,
)

◆ LabeledRecursive

eVision.Legacy.EShape.LabeledRecursive
static
Initial value:
= property(None, _LabeledRecursive__setter, None,
)

◆ ResizableRecursive

eVision.Legacy.EShape.ResizableRecursive
static
Initial value:
= property(None, _ResizableRecursive__setter, None,
)

◆ RotatableRecursive

eVision.Legacy.EShape.RotatableRecursive
static
Initial value:
= property(None, _RotatableRecursive__setter, None,
)

◆ SelectableRecursive

eVision.Legacy.EShape.SelectableRecursive
static
Initial value:
= property(None, _SelectableRecursive__setter, None,
)

◆ SelectedRecursive

eVision.Legacy.EShape.SelectedRecursive
static
Initial value:
= property(None, _SelectedRecursive__setter, None,
)

◆ VisibleRecursive

eVision.Legacy.EShape.VisibleRecursive
static
Initial value:
= property(None, _VisibleRecursive__setter, None,
)