eVision Python API
Loading...
Searching...
No Matches
eVision.Easy3D.E3DObject Class Reference

A eVision.Easy3D.E3DObject is a geometric description of a set of 3D points, produced by E3DObjectExtractor. More...

Public Member Functions

None __init__ (self)
 Constructs an eVision.Easy3D.E3DObject with default (invalid) values.
None __init__ (self, eVision.Easy3D.E3DObject other)
 Copy constructor for the eVision.Easy3D.E3DObject.
None Load (self, str path)
 Loads the eVision.Easy3D.E3DObject.
None Load (self, eVision.ESerializer|None serializer)
 Loads the eVision.Easy3D.E3DObject.
None Save (self, str path)
 Saves the eVision.Easy3D.E3DObject.
None Save (self, eVision.ESerializer|None serializer)
 Saves the eVision.Easy3D.E3DObject.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
 Draws the specified feature of the object in the given graphic context.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
 Draws the specified feature of the object in the given graphic context.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature, eVision.ERGBColor color, float zoomX, float zoomY)
 Draws the specified feature of the object in the given graphic context.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature, eVision.ERGBColor color, float zoomX)
 Draws the specified feature of the object in the given graphic context.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature, eVision.ERGBColor color)
 Draws the specified feature of the object in the given graphic context.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.Easy3D.E3DObjectFeature feature)
 Draws the specified feature of the object in the given graphic context.
None AddToMesh (self, eVision.Easy3D.E3DObjectFeature feature, eVision.Easy3D.EMesh mesh)
 Adds a 3D representation (in the form of a list of triangles) of the given feature to the given mesh.
eVision.Easy3D.E3DObject Transform (self, eVision.Easy3D.E3DTransformMatrix matrix)
 Transforms the 3D object with the given transformation matrix.
bool GetIsFeatureComputed (self, eVision.Easy3D.E3DObjectFeature feature)
 returns true or false depending if the feature was computed for this object

Properties

 NumPixels = property(_NumPixels__getter, None)
 Number of ZMap pixels composing the object.
 BoundingBox = property(_BoundingBox__getter, None)
 The eVision.Easy3D.E3DBox (3D oriented bounding box) of the object.
 AveragePosition = property(_AveragePosition__getter, None)
 3D average position of the object.
 LocalTopPosition = property(_LocalTopPosition__getter, None)
 3D highest position of the object relatively to the object base plane.
 ReferenceTopPosition = property(_ReferenceTopPosition__getter, None)
 3D top position relative to the ZMap origin (this is the position with the highest Z coordinate)
 Length = property(_Length__getter, None)
 Length of the object in metric units.
 Width = property(_Width__getter, None)
 Width of the object in metric units.
 AspectRatio = property(_AspectRatio__getter, None)
 Aspect ratio of the object.
 LocalHeight = property(_LocalHeight__getter, None)
 Local height of the object in metric units.
 ReferenceHeight = property(_ReferenceHeight__getter, None)
 Reference height of the object in metric units.
 Orientation = property(_Orientation__getter, None)
 Orientation of the object.
 Plane = property(_Plane__getter, None)
 Plane fitted to the object 3D positions.
 LocalTilt = property(_LocalTilt__getter, None)
 Angle between the object plane and the base plane.
 ReferenceTilt = property(_ReferenceTilt__getter, None)
 Angle between the object plane and the vertical (Z) axis.
 Area = property(_Area__getter, None)
 Object area in metric units.
 Volume = property(_Volume__getter, None)
 Object volume in metric units.
 BasePlane = property(_BasePlane__getter, None)
 Base plane.
 BaseTilt = property(_BaseTilt__getter, None)
 Angle between the base plane and the vertical (Z) axis.
 RectangleRegion = property(_RectangleRegion__getter, None)
 eVision.ERectangleRegion enclosing the object ZMap pixels.
 Region = property(_Region__getter, None)
 eVision.ERegion composed of the object ZMap pixels.
 Sphere = property(_Sphere__getter, None)
 Sphere fitted to the object.

Detailed Description

A eVision.Easy3D.E3DObject is a geometric description of a set of 3D points, produced by E3DObjectExtractor.

Several 3D features are available. All 3D features are expressed in the ZMap metric coordinate system.

Remarks:

License(s): Easy3D

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.Easy3D.E3DObject.__init__ ( self)

Constructs an eVision.Easy3D.E3DObject with default (invalid) values.

◆ __init__() [2/2]

None eVision.Easy3D.E3DObject.__init__ ( self,
eVision.Easy3D.E3DObject other )

Copy constructor for the eVision.Easy3D.E3DObject.

Parameters
otherThe other eVision.Easy3D.E3DObject that we will copy into this one.

Member Function Documentation

◆ AddToMesh()

None eVision.Easy3D.E3DObject.AddToMesh ( self,
eVision.Easy3D.E3DObjectFeature feature,
eVision.Easy3D.EMesh mesh )

Adds a 3D representation (in the form of a list of triangles) of the given feature to the given mesh.

If the feature is not defined for the eVision.Easy3D.E3DObject, this method has no effect.

◆ Draw() [1/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.

◆ Draw() [2/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature,
eVision.ERGBColor color )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.
colorThe color in which to draw the feature (optional).

◆ Draw() [3/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature,
eVision.ERGBColor color,
float zoomX )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.
colorThe color in which to draw the feature (optional).
zoomXHorizontal zooming factor. By default, true scale is used.

◆ Draw() [4/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature,
eVision.ERGBColor color,
float zoomX,
float zoomY )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.
colorThe color in which to draw the feature (optional).
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ Draw() [5/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature,
eVision.ERGBColor color,
float zoomX,
float zoomY,
float panX )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.
colorThe color in which to draw the feature (optional).
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [6/6]

None eVision.Easy3D.E3DObject.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.Easy3D.E3DObjectFeature feature,
eVision.ERGBColor color,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the specified feature of the object in the given graphic context.

Remarks:

Drawing is done in the device context associated to the desired window.

Parameters
drawAdapterA pointer to an eVision.EDrawAdapter (like the eVision.EWindowsDrawAdapter).
featureThe feature to draw.
colorThe color in which to draw the feature (optional).
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ GetIsFeatureComputed()

bool eVision.Easy3D.E3DObject.GetIsFeatureComputed ( self,
eVision.Easy3D.E3DObjectFeature feature )

returns true or false depending if the feature was computed for this object

Parameters
featureThe feature that is either computed or not.

◆ Load() [1/2]

None eVision.Easy3D.E3DObject.Load ( self,
eVision.ESerializer | None serializer )

Loads the eVision.Easy3D.E3DObject.

The given eVision.ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ Load() [2/2]

None eVision.Easy3D.E3DObject.Load ( self,
str path )

Loads the eVision.Easy3D.E3DObject.

The given eVision.ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Save() [1/2]

None eVision.Easy3D.E3DObject.Save ( self,
eVision.ESerializer | None serializer )

Saves the eVision.Easy3D.E3DObject.

The given eVision.ESerializer must have been created for writing.

Parameters
serializerThe eVision.ESerializer object that is written to.

◆ Save() [2/2]

None eVision.Easy3D.E3DObject.Save ( self,
str path )

Saves the eVision.Easy3D.E3DObject.

The given eVision.ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Transform()

eVision.Easy3D.E3DObject eVision.Easy3D.E3DObject.Transform ( self,
eVision.Easy3D.E3DTransformMatrix matrix )

Transforms the 3D object with the given transformation matrix.

The transformation matrix must contain a rigid transformation (translation and rotation only). Image based attributes of the 3D object are unchanged.

Parameters
matrixThe 3D transformation matrix.

Property Documentation

◆ Area

eVision.Easy3D.E3DObject.Area = property(_Area__getter, None)
static

Object area in metric units.

◆ AspectRatio

eVision.Easy3D.E3DObject.AspectRatio = property(_AspectRatio__getter, None)
static

Aspect ratio of the object.

The aspect ratio is the smallest dimension divided by the largest dimension, its value is always between 0 and 1. The smaller the ratio, the more elongated the object is. A value of 1 means a perfectly square object (length=width).

◆ AveragePosition

eVision.Easy3D.E3DObject.AveragePosition = property(_AveragePosition__getter, None)
static

3D average position of the object.

◆ BasePlane

eVision.Easy3D.E3DObject.BasePlane = property(_BasePlane__getter, None)
static

Base plane.

The base plane is calculated using points surrounding the object.

◆ BaseTilt

eVision.Easy3D.E3DObject.BaseTilt = property(_BaseTilt__getter, None)
static

Angle between the base plane and the vertical (Z) axis.

◆ BoundingBox

eVision.Easy3D.E3DObject.BoundingBox = property(_BoundingBox__getter, None)
static

The eVision.Easy3D.E3DBox (3D oriented bounding box) of the object.

The bounding box is oriented in the XY plane of the ZMap space (rotation over the ZMap Z axis). The bounding box X and Y sizes are the object length and width (see eVision.Easy3D.E3DObject.Length and eVision.Easy3D.E3DObject.Width). The bounding box Z size is always in the ZMap Z axis direction.

◆ Length

eVision.Easy3D.E3DObject.Length = property(_Length__getter, None)
static

Length of the object in metric units.

The length is the largest dimension of the object on the XY plane of the ZMap space.

◆ LocalHeight

eVision.Easy3D.E3DObject.LocalHeight = property(_LocalHeight__getter, None)
static

Local height of the object in metric units.

The local height of the object is relative to the surroundings. The base plane is used as the reference for the calculation of the local height. If it is not possible to evaluate a base plane, the local height has the same value as the reference height (eVision.Easy3D.E3DObject.ReferenceHeight)

◆ LocalTilt

eVision.Easy3D.E3DObject.LocalTilt = property(_LocalTilt__getter, None)
static

Angle between the object plane and the base plane.

◆ LocalTopPosition

eVision.Easy3D.E3DObject.LocalTopPosition = property(_LocalTopPosition__getter, None)
static

3D highest position of the object relatively to the object base plane.

If it is not possible to evaluate a base plane, the local top position is the reference top position (eVision.Easy3D.E3DObject.ReferenceTopPosition)

◆ NumPixels

eVision.Easy3D.E3DObject.NumPixels = property(_NumPixels__getter, None)
static

Number of ZMap pixels composing the object.

◆ Orientation

eVision.Easy3D.E3DObject.Orientation = property(_Orientation__getter, None)
static

Orientation of the object.

The orientation is the angle between the object major (longest) axis and the ZMap X axis.

◆ Plane

eVision.Easy3D.E3DObject.Plane = property(_Plane__getter, None)
static

Plane fitted to the object 3D positions.

◆ RectangleRegion

eVision.Easy3D.E3DObject.RectangleRegion = property(_RectangleRegion__getter, None)
static

eVision.ERectangleRegion enclosing the object ZMap pixels.

◆ ReferenceHeight

eVision.Easy3D.E3DObject.ReferenceHeight = property(_ReferenceHeight__getter, None)
static

Reference height of the object in metric units.

The reference height of the object is relative to the ZMap origin (also known as the reference plane).

◆ ReferenceTilt

eVision.Easy3D.E3DObject.ReferenceTilt = property(_ReferenceTilt__getter, None)
static

Angle between the object plane and the vertical (Z) axis.

◆ ReferenceTopPosition

eVision.Easy3D.E3DObject.ReferenceTopPosition = property(_ReferenceTopPosition__getter, None)
static

3D top position relative to the ZMap origin (this is the position with the highest Z coordinate)

◆ Region

eVision.Easy3D.E3DObject.Region = property(_Region__getter, None)
static

eVision.ERegion composed of the object ZMap pixels.

◆ Sphere

eVision.Easy3D.E3DObject.Sphere = property(_Sphere__getter, None)
static

Sphere fitted to the object.

◆ Volume

eVision.Easy3D.E3DObject.Volume = property(_Volume__getter, None)
static

Object volume in metric units.

◆ Width

eVision.Easy3D.E3DObject.Width = property(_Width__getter, None)
static

Width of the object in metric units.

The width is the smallest dimension of the object on the XY plane of the ZMap space.