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

Manages a viewer window for eVision.Easy3D.EPointCloud. More...

Public Member Functions

None __init__ (self, int orgX, int orgY, int width, int height, ctypes.c_void_p parent)
 Creates an eVision.Easy3D.E3DViewer object.
None __init__ (self, int orgX, int orgY, int width, int height)
 Creates an eVision.Easy3D.E3DViewer object.
None __init__ (self, eVision.Easy3D.EUIAPI uiApi, int orgX, int orgY, int width, int height, ctypes.c_void_p parent)
 Creates an eVision.Easy3D.E3DViewer object.
None __init__ (self, eVision.Easy3D.EUIAPI uiApi, int orgX, int orgY, int width, int height)
 Creates an eVision.Easy3D.E3DViewer object.
None __init__ (self, eVision.Easy3D.EUIAPI uiApi)
 Creates an eVision.Easy3D.E3DViewer object.
None __init__ (self)
 Creates an eVision.Easy3D.E3DViewer object.
None InitRendering (self)
 Initializes the rendering state, must be called one time before the first eVision.Easy3D.E3DViewer.Show.
bool IsInitialized (self)
 Indicates if 3DViewer has already been initialized.
None Terminate (self)
 Closes and frees allocated resources.
None AddRenderSource (self, str name, eVision.Easy3D.EPointCloud source)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.EMesh source)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.EZMap|None source)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere, eVision.EC24 color, int opacity)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere, eVision.EC24 color)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DBox box, eVision.EC24 color, int opacity)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DBox box, eVision.EC24 color)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DBox box)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DLine line, eVision.EC24 color)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DLine line)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DPlane plane, eVision.EC24 color, int opacity)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DPlane plane, eVision.EC24 color)
 Adds a new Render Source.
None AddRenderSource (self, str name, eVision.Easy3D.E3DPlane plane)
 Adds a new Render Source.
None SetRenderSource (self, str name, eVision.Easy3D.EPointCloud source)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.EMesh source)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.EZMap|None source)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere, eVision.EC24 color, int opacity)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere, eVision.EC24 color)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DSphere sphere)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DBox box, eVision.EC24 color, int opacity)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DBox box, eVision.EC24 color)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DBox box)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DLine line, eVision.EC24 color)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DLine line)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DPlane plane, eVision.EC24 color, int opacity)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DPlane plane, eVision.EC24 color)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None SetRenderSource (self, str name, eVision.Easy3D.E3DPlane plane)
 Changes the content of a render source with a new point cloud, mesh or ZMap.
None RemoveRenderSource (self, str name)
 Removes the given render source.
None RemoveAllRenderSources (self)
 Removes all render sources.
bool HasRenderSource (self, str name)
 Is the given render source name exists ?
str GetRenderSourceName (self, int index)
 Returns the name of the ith render source.
None HideRenderSource (self, str name)
 Hides the given render source.
None ShowRenderSource (self, str name)
 Shows the given render source.
bool IsRenderSourceVisible (self, str name)
 Returns true if the render source is currently visible.
bool IsShapeRenderSource (self, str name)
 Returns true if the render source is a shape.
None SetRenderSourceColorMode (self, str name, eVision.Easy3D.ESourceColorMode colorMode)
 Sets the Source Color Mode.
eVision.Easy3D.ESourceColorMode GetRenderSourceColorMode (self, str name)
 Gets the Source Color Mode.
None SetRenderSourceConstantColor (self, str name, eVision.EC24 color)
 Sets the constant color used to display a point cloud or a mesh, when eVision.Easy3D.ESourceColorMode is set to eVision.Easy3D.ESourceColorMode.Constant.
eVision.EC24 GetRenderSourceConstantColor (self, str name)
 Gets the constant color used to display a point cloud or a mesh, when eVision.Easy3D.ESourceColorMode is set to eVision.Easy3D.ESourceColorMode.Constant.
None SetRenderSourceOpacity (self, str name, int opacity)
 Sets the opacity used to display the render source.
int GetRenderSourceOpacity (self, str name)
 Gets the opacity used to display the render source.
None SetRenderSourcePointSize (self, str name, int size)
 Sets the point size used to display the point clouds.
int GetRenderSourcePointSize (self, str name)
 Gets the point size used to display the point clouds.
None SetRenderSourceWireFrame (self, str name, bool state)
 Sets the wireframe mode used to render a mesh.
bool GetRenderSourceWireFrame (self, str name)
 Gets the wireframe mode used to render a mesh.
None SetRenderSourceWireFrameColor (self, str name, eVision.EC24 color)
 Sets the wireframe color.
eVision.EC24 GetRenderSourceWireFrameColor (self, str name)
 Gets the wireframe color.
None ConfigureRenderSource (self, eVision.Easy3D.EPointCloud sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EPointCloud sourceObject)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EMesh sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EMesh sourceObject)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap8 sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap8 sourceObject)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap16 sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap16 sourceObject)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap32f sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap32f sourceObject)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap|None sourceObject, bool keepCurrentView)
 Sets a unique 3D source to be rendered.
None ConfigureRenderSource (self, eVision.Easy3D.EZMap|None sourceObject)
 Sets a unique 3D source to be rendered.
None ClearRenderSource (self)
 Clears the 3D data, nothing will be displayed.
None GenerateColors (self, eVision.Easy3D.EColorRampMode mode)
 Choose the current color ramp mode.
None ShowColorRampLegend (self)
 Enables the display of a color ramp legend.
None HideColorRampLegend (self)
 Disables the display of a color ramp legend.
bool IsColorRampLegendVisible (self)
 Whether the color ramp legend is visible or not.
None SetColorRampLocation (self, eVision.EPoint botLeft, eVision.EPoint topRight)
 Sets the location of the color ramp.
None GetColorRampLocation (self, eVision.EPoint botLeft, eVision.EPoint topRight)
 Gets the location of the color ramp.
None DisableFixColorRampBounds (self)
 Disables the fix color ramp bounds.
None LockRotationInitialPosition (self, int x, int y)
 Starts a rotation transformation of the view point using the (x,y) coordinate.
None UpdateRotationPosition (self, int x, int y)
 Updates a rotation transformation of the view point using the (x,y) coordinate.
None LockRotationFinalPosition (self, int x, int y)
 Finalizes a rotation transformation of the view point using the (x,y) coordinate.
None LockTranslationInitialPosition (self, int x, int y)
 Starts a translation transformation of the view point using the (x,y) coordinate.
None UpdateTranslationPosition (self, int x, int y)
 Updates a translation transformation of the view point using the (x,y) coordinate.
None LockTranslationFinalPosition (self, int x, int y)
 Finalizes a rotation transformation of the view point using the (x,y) coordinate.
None UpdateViewDistance (self, float delta)
 Applies a delta factor to the view distance.
None ResetView (self, eVision.Easy3D.EViewDirection viewDirection)
 Resets the view point to a view that frame the object.
None ResetView (self)
 Resets the view point to a view that frame the object.
None SetViewAngle (self, float angleX, float angleY)
 Sets view angles.
None SetRotationMatrix (self, eVision.Easy3D.E3DTransformMatrix matrix)
 Sets the view rotation matrix.
None GetRotationMatrix (self, eVision.Easy3D.E3DTransformMatrix matrix)
 Gets the view rotation matrix.
None SetPosition (self, int orgX, int orgY, int width, int height, ctypes.c_void_p hWndInsertAfter)
 Sets the position of the 3D viewer window.
None SetPosition (self, int orgX, int orgY, int width, int height)
 Sets the position of the 3D viewer window.
None Resize (self, int width, int height)
 Update the size of the 3D viewer window.
None IncPointSize (self)
 Increases the displayed point size.
None DecPointSize (self)
 Decreases the displayed point size.
None ToggleWireframeMode (self)
 Toggles the display of wireframe triangles.
None ToggleRenderAxis (self)
 Toggles the display of the axis.
None StopAutoRotate (self)
 Stops the display automatic rotation.
bool IsAutoRotate (self)
 Returns true if the auto rotation is active.
int AddTextLabel (self, eVision.Easy3D.TextLabel label)
 Adds a text label linked to an eVision.Easy3D.E3DPoint.
None EditTextLabel (self, int id, eVision.Easy3D.TextLabel label)
 Edits a text label.
eVision.Easy3D.TextLabel GetTextLabel (self, int id)
 Gets the text label information.
None RemoveTextLabel (self, int id)
 Removes a text label.
None ClearTextLabels (self)
 Removes all text labels.
None Show (self)
 Shows the viewer window, refresh the display.
None SetFocus (self)
 The viewer window takes the focus.
bool IsEDLShadingSupported (self)
 Indicates whether Eye-Dome-Lighting shading mode is supported.
None Register3DObjects (self, list[eVision._eVision.Easy3D.E3DObject] objects)
 Sets the list of eVision.Easy3D.E3DObject from which their features can be rendered.
None Add3DObjects (self, list[eVision._eVision.Easy3D.E3DObject] objects)
 Add the given eVision.Easy3D.E3DObject to the list of rendered eVision.Easy3D.E3DObject.
bool Has3DObjects (self)
 Return true if at least one 3D object is registered.
None RemoveCurrent3DObjects (self)
 Removes all eVision.Easy3D.E3DObject currently registered.
None ShowFeatureForAll3DObjects (self, eVision.Easy3D.E3DObjectFeature feature)
 Sets the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject to be rendered.
None HideFeatureForAll3DObjects (self, eVision.Easy3D.E3DObjectFeature feature)
 Sets the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject to be not rendered.
None ShowFeatureFor3DObject (self, int idx, eVision.Easy3D.E3DObjectFeature feature)
 Sets the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx to be rendered.
None HideFeatureFor3DObject (self, int idx, eVision.Easy3D.E3DObjectFeature feature)
 Sets the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx to be not rendered.
bool IsFeatureVisibleFor3DObject (self, int idx, eVision.Easy3D.E3DObjectFeature feature)
 Whether the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject si rendered or not.
None SetFeatureStyleForAll3DObjects (self, eVision.Easy3D.ERenderStyle style, eVision.Easy3D.E3DObjectFeature feature)
 Sets how the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject should be rendered.
None SetFeatureStyleFor3DObject (self, int idx, eVision.Easy3D.ERenderStyle style, eVision.Easy3D.E3DObjectFeature feature)
 Sets how the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx should be rendered.
eVision.Easy3D.ERenderStyle GetFeatureStyleFor3DObject (self, int idx, eVision.Easy3D.E3DObjectFeature feature)
 Gets how the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx should be rendered.
eVision.Easy3D.E3DPoint Pick3DPoint (self, int x, int y)
 Returns and displays the picked eVision.Easy3D.E3DPoint in the eVision.Easy3D.EPointCloud.
None ResetPicking (self)
 Resets the last picked point and disable the coordinate display.
None SetPickedPointCallBack (self, ctypes.c_void_p pickedPointCallBack, ctypes.c_void_p context, bool callCallBackWhenPointNotFound)
 Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.
None SetPickedPointCallBack (self, ctypes.c_void_p pickedPointCallBack, ctypes.c_void_p context)
 Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.
None SetPickedPointCallBack (self, ctypes.c_void_p pickedPointCallBack)
 Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.
str FontPath (self)
 Configure the TrueType font used to display text on the 3D Viewer.
 FontPath (self, str value)
 Configure the TrueType font used to display text on the 3D Viewer.
eVision.ERGBColor BackgroundColor (self)
 Sets/Gets the 3D viewer background color.
 BackgroundColor (self, eVision.ERGBColor value)
 Sets/Gets the 3D viewer background color.
int NumRenderSources (self)
 Returns the number of render sources.
eVision.Easy3D.EColorRampMode ColorRampMode (self)
 Set/Gets the current color ramp mode.
 ColorRampMode (self, eVision.Easy3D.EColorRampMode value)
 Set/Gets the current color ramp mode.
eVision.ERGBColor ColorRampGraduationColor (self)
 Sets/Gets the graduation color.
 ColorRampGraduationColor (self, eVision.ERGBColor value)
 Sets/Gets the graduation color.
bool EnableSmartColorRamp (self)
 Sets/Gets the state of the smart generation of color.
 EnableSmartColorRamp (self, bool value)
 Sets/Gets the state of the smart generation of color.
bool EnableFixColorRampBounds (self)
 Gets the state of the fix color ramp bounds.
eVision.EFloatRange FixColorRampBounds (self)
 Gets/Sets the bounds of the color ramp.
 FixColorRampBounds (self, eVision.EFloatRange value)
 Gets/Sets the bounds of the color ramp.
eVision.Easy3D.E3DPoint ViewTarget (self)
 Gets/Sets view target position (by default, the camera position is 'look at center of the point cloud').
 ViewTarget (self, eVision.Easy3D.E3DPoint value)
 Gets/Sets view target position (by default, the camera position is 'look at center of the point cloud').
eVision.Easy3D.E3DPoint ViewAngle (self)
 Gets/Sets view angles.
 ViewAngle (self, eVision.Easy3D.E3DPoint value)
 Gets/Sets view angles.
float ViewDistance (self)
 Sets/Gets view distance.
 ViewDistance (self, float value)
 Sets/Gets view distance.
int PointSize (self)
 Displays size of the points, in pixels.
 PointSize (self, int value)
 Displays size of the points, in pixels.
int RenderDecimationLevel (self)
 Sets or Gets the point cloud decimation level used during the rendering.
 RenderDecimationLevel (self, int value)
 Sets or Gets the point cloud decimation level used during the rendering.
bool WireframeMode (self)
 Enables or disables the display of wireframe triangles.
 WireframeMode (self, bool value)
 Enables or disables the display of wireframe triangles.
bool RenderAxis (self)
 Enables or disables the display of the axis.
 RenderAxis (self, bool value)
 Enables or disables the display of the axis.
eVision.Easy3D.EAxisOriginMode AxisOrigin (self)
 Sets and Gets the axis origin mode.
 AxisOrigin (self, eVision.Easy3D.EAxisOriginMode value)
 Sets and Gets the axis origin mode.
bool RenderGrid (self)
 Enables or disables the display of Grid.
 RenderGrid (self, bool value)
 Enables or disables the display of Grid.
float RenderGridStep (self)
 Sets/Gets the same grid step for each axis.
 RenderGridStep (self, float value)
 Sets/Gets the same grid step for each axis.
eVision.Easy3D.E3DAxisDisplay RenderAxisConfiguration (self)
 Sets/Gets the axis configuration.
 RenderAxisConfiguration (self, eVision.Easy3D.E3DAxisDisplay value)
 Sets/Gets the axis configuration.
eVision.Easy3D.E3DPoint AutoRotate (self)
 Retrieves, enables and configures the auto rotate display.
 AutoRotate (self, eVision.Easy3D.E3DPoint value)
 Retrieves, enables and configures the auto rotate display.
float FieldOfView (self)
 Sets/Gets the field of view.
 FieldOfView (self, float value)
 Sets/Gets the field of view.
eVision.Easy3D.EProjectionType ProjectionType (self)
 Sets/Gets the projection type.
 ProjectionType (self, eVision.Easy3D.EProjectionType value)
 Sets/Gets the projection type.
bool EnableEDLShading (self)
 Gets/Sets if Eye-Dome-Lighting shading mode is enabled.
 EnableEDLShading (self, bool value)
 Gets/Sets if Eye-Dome-Lighting shading mode is enabled.
float EDLShadingFactor (self)
 Gets/Sets how strong Eye-Dome-Lighting shading is.
 EDLShadingFactor (self, float value)
 Gets/Sets how strong Eye-Dome-Lighting shading is.
int Num3DObjects (self)
 Return the number of 3D objects registered.
bool PickingDisplay (self)
 Enables or disables the display of the picked point.
 PickingDisplay (self, bool value)
 Enables or disables the display of the picked point.
float PickingLabelSize (self)
 Sets or gets the size of the picked point label.
 PickingLabelSize (self, float value)
 Sets or gets the size of the picked point label.
eVision.EC24 PickingLabelColor (self)
 Sets or gets the color of the picked point label.
 PickingLabelColor (self, eVision.EC24 value)
 Sets or gets the color of the picked point label.
bool PickingLabelFixed (self)
 Sets or gets the state to fix or not the label.
 PickingLabelFixed (self, bool value)
 Sets or gets the state to fix or not the label.
float PickingDistanceThreshold (self)
 Sets or gets the distance threshold for the picking.
 PickingDistanceThreshold (self, float value)
 Sets or gets the distance threshold for the picking.
eVision.Easy3D.E3DPoint LastPickedPoint (self)
 Returns the last picked eVision.Easy3D.E3DPoint if there is one.

Detailed Description

Manages a viewer window for eVision.Easy3D.EPointCloud.

Remarks:

Call to eVision.Easy3D.E3DViewer.Terminate is mandatory after usage to ensure all resources used by this class are properly released.

License(s): Easy3D

Constructor & Destructor Documentation

◆ __init__() [1/6]

None eVision.Easy3D.E3DViewer.__init__ ( self,
int orgX,
int orgY,
int width,
int height,
ctypes.c_void_p parent )

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Parameters
orgXX coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
orgYY coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
widthWidth of the viewer window (only if uiApi is EUIAPI_Win32).
heightHeight of the viewer window (only if uiApi is EUIAPI_Win32).
parentHandle of the parent window of the viewer. If NULL, the viewer is built as a independent floating window (only if uiApi is EUIAPI_Win32).

◆ __init__() [2/6]

None eVision.Easy3D.E3DViewer.__init__ ( self,
int orgX,
int orgY,
int width,
int height )

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Parameters
orgXX coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
orgYY coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
widthWidth of the viewer window (only if uiApi is EUIAPI_Win32).
heightHeight of the viewer window (only if uiApi is EUIAPI_Win32).

◆ __init__() [3/6]

None eVision.Easy3D.E3DViewer.__init__ ( self,
eVision.Easy3D.EUIAPI uiApi,
int orgX,
int orgY,
int width,
int height,
ctypes.c_void_p parent )

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Parameters
uiApiThe User Interface API used by the parent application. See eVision.Easy3D.EUIAPI.
orgXX coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
orgYY coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
widthWidth of the viewer window (only if uiApi is EUIAPI_Win32).
heightHeight of the viewer window (only if uiApi is EUIAPI_Win32).
parentHandle of the parent window of the viewer. If NULL, the viewer is built as a independent floating window (only if uiApi is EUIAPI_Win32).

◆ __init__() [4/6]

None eVision.Easy3D.E3DViewer.__init__ ( self,
eVision.Easy3D.EUIAPI uiApi,
int orgX,
int orgY,
int width,
int height )

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Parameters
uiApiThe User Interface API used by the parent application. See eVision.Easy3D.EUIAPI.
orgXX coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
orgYY coordinate of the top left corner of the viewer window (only if uiApi is EUIAPI_Win32).
widthWidth of the viewer window (only if uiApi is EUIAPI_Win32).
heightHeight of the viewer window (only if uiApi is EUIAPI_Win32).

◆ __init__() [5/6]

None eVision.Easy3D.E3DViewer.__init__ ( self,
eVision.Easy3D.EUIAPI uiApi )

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Parameters
uiApiThe User Interface API used by the parent application. See eVision.Easy3D.EUIAPI.

◆ __init__() [6/6]

None eVision.Easy3D.E3DViewer.__init__ ( self)

Creates an eVision.Easy3D.E3DViewer object.

Remarks:

The origin point (orgX, orgY) defines the offset of the top left corner of the viewer from the top left corner of its parent window client area. If the window has no parent, it defines the offset from the top left corner of the screen. If the parent window is too small to contain the viewer, the viewer will be cropped accordingly.

When the parent application that use eVision.Easy3D.E3DViewer is a Qt application, call the constructor with EUIAPI_Qt.

Member Function Documentation

◆ Add3DObjects()

None eVision.Easy3D.E3DViewer.Add3DObjects ( self,
list[eVision._eVision.Easy3D.E3DObject] objects )

Add the given eVision.Easy3D.E3DObject to the list of rendered eVision.Easy3D.E3DObject.

Remarks:

The features that need to be visualize are set with show methods. The registered features have a default style. Previously set styles are ignored. Objects in which eVision.Easy3D.E3DObjectFeature.BoundingBox was not computed are ignored.

Parameters
objectsList of eVision.Easy3D.E3DObject

◆ AddRenderSource() [1/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
boxAn eVision.Easy3D.E3DBox to be added as render source.

◆ AddRenderSource() [2/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box,
eVision.EC24 color )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
boxAn eVision.Easy3D.E3DBox to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [3/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box,
eVision.EC24 color,
int opacity )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
boxAn eVision.Easy3D.E3DBox to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [4/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DLine line )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
lineAn eVision.Easy3D.E3DLine to be added as render source.

◆ AddRenderSource() [5/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DLine line,
eVision.EC24 color )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
lineAn eVision.Easy3D.E3DLine to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [6/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
planeAn eVision.Easy3D.E3DPlane to be added as render source.

◆ AddRenderSource() [7/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane,
eVision.EC24 color )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
planeAn eVision.Easy3D.E3DPlane to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [8/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane,
eVision.EC24 color,
int opacity )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
planeAn eVision.Easy3D.E3DPlane to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [9/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sphereAn eVision.Easy3D.E3DSphere to be added as render source.

◆ AddRenderSource() [10/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere,
eVision.EC24 color )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sphereAn eVision.Easy3D.E3DSphere to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [11/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere,
eVision.EC24 color,
int opacity )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sphereAn eVision.Easy3D.E3DSphere to be added as render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ AddRenderSource() [12/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.EMesh source )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sourceAn eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh or eVision.Easy3D.EZMap to be added as render source.

◆ AddRenderSource() [13/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.EPointCloud source )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sourceAn eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh or eVision.Easy3D.EZMap to be added as render source.

◆ AddRenderSource() [14/14]

None eVision.Easy3D.E3DViewer.AddRenderSource ( self,
str name,
eVision.Easy3D.EZMap | None source )

Adds a new Render Source.

The given render source (point cloud, mesh, ZMap, sphere, box, plane or line) is added to the current display.

Parameters
nameA name for the render source, to be used to access and configure the render source.
sourceAn eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh or eVision.Easy3D.EZMap to be added as render source.

◆ AddTextLabel()

int eVision.Easy3D.E3DViewer.AddTextLabel ( self,
eVision.Easy3D.TextLabel label )

Adds a text label linked to an eVision.Easy3D.E3DPoint.

Remarks:

See also eVision.Easy3D.E3DViewer.EditTextLabel. and eVision.Easy3D.E3DViewer.GetTextLabel.

Parameters
labelThe label to add.

◆ AutoRotate() [1/2]

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DViewer.AutoRotate ( self)

Retrieves, enables and configures the auto rotate display.

◆ AutoRotate() [2/2]

eVision.Easy3D.E3DViewer.AutoRotate ( self,
eVision.Easy3D.E3DPoint value )

Retrieves, enables and configures the auto rotate display.

◆ AxisOrigin() [1/2]

eVision.Easy3D.EAxisOriginMode eVision.Easy3D.E3DViewer.AxisOrigin ( self)

Sets and Gets the axis origin mode.

Remarks:

The default mode is eVision.Easy3D.EAxisOriginMode.BoundingBoxOrigin.

◆ AxisOrigin() [2/2]

eVision.Easy3D.E3DViewer.AxisOrigin ( self,
eVision.Easy3D.EAxisOriginMode value )

Sets and Gets the axis origin mode.

Remarks:

The default mode is eVision.Easy3D.EAxisOriginMode.BoundingBoxOrigin.

◆ BackgroundColor() [1/2]

eVision.ERGBColor eVision.Easy3D.E3DViewer.BackgroundColor ( self)

Sets/Gets the 3D viewer background color.

◆ BackgroundColor() [2/2]

eVision.Easy3D.E3DViewer.BackgroundColor ( self,
eVision.ERGBColor value )

Sets/Gets the 3D viewer background color.

◆ ClearRenderSource()

None eVision.Easy3D.E3DViewer.ClearRenderSource ( self)

Clears the 3D data, nothing will be displayed.

Remarks:

See also eVision.Easy3D.E3DViewer.ConfigureRenderSource

◆ ClearTextLabels()

None eVision.Easy3D.E3DViewer.ClearTextLabels ( self)

Removes all text labels.

◆ ColorRampGraduationColor() [1/2]

eVision.ERGBColor eVision.Easy3D.E3DViewer.ColorRampGraduationColor ( self)

Sets/Gets the graduation color.

Remarks:

The default color is white.

◆ ColorRampGraduationColor() [2/2]

eVision.Easy3D.E3DViewer.ColorRampGraduationColor ( self,
eVision.ERGBColor value )

Sets/Gets the graduation color.

Remarks:

The default color is white.

◆ ColorRampMode() [1/2]

eVision.Easy3D.EColorRampMode eVision.Easy3D.E3DViewer.ColorRampMode ( self)

Set/Gets the current color ramp mode.

◆ ColorRampMode() [2/2]

eVision.Easy3D.E3DViewer.ColorRampMode ( self,
eVision.Easy3D.EColorRampMode value )

Set/Gets the current color ramp mode.

◆ ConfigureRenderSource() [1/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EMesh sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [2/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EMesh sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ ConfigureRenderSource() [3/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EPointCloud sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [4/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EPointCloud sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ ConfigureRenderSource() [5/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap16 sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [6/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap16 sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ ConfigureRenderSource() [7/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap32f sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [8/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap32f sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ ConfigureRenderSource() [9/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap8 sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [10/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap8 sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ ConfigureRenderSource() [11/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap | None sourceObject )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.

◆ ConfigureRenderSource() [12/12]

None eVision.Easy3D.E3DViewer.ConfigureRenderSource ( self,
eVision.Easy3D.EZMap | None sourceObject,
bool keepCurrentView )

Sets a unique 3D source to be rendered.

It replaces the current object.

Remarks:

For display performance purposes, the object geometry is copied into the viewer.

Subsequent modifications on the object will thus not be visible until a new call to eVision.Easy3D.E3DViewer.ConfigureRenderSource has been made.

The initial viewing position looks at the object center.

Parameters
sourceObjectA 3D source (eVision.Easy3D.EPointCloud, eVision.Easy3D.EMesh, eVision.Easy3D.EZMap) to render.
keepCurrentViewAn optional boolean, use true to keep the current view or false to reset the view and center the new object.

The default value resets the view.

◆ DecPointSize()

None eVision.Easy3D.E3DViewer.DecPointSize ( self)

Decreases the displayed point size.

◆ DisableFixColorRampBounds()

None eVision.Easy3D.E3DViewer.DisableFixColorRampBounds ( self)

Disables the fix color ramp bounds.

Remarks:

See also eVision.Easy3D.E3DViewer.FixColorRampBounds

◆ EditTextLabel()

None eVision.Easy3D.E3DViewer.EditTextLabel ( self,
int id,
eVision.Easy3D.TextLabel label )

Edits a text label.

Remarks:

See also eVision.Easy3D.E3DViewer.AddTextLabel and eVision.Easy3D.E3DViewer.GetTextLabel.

If you want to modify only a subset of the fields of a eVision.Easy3D.TextLabel, please call eVision.Easy3D.E3DViewer.GetTextLabel, modify the eVision.Easy3D.TextLabel and then pass it to eVision.Easy3D.E3DViewer.EditTextLabel.

Parameters
idThe id of the text label to edit.
labelThe new value of the label.

◆ EDLShadingFactor() [1/2]

float eVision.Easy3D.E3DViewer.EDLShadingFactor ( self)

Gets/Sets how strong Eye-Dome-Lighting shading is.

In this mode, every pixel is shaded by how much closer its neighbor pixels are to the camera.

Remarks:

Factor value ranges between 0 and 1. 0 means no shading, 1 means the strongest shading.

◆ EDLShadingFactor() [2/2]

eVision.Easy3D.E3DViewer.EDLShadingFactor ( self,
float value )

Gets/Sets how strong Eye-Dome-Lighting shading is.

In this mode, every pixel is shaded by how much closer its neighbor pixels are to the camera.

Remarks:

Factor value ranges between 0 and 1. 0 means no shading, 1 means the strongest shading.

◆ EnableEDLShading() [1/2]

bool eVision.Easy3D.E3DViewer.EnableEDLShading ( self)

Gets/Sets if Eye-Dome-Lighting shading mode is enabled.

In this mode, every pixel is shaded by how much closer its neighbor pixels are to the camera.

Remarks:

Enabling Eye-Dome-Lighting shading has no effect when eVision.Easy3D.E3DViewer.IsEDLShadingSupported is equal to false.

◆ EnableEDLShading() [2/2]

eVision.Easy3D.E3DViewer.EnableEDLShading ( self,
bool value )

Gets/Sets if Eye-Dome-Lighting shading mode is enabled.

In this mode, every pixel is shaded by how much closer its neighbor pixels are to the camera.

Remarks:

Enabling Eye-Dome-Lighting shading has no effect when eVision.Easy3D.E3DViewer.IsEDLShadingSupported is equal to false.

◆ EnableFixColorRampBounds()

bool eVision.Easy3D.E3DViewer.EnableFixColorRampBounds ( self)

Gets the state of the fix color ramp bounds.

Remarks:

To enable fix color ramp bounds, use eVision.Easy3D.E3DViewer.FixColorRampBounds.

◆ EnableSmartColorRamp() [1/2]

bool eVision.Easy3D.E3DViewer.EnableSmartColorRamp ( self)

Sets/Gets the state of the smart generation of color.

If the smart generation of color is active, then the outliers inside the pointcloud will not be taken into account in the color ramp.

Remarks:

Default: true. When set to true, fix color ramp bounds are disabled (see also eVision.Easy3D.E3DViewer.DisableFixColorRampBounds).

◆ EnableSmartColorRamp() [2/2]

eVision.Easy3D.E3DViewer.EnableSmartColorRamp ( self,
bool value )

Sets/Gets the state of the smart generation of color.

If the smart generation of color is active, then the outliers inside the pointcloud will not be taken into account in the color ramp.

Remarks:

Default: true. When set to true, fix color ramp bounds are disabled (see also eVision.Easy3D.E3DViewer.DisableFixColorRampBounds).

◆ FieldOfView() [1/2]

float eVision.Easy3D.E3DViewer.FieldOfView ( self)

Sets/Gets the field of view.

Remarks:

If the projection type is EProjectionType_Orthographic, the field of view is not taken into account. See also eVision.Easy3D.E3DViewer.ProjectionType. For the angle unit see eVision.Easy.SetAngleUnit.

◆ FieldOfView() [2/2]

eVision.Easy3D.E3DViewer.FieldOfView ( self,
float value )

Sets/Gets the field of view.

Remarks:

If the projection type is EProjectionType_Orthographic, the field of view is not taken into account. See also eVision.Easy3D.E3DViewer.ProjectionType. For the angle unit see eVision.Easy.SetAngleUnit.

◆ FixColorRampBounds() [1/2]

eVision.EFloatRange eVision.Easy3D.E3DViewer.FixColorRampBounds ( self)

Gets/Sets the bounds of the color ramp.

Remarks:

This function also sets to false eVision.Easy3D.E3DViewer.EnableSmartColorRamp. See also eVision.Easy3D.E3DViewer.DisableFixColorRampBounds

◆ FixColorRampBounds() [2/2]

eVision.Easy3D.E3DViewer.FixColorRampBounds ( self,
eVision.EFloatRange value )

Gets/Sets the bounds of the color ramp.

Remarks:

This function also sets to false eVision.Easy3D.E3DViewer.EnableSmartColorRamp. See also eVision.Easy3D.E3DViewer.DisableFixColorRampBounds

◆ FontPath() [1/2]

str eVision.Easy3D.E3DViewer.FontPath ( self)

Configure the TrueType font used to display text on the 3D Viewer.

Remarks:

Setup a font file must be done before the eVision.Easy3D.E3DViewer.InitRendering method is called.

By default, the TTF file is:

  • on Windows: C:\Windows\Fonts\Arial.ttf
  • on Linux: /usr/share/fonts/liberation-sans/LiberationSans-Regular.ttf or
    • /usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf" or - /usr/share/fonts/truetype/noto/NotoMono-Regular.ttf"

◆ FontPath() [2/2]

eVision.Easy3D.E3DViewer.FontPath ( self,
str value )

Configure the TrueType font used to display text on the 3D Viewer.

Remarks:

Setup a font file must be done before the eVision.Easy3D.E3DViewer.InitRendering method is called.

By default, the TTF file is:

  • on Windows: C:\Windows\Fonts\Arial.ttf
  • on Linux: /usr/share/fonts/liberation-sans/LiberationSans-Regular.ttf or
    • /usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf" or - /usr/share/fonts/truetype/noto/NotoMono-Regular.ttf"

◆ GenerateColors()

None eVision.Easy3D.E3DViewer.GenerateColors ( self,
eVision.Easy3D.EColorRampMode mode )

Choose the current color ramp mode.

Colors are calculated from point coordinates or attributes, several mappings are exposed in eVision.Easy3D.EColorRampMode.

Deprecated

Use eVision.Easy3D.E3DViewer.ColorRampMode.

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

Parameters
modeThe color ramp mode from eVision.Easy3D.EColorRampMode.

◆ GetColorRampLocation()

None eVision.Easy3D.E3DViewer.GetColorRampLocation ( self,
eVision.EPoint botLeft,
eVision.EPoint topRight )

Gets the location of the color ramp.

Parameters
botLeftThe left most and bottom most point of the color ramp.
topRightThe right most and top most point of the color ramp.

◆ GetFeatureStyleFor3DObject()

eVision.Easy3D.ERenderStyle eVision.Easy3D.E3DViewer.GetFeatureStyleFor3DObject ( self,
int idx,
eVision.Easy3D.E3DObjectFeature feature )

Gets how the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx should be rendered.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, its feature style has no effect.

Parameters
idxthe position in the list of registered eVision.Easy3D.E3DObject
featurethe feature

◆ GetRenderSourceColorMode()

eVision.Easy3D.ESourceColorMode eVision.Easy3D.E3DViewer.GetRenderSourceColorMode ( self,
str name )

Gets the Source Color Mode.

The Source Color Mode defines how the colors of the point cloud or mesh are chosen. See eVision.Easy3D.ESourceColorMode.

Remarks:

See also eVision.Easy3D.E3DViewer.GetRenderSourceConstantColor and eVision.Easy3D.E3DViewer.GenerateColors.

Parameters
nameThe name of the render source to be considered.

◆ GetRenderSourceConstantColor()

eVision.EC24 eVision.Easy3D.E3DViewer.GetRenderSourceConstantColor ( self,
str name )

Gets the constant color used to display a point cloud or a mesh, when eVision.Easy3D.ESourceColorMode is set to eVision.Easy3D.ESourceColorMode.Constant.

Remarks:

See also eVision.Easy3D.E3DViewer.GetRenderSourceColorMode.

Parameters
nameThe name of the render source to be considered.

◆ GetRenderSourceName()

str eVision.Easy3D.E3DViewer.GetRenderSourceName ( self,
int index )

Returns the name of the ith render source.

Remarks:

The number of render sources is given by eVision.Easy3D.E3DViewer.NumRenderSources.

Parameters
indexThe index of the render source to consider.

◆ GetRenderSourceOpacity()

int eVision.Easy3D.E3DViewer.GetRenderSourceOpacity ( self,
str name )

Gets the opacity used to display the render source.

Only compatible with eVision.Easy3D.ESourceColorMode.Constant.

Parameters
nameThe name of the render source to be considered.

◆ GetRenderSourcePointSize()

int eVision.Easy3D.E3DViewer.GetRenderSourcePointSize ( self,
str name )

Gets the point size used to display the point clouds.

Parameters
nameThe name of the render source to be considered.

◆ GetRenderSourceWireFrame()

bool eVision.Easy3D.E3DViewer.GetRenderSourceWireFrame ( self,
str name )

Gets the wireframe mode used to render a mesh.

Parameters
nameThe name of the render source to be considered.

◆ GetRenderSourceWireFrameColor()

eVision.EC24 eVision.Easy3D.E3DViewer.GetRenderSourceWireFrameColor ( self,
str name )

Gets the wireframe color.

Parameters
nameThe name of the render source to be considered.

◆ GetRotationMatrix()

None eVision.Easy3D.E3DViewer.GetRotationMatrix ( self,
eVision.Easy3D.E3DTransformMatrix matrix )

Gets the view rotation matrix.

Parameters
matrixA matrix representing the view orientation.

◆ GetTextLabel()

eVision.Easy3D.TextLabel eVision.Easy3D.E3DViewer.GetTextLabel ( self,
int id )

Gets the text label information.

Remarks:

See also eVision.Easy3D.E3DViewer.AddTextLabel and eVision.Easy3D.E3DViewer.EditTextLabel.

Parameters
idThe id of the text label.

◆ Has3DObjects()

bool eVision.Easy3D.E3DViewer.Has3DObjects ( self)

Return true if at least one 3D object is registered.

Remarks:

See also eVision.Easy3D.E3DViewer.Register3DObjects.

◆ HasRenderSource()

bool eVision.Easy3D.E3DViewer.HasRenderSource ( self,
str name )

Is the given render source name exists ?

Parameters
nameThe name of the render source to be checked.

◆ HideColorRampLegend()

None eVision.Easy3D.E3DViewer.HideColorRampLegend ( self)

Disables the display of a color ramp legend.

Remarks:

See also eVision.Easy3D.E3DViewer.ShowColorRampLegend.

◆ HideFeatureFor3DObject()

None eVision.Easy3D.E3DViewer.HideFeatureFor3DObject ( self,
int idx,
eVision.Easy3D.E3DObjectFeature feature )

Sets the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx to be not rendered.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, this has no effect.

Parameters
idxthe position in the list of registered eVision.Easy3D.E3DObject
featurethe feature

◆ HideFeatureForAll3DObjects()

None eVision.Easy3D.E3DViewer.HideFeatureForAll3DObjects ( self,
eVision.Easy3D.E3DObjectFeature feature )

Sets the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject to be not rendered.

Parameters
featurethe feature

◆ HideRenderSource()

None eVision.Easy3D.E3DViewer.HideRenderSource ( self,
str name )

Hides the given render source.

Remarks:

See also eVision.Easy3D.E3DViewer.ShowRenderSource.

Parameters
nameThe name of the render source.

◆ IncPointSize()

None eVision.Easy3D.E3DViewer.IncPointSize ( self)

Increases the displayed point size.

◆ InitRendering()

None eVision.Easy3D.E3DViewer.InitRendering ( self)

Initializes the rendering state, must be called one time before the first eVision.Easy3D.E3DViewer.Show.

◆ IsAutoRotate()

bool eVision.Easy3D.E3DViewer.IsAutoRotate ( self)

Returns true if the auto rotation is active.

◆ IsColorRampLegendVisible()

bool eVision.Easy3D.E3DViewer.IsColorRampLegendVisible ( self)

Whether the color ramp legend is visible or not.

Remarks:

See also eVision.Easy3D.E3DViewer.ShowColorRampLegend and eVision.Easy3D.E3DViewer.HideColorRampLegend.

◆ IsEDLShadingSupported()

bool eVision.Easy3D.E3DViewer.IsEDLShadingSupported ( self)

Indicates whether Eye-Dome-Lighting shading mode is supported.

Remarks:

Support of Eye-Dome-Lighting shading is detected when eVision.Easy3D.E3DViewer.InitRendering is called. Before, this method will always return false.

◆ IsFeatureVisibleFor3DObject()

bool eVision.Easy3D.E3DViewer.IsFeatureVisibleFor3DObject ( self,
int idx,
eVision.Easy3D.E3DObjectFeature feature )

Whether the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject si rendered or not.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, the visibility of the feature has no effect.

Parameters
idxthe position in the list of registered eVision.Easy3D.E3DObject
featurethe feature

◆ IsInitialized()

bool eVision.Easy3D.E3DViewer.IsInitialized ( self)

Indicates if 3DViewer has already been initialized.

◆ IsRenderSourceVisible()

bool eVision.Easy3D.E3DViewer.IsRenderSourceVisible ( self,
str name )

Returns true if the render source is currently visible.

Remarks:

See also eVision.Easy3D.E3DViewer.ShowRenderSource and eVision.Easy3D.E3DViewer.HideRenderSource.

Parameters
nameThe name of the render source to be queried.

◆ IsShapeRenderSource()

bool eVision.Easy3D.E3DViewer.IsShapeRenderSource ( self,
str name )

Returns true if the render source is a shape.

Parameters
nameThe name of the render source to be queried.

◆ LastPickedPoint()

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DViewer.LastPickedPoint ( self)

Returns the last picked eVision.Easy3D.E3DPoint if there is one.

Otherwise, it throws an eVision.EException.

◆ LockRotationFinalPosition()

None eVision.Easy3D.E3DViewer.LockRotationFinalPosition ( self,
int x,
int y )

Finalizes a rotation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when a button is released.

Remarks:

See also eVision.Easy3D.E3DViewer.LockRotationInitialPosition and eVision.Easy3D.E3DViewer.UpdateRotationPosition.

Parameters
xX coordinate.
yY coordinate.

◆ LockRotationInitialPosition()

None eVision.Easy3D.E3DViewer.LockRotationInitialPosition ( self,
int x,
int y )

Starts a rotation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when a button is pressed.

Remarks:

See also eVision.Easy3D.E3DViewer.UpdateRotationPosition and eVision.Easy3D.E3DViewer.LockRotationFinalPosition.

Parameters
xX coordinate.
yY coordinate.

◆ LockTranslationFinalPosition()

None eVision.Easy3D.E3DViewer.LockTranslationFinalPosition ( self,
int x,
int y )

Finalizes a rotation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when a button is released.

Remarks:

See also eVision.Easy3D.E3DViewer.LockTranslationInitialPosition and eVision.Easy3D.E3DViewer.UpdateTranslationPosition.

Parameters
xX coordinate.
yY coordinate.

◆ LockTranslationInitialPosition()

None eVision.Easy3D.E3DViewer.LockTranslationInitialPosition ( self,
int x,
int y )

Starts a translation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when a button is pressed.

Remarks:

See also eVision.Easy3D.E3DViewer.UpdateTranslationPosition and eVision.Easy3D.E3DViewer.LockTranslationFinalPosition.

Parameters
xX coordinate.
yY coordinate.

◆ Num3DObjects()

int eVision.Easy3D.E3DViewer.Num3DObjects ( self)

Return the number of 3D objects registered.

Remarks:

See also eVision.Easy3D.E3DViewer.Register3DObjects.

◆ NumRenderSources()

int eVision.Easy3D.E3DViewer.NumRenderSources ( self)

Returns the number of render sources.

Remarks:

See also eVision.Easy3D.E3DViewer.GetRenderSourceName.

◆ Pick3DPoint()

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DViewer.Pick3DPoint ( self,
int x,
int y )

Returns and displays the picked eVision.Easy3D.E3DPoint in the eVision.Easy3D.EPointCloud.

Remarks:

If there is no point close enough to the picking ray, an eVision.EException is thrown (see also eVision.Easy3D.E3DViewer.PickingDistanceThreshold). If a callback function is configured (see eVision.Easy3D.E3DViewer.SetPickedPointCallBack), then no eVision.EException is thrown when there is no point found.

Parameters
xThe X pixel coordinate in the 3DViewer windows
yThe Y pixel coordinate in the 3DViewer windows

◆ PickingDisplay() [1/2]

bool eVision.Easy3D.E3DViewer.PickingDisplay ( self)

◆ PickingDisplay() [2/2]

eVision.Easy3D.E3DViewer.PickingDisplay ( self,
bool value )

◆ PickingDistanceThreshold() [1/2]

float eVision.Easy3D.E3DViewer.PickingDistanceThreshold ( self)

Sets or gets the distance threshold for the picking.

Remarks:

See also eVision.Easy3D.E3DViewer.Pick3DPoint.

◆ PickingDistanceThreshold() [2/2]

eVision.Easy3D.E3DViewer.PickingDistanceThreshold ( self,
float value )

Sets or gets the distance threshold for the picking.

Remarks:

See also eVision.Easy3D.E3DViewer.Pick3DPoint.

◆ PickingLabelColor() [1/2]

eVision.EC24 eVision.Easy3D.E3DViewer.PickingLabelColor ( self)

◆ PickingLabelColor() [2/2]

eVision.Easy3D.E3DViewer.PickingLabelColor ( self,
eVision.EC24 value )

◆ PickingLabelFixed() [1/2]

bool eVision.Easy3D.E3DViewer.PickingLabelFixed ( self)

Sets or gets the state to fix or not the label.

Remarks:

Default state is false.

See also eVision.Easy3D.E3DViewer.PickingDisplay, eVision.Easy3D.E3DViewer.PickingLabelSize and eVision.Easy3D.E3DViewer.PickingLabelColor.

◆ PickingLabelFixed() [2/2]

eVision.Easy3D.E3DViewer.PickingLabelFixed ( self,
bool value )

Sets or gets the state to fix or not the label.

Remarks:

Default state is false.

See also eVision.Easy3D.E3DViewer.PickingDisplay, eVision.Easy3D.E3DViewer.PickingLabelSize and eVision.Easy3D.E3DViewer.PickingLabelColor.

◆ PickingLabelSize() [1/2]

float eVision.Easy3D.E3DViewer.PickingLabelSize ( self)

Sets or gets the size of the picked point label.

Remarks:

Default value for size is 0.05.

See also eVision.Easy3D.E3DViewer.PickingDisplay, eVision.Easy3D.E3DViewer.PickingLabelFixed and eVision.Easy3D.E3DViewer.PickingLabelColor.

◆ PickingLabelSize() [2/2]

eVision.Easy3D.E3DViewer.PickingLabelSize ( self,
float value )

Sets or gets the size of the picked point label.

Remarks:

Default value for size is 0.05.

See also eVision.Easy3D.E3DViewer.PickingDisplay, eVision.Easy3D.E3DViewer.PickingLabelFixed and eVision.Easy3D.E3DViewer.PickingLabelColor.

◆ PointSize() [1/2]

int eVision.Easy3D.E3DViewer.PointSize ( self)

Displays size of the points, in pixels.

Remarks:

The size of the point (range value is 1 to 5 pixels, and 2 by default).

This value is used only to draw an eVision.Easy3D.EPointCloud, not for an eVision.Easy3D.EMesh.

◆ PointSize() [2/2]

eVision.Easy3D.E3DViewer.PointSize ( self,
int value )

Displays size of the points, in pixels.

Remarks:

The size of the point (range value is 1 to 5 pixels, and 2 by default).

This value is used only to draw an eVision.Easy3D.EPointCloud, not for an eVision.Easy3D.EMesh.

◆ ProjectionType() [1/2]

eVision.Easy3D.EProjectionType eVision.Easy3D.E3DViewer.ProjectionType ( self)

Sets/Gets the projection type.

Remarks:

If the projection type is EProjectionType_Perspective, then the field of view can be set with the method eVision.Easy3D.E3DViewer.FieldOfView.

◆ ProjectionType() [2/2]

eVision.Easy3D.E3DViewer.ProjectionType ( self,
eVision.Easy3D.EProjectionType value )

Sets/Gets the projection type.

Remarks:

If the projection type is EProjectionType_Perspective, then the field of view can be set with the method eVision.Easy3D.E3DViewer.FieldOfView.

◆ Register3DObjects()

None eVision.Easy3D.E3DViewer.Register3DObjects ( self,
list[eVision._eVision.Easy3D.E3DObject] objects )

Sets the list of eVision.Easy3D.E3DObject from which their features can be rendered.

Remarks:

The features that need to be visualize are set with show methods. The registered features have a default style. Previously set styles are ignored. Removes the currently registered eVision.Easy3D.E3DObject. Objects in which eVision.Easy3D.E3DObjectFeature.BoundingBox was not computed are ignored.

Parameters
objectsList of eVision.Easy3D.E3DObject

◆ RemoveAllRenderSources()

None eVision.Easy3D.E3DViewer.RemoveAllRenderSources ( self)

Removes all render sources.

The eVision.Easy3D.E3DViewer display will be empty.

◆ RemoveCurrent3DObjects()

None eVision.Easy3D.E3DViewer.RemoveCurrent3DObjects ( self)

Removes all eVision.Easy3D.E3DObject currently registered.

◆ RemoveRenderSource()

None eVision.Easy3D.E3DViewer.RemoveRenderSource ( self,
str name )

Removes the given render source.

Parameters
nameThe name of the render source to be changed.

◆ RemoveTextLabel()

None eVision.Easy3D.E3DViewer.RemoveTextLabel ( self,
int id )

Removes a text label.

Remarks:

See also eVision.Easy3D.E3DViewer.AddTextLabel.

Parameters
idThe id of the text label.

◆ RenderAxis() [1/2]

bool eVision.Easy3D.E3DViewer.RenderAxis ( self)

Enables or disables the display of the axis.

Remarks:

The default state is true.

◆ RenderAxis() [2/2]

eVision.Easy3D.E3DViewer.RenderAxis ( self,
bool value )

Enables or disables the display of the axis.

Remarks:

The default state is true.

◆ RenderAxisConfiguration() [1/2]

eVision.Easy3D.E3DAxisDisplay eVision.Easy3D.E3DViewer.RenderAxisConfiguration ( self)

Sets/Gets the axis configuration.

◆ RenderAxisConfiguration() [2/2]

eVision.Easy3D.E3DViewer.RenderAxisConfiguration ( self,
eVision.Easy3D.E3DAxisDisplay value )

Sets/Gets the axis configuration.

◆ RenderDecimationLevel() [1/2]

int eVision.Easy3D.E3DViewer.RenderDecimationLevel ( self)

Sets or Gets the point cloud decimation level used during the rendering.

Remarks:

The viewer will only render one point every [Decimation Level] points (1 by default, and need to be > 0).

This decimation depends on the order of the points in the eVision.Easy3D.EPointCloud.

Irrespectively from this parameter, the viewer decimates the rendered point clouds if it detects lags in its display.

◆ RenderDecimationLevel() [2/2]

eVision.Easy3D.E3DViewer.RenderDecimationLevel ( self,
int value )

Sets or Gets the point cloud decimation level used during the rendering.

Remarks:

The viewer will only render one point every [Decimation Level] points (1 by default, and need to be > 0).

This decimation depends on the order of the points in the eVision.Easy3D.EPointCloud.

Irrespectively from this parameter, the viewer decimates the rendered point clouds if it detects lags in its display.

◆ RenderGrid() [1/2]

bool eVision.Easy3D.E3DViewer.RenderGrid ( self)

Enables or disables the display of Grid.

Remarks:

Display Grid with true (true by default).

◆ RenderGrid() [2/2]

eVision.Easy3D.E3DViewer.RenderGrid ( self,
bool value )

Enables or disables the display of Grid.

Remarks:

Display Grid with true (true by default).

◆ RenderGridStep() [1/2]

float eVision.Easy3D.E3DViewer.RenderGridStep ( self)

Sets/Gets the same grid step for each axis.

Remarks:

The unit of the grid step value is the same as the one from the eVision.Easy3D.EPointCloud. If value is equal to 0, then the step is auto computed and if the value is smaller than 0, then there is no step on the axis.

Default value is the size of each axis divided by ten.

For the Get function, if the step is not the same for each axis, then the mean is returned.

◆ RenderGridStep() [2/2]

eVision.Easy3D.E3DViewer.RenderGridStep ( self,
float value )

Sets/Gets the same grid step for each axis.

Remarks:

The unit of the grid step value is the same as the one from the eVision.Easy3D.EPointCloud. If value is equal to 0, then the step is auto computed and if the value is smaller than 0, then there is no step on the axis.

Default value is the size of each axis divided by ten.

For the Get function, if the step is not the same for each axis, then the mean is returned.

◆ ResetPicking()

None eVision.Easy3D.E3DViewer.ResetPicking ( self)

Resets the last picked point and disable the coordinate display.

◆ ResetView() [1/2]

None eVision.Easy3D.E3DViewer.ResetView ( self)

Resets the view point to a view that frame the object.

Remarks:

The default view direction is from positive Z.

◆ ResetView() [2/2]

None eVision.Easy3D.E3DViewer.ResetView ( self,
eVision.Easy3D.EViewDirection viewDirection )

Resets the view point to a view that frame the object.

Remarks:

The default view direction is from positive Z.

Parameters
viewDirectionThe view direction from eVision.Easy3D.EViewDirection (optional)

◆ Resize()

None eVision.Easy3D.E3DViewer.Resize ( self,
int width,
int height )

Update the size of the 3D viewer window.

Parameters
widthWidth of the viewer window.
heightHeight of the viewer window.

◆ SetColorRampLocation()

None eVision.Easy3D.E3DViewer.SetColorRampLocation ( self,
eVision.EPoint botLeft,
eVision.EPoint topRight )

Sets the location of the color ramp.

Remarks:

By default, the color ramp is located at the right of the window. The color ramp is always vertical. The value should be between 0 (left/bottom) and 100 (right/top) and corresponds to the % of the window.

Parameters
botLeftThe left most and bottom most point of the color ramp.
topRightThe right most and top most point of the color ramp.

◆ SetFeatureStyleFor3DObject()

None eVision.Easy3D.E3DViewer.SetFeatureStyleFor3DObject ( self,
int idx,
eVision.Easy3D.ERenderStyle style,
eVision.Easy3D.E3DObjectFeature feature )

Sets how the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx should be rendered.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, this has no effect.

Parameters
idxthe index of the E3DObject
stylethe style
featurethe feature

◆ SetFeatureStyleForAll3DObjects()

None eVision.Easy3D.E3DViewer.SetFeatureStyleForAll3DObjects ( self,
eVision.Easy3D.ERenderStyle style,
eVision.Easy3D.E3DObjectFeature feature )

Sets how the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject should be rendered.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, this has no effect.

Parameters
stylethe style
featurethe feature

◆ SetFocus()

None eVision.Easy3D.E3DViewer.SetFocus ( self)

The viewer window takes the focus.

◆ SetPickedPointCallBack() [1/3]

None eVision.Easy3D.E3DViewer.SetPickedPointCallBack ( self,
ctypes.c_void_p pickedPointCallBack )

Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.

Remarks:

To obtain an IntPtr of the function, use: using System.Runtime.InteropServices;, delegate void CallBackDelegate(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y); void MyCallBackFunction(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y) {...} Marshal.GetFunctionPointerForDelegate(new CallBackDelegate(MyCallBackFunction)). net@

Where context is the context parameter that was given in argument, pickedPointFound is set to false if a there were no point close enough to the picking ray (true otherwise), pX, pY, pZ are the coordinates of the point that was picked, x and y are the position of the mouse in the window.

Parameters
pickedPointCallBackA pointer to a function that will be called when a new eVision.Easy3D.E3DPoint is picked.

◆ SetPickedPointCallBack() [2/3]

None eVision.Easy3D.E3DViewer.SetPickedPointCallBack ( self,
ctypes.c_void_p pickedPointCallBack,
ctypes.c_void_p context )

Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.

Remarks:

To obtain an IntPtr of the function, use: using System.Runtime.InteropServices;, delegate void CallBackDelegate(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y); void MyCallBackFunction(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y) {...} Marshal.GetFunctionPointerForDelegate(new CallBackDelegate(MyCallBackFunction)). net@

Where context is the context parameter that was given in argument, pickedPointFound is set to false if a there were no point close enough to the picking ray (true otherwise), pX, pY, pZ are the coordinates of the point that was picked, x and y are the position of the mouse in the window.

Parameters
pickedPointCallBackA pointer to a function that will be called when a new eVision.Easy3D.E3DPoint is picked.
contextSome context information that will be given in argument to the callback pickedPointCallBack function.

◆ SetPickedPointCallBack() [3/3]

None eVision.Easy3D.E3DViewer.SetPickedPointCallBack ( self,
ctypes.c_void_p pickedPointCallBack,
ctypes.c_void_p context,
bool callCallBackWhenPointNotFound )

Sets a callback function that will be called when a new eVision.Easy3D.E3DPoint is picked.

Remarks:

To obtain an IntPtr of the function, use: using System.Runtime.InteropServices;, delegate void CallBackDelegate(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y); void MyCallBackFunction(IntPtr context, bool pointFound, float pX, float pY, float pZ, int x, int y) {...} Marshal.GetFunctionPointerForDelegate(new CallBackDelegate(MyCallBackFunction)). net@

Where context is the context parameter that was given in argument, pickedPointFound is set to false if a there were no point close enough to the picking ray (true otherwise), pX, pY, pZ are the coordinates of the point that was picked, x and y are the position of the mouse in the window.

Parameters
pickedPointCallBackA pointer to a function that will be called when a new eVision.Easy3D.E3DPoint is picked.
contextSome context information that will be given in argument to the callback pickedPointCallBack function.
callCallBackWhenPointNotFoundSet to true to call the callback function even if there is not point picked. Default: false.

◆ SetPosition() [1/2]

None eVision.Easy3D.E3DViewer.SetPosition ( self,
int orgX,
int orgY,
int width,
int height )

Sets the position of the 3D viewer window.

Parameters
orgXX coordinate of the top left corner of the viewer window.
orgYY coordinate of the top left corner of the viewer window.
widthWidth of the viewer window.
heightHeight of the viewer window.

◆ SetPosition() [2/2]

None eVision.Easy3D.E3DViewer.SetPosition ( self,
int orgX,
int orgY,
int width,
int height,
ctypes.c_void_p hWndInsertAfter )

Sets the position of the 3D viewer window.

Parameters
orgXX coordinate of the top left corner of the viewer window.
orgYY coordinate of the top left corner of the viewer window.
widthWidth of the viewer window.
heightHeight of the viewer window.
hWndInsertAfterA handle to the window to precede the positioned window in the Z order. Only useful with eVision.Easy3D.EUIAPI.Win32. see SetWindowPos

◆ SetRenderSource() [1/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
boxAn eVision.Easy3D.E3DBox to replace the existing render source.

◆ SetRenderSource() [2/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box,
eVision.EC24 color )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
boxAn eVision.Easy3D.E3DBox to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [3/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DBox box,
eVision.EC24 color,
int opacity )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
boxAn eVision.Easy3D.E3DBox to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [4/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DLine line )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
lineAn eVision.Easy3D.E3DLine to replace the existing render source.

◆ SetRenderSource() [5/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DLine line,
eVision.EC24 color )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
lineAn eVision.Easy3D.E3DLine to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [6/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
planeAn eVision.Easy3D.E3DPlane to replace the existing render source.

◆ SetRenderSource() [7/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane,
eVision.EC24 color )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
planeAn eVision.Easy3D.E3DPlane to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [8/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DPlane plane,
eVision.EC24 color,
int opacity )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
planeAn eVision.Easy3D.E3DPlane to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [9/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sphereAn eVision.Easy3D.E3DSphere to replace the existing render source.

◆ SetRenderSource() [10/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere,
eVision.EC24 color )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sphereAn eVision.Easy3D.E3DSphere to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [11/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.E3DSphere sphere,
eVision.EC24 color,
int opacity )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sphereAn eVision.Easy3D.E3DSphere to replace the existing render source.
colorThe color of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox, eVision.Easy3D.E3DLine or eVision.Easy3D.E3DPlane.
opacityThe opacity of the eVision.Easy3D.E3DSphere, eVision.Easy3D.E3DBox or eVision.Easy3D.E3DPlane.

◆ SetRenderSource() [12/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.EMesh source )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sourceAn eVision.Easy3D.EPointCloud, an eVision.Easy3D.EMesh or an eVision.Easy3D.EZMap to replace the existing render source.

◆ SetRenderSource() [13/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.EPointCloud source )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sourceAn eVision.Easy3D.EPointCloud, an eVision.Easy3D.EMesh or an eVision.Easy3D.EZMap to replace the existing render source.

◆ SetRenderSource() [14/14]

None eVision.Easy3D.E3DViewer.SetRenderSource ( self,
str name,
eVision.Easy3D.EZMap | None source )

Changes the content of a render source with a new point cloud, mesh or ZMap.

Parameters
nameThe name of the render source to be changed.
sourceAn eVision.Easy3D.EPointCloud, an eVision.Easy3D.EMesh or an eVision.Easy3D.EZMap to replace the existing render source.

◆ SetRenderSourceColorMode()

None eVision.Easy3D.E3DViewer.SetRenderSourceColorMode ( self,
str name,
eVision.Easy3D.ESourceColorMode colorMode )

Sets the Source Color Mode.

The Source Color Mode defines how the colors of the point cloud or mesh are chosen. See eVision.Easy3D.ESourceColorMode.

Remarks:

See also eVision.Easy3D.E3DViewer.SetRenderSourceConstantColor and eVision.Easy3D.E3DViewer.GenerateColors.

Parameters
nameThe name of the render source to be considered.
colorModeThe source color mode.

◆ SetRenderSourceConstantColor()

None eVision.Easy3D.E3DViewer.SetRenderSourceConstantColor ( self,
str name,
eVision.EC24 color )

Sets the constant color used to display a point cloud or a mesh, when eVision.Easy3D.ESourceColorMode is set to eVision.Easy3D.ESourceColorMode.Constant.

Remarks:

See also eVision.Easy3D.E3DViewer.SetRenderSourceColorMode.

Parameters
nameThe name of the render source to be considered.
colorThe color.

◆ SetRenderSourceOpacity()

None eVision.Easy3D.E3DViewer.SetRenderSourceOpacity ( self,
str name,
int opacity )

Sets the opacity used to display the render source.

Only compatible with eVision.Easy3D.ESourceColorMode.Constant.

Parameters
nameThe name of the render source to be considered.
opacityThe opacity between fully transparent (0) and fully opaque (255).

◆ SetRenderSourcePointSize()

None eVision.Easy3D.E3DViewer.SetRenderSourcePointSize ( self,
str name,
int size )

Sets the point size used to display the point clouds.

Parameters
nameThe name of the render source to be considered.
sizeThe number of pixels used to render a point.

◆ SetRenderSourceWireFrame()

None eVision.Easy3D.E3DViewer.SetRenderSourceWireFrame ( self,
str name,
bool state )

Sets the wireframe mode used to render a mesh.

Parameters
nameThe name of the render source to be considered.
stateEnable or disable the wireframe rendering mode.

◆ SetRenderSourceWireFrameColor()

None eVision.Easy3D.E3DViewer.SetRenderSourceWireFrameColor ( self,
str name,
eVision.EC24 color )

Sets the wireframe color.

Parameters
nameThe name of the render source to be considered.
colorColor of the wireframe.

◆ SetRotationMatrix()

None eVision.Easy3D.E3DViewer.SetRotationMatrix ( self,
eVision.Easy3D.E3DTransformMatrix matrix )

Sets the view rotation matrix.

Parameters
matrixA matrix representing the view orientation.

◆ SetViewAngle()

None eVision.Easy3D.E3DViewer.SetViewAngle ( self,
float angleX,
float angleY )

Sets view angles.

Parameters
angleXRotation around the X axis.
angleYRotation around the Y axis.

◆ Show()

None eVision.Easy3D.E3DViewer.Show ( self)

Shows the viewer window, refresh the display.

◆ ShowColorRampLegend()

None eVision.Easy3D.E3DViewer.ShowColorRampLegend ( self)

◆ ShowFeatureFor3DObject()

None eVision.Easy3D.E3DViewer.ShowFeatureFor3DObject ( self,
int idx,
eVision.Easy3D.E3DObjectFeature feature )

Sets the eVision.Easy3D.E3DObjectFeature of the registered eVision.Easy3D.E3DObject at the specified location idx to be rendered.

If the feature wasn't computed in the corresponding eVision.Easy3D.E3DObject, this has no effect.

Parameters
idxthe position in the list of registered eVision.Easy3D.E3DObject
featurethe feature

◆ ShowFeatureForAll3DObjects()

None eVision.Easy3D.E3DViewer.ShowFeatureForAll3DObjects ( self,
eVision.Easy3D.E3DObjectFeature feature )

Sets the eVision.Easy3D.E3DObjectFeature of all the registered eVision.Easy3D.E3DObject to be rendered.

Parameters
featurethe feature

◆ ShowRenderSource()

None eVision.Easy3D.E3DViewer.ShowRenderSource ( self,
str name )

Shows the given render source.

Remarks:

See also eVision.Easy3D.E3DViewer.HideRenderSource.

Parameters
nameThe name of the render source.

◆ StopAutoRotate()

None eVision.Easy3D.E3DViewer.StopAutoRotate ( self)

Stops the display automatic rotation.

◆ Terminate()

None eVision.Easy3D.E3DViewer.Terminate ( self)

Closes and frees allocated resources.

Must be called when the object should be destroyed.

This method is always called implicitly during the destruction of the object. It is still recommended to call it explicitly in programming languages other than C++ to ensure the underlying resources are correctly released.

◆ ToggleRenderAxis()

None eVision.Easy3D.E3DViewer.ToggleRenderAxis ( self)

Toggles the display of the axis.

◆ ToggleWireframeMode()

None eVision.Easy3D.E3DViewer.ToggleWireframeMode ( self)

Toggles the display of wireframe triangles.

◆ UpdateRotationPosition()

None eVision.Easy3D.E3DViewer.UpdateRotationPosition ( self,
int x,
int y )

Updates a rotation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when the mouse moves.

Remarks:

See also eVision.Easy3D.E3DViewer.LockRotationInitialPosition and eVision.Easy3D.E3DViewer.LockRotationFinalPosition.

Parameters
xX coordinate.
yY coordinate.

◆ UpdateTranslationPosition()

None eVision.Easy3D.E3DViewer.UpdateTranslationPosition ( self,
int x,
int y )

Updates a translation transformation of the view point using the (x,y) coordinate.

Usually (x,y) is the mouse cursor coordinate when a button is pressed.

Remarks:

See also eVision.Easy3D.E3DViewer.LockTranslationInitialPosition and eVision.Easy3D.E3DViewer.LockTranslationFinalPosition.

Parameters
xX coordinate.
yY coordinate.

◆ UpdateViewDistance()

None eVision.Easy3D.E3DViewer.UpdateViewDistance ( self,
float delta )

Applies a delta factor to the view distance.

Usually this control is mapped on the mouse wheel.

Parameters
deltaThe factor to change the view distance: move the view point closer to the object when delta is lower than 1 and further to the object when delta is larger than 1.

◆ ViewAngle() [1/2]

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DViewer.ViewAngle ( self)

Gets/Sets view angles.

◆ ViewAngle() [2/2]

eVision.Easy3D.E3DViewer.ViewAngle ( self,
eVision.Easy3D.E3DPoint value )

Gets/Sets view angles.

◆ ViewDistance() [1/2]

float eVision.Easy3D.E3DViewer.ViewDistance ( self)

Sets/Gets view distance.

Remarks:

Distance between the point of the view and the object.

◆ ViewDistance() [2/2]

eVision.Easy3D.E3DViewer.ViewDistance ( self,
float value )

Sets/Gets view distance.

Remarks:

Distance between the point of the view and the object.

◆ ViewTarget() [1/2]

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DViewer.ViewTarget ( self)

Gets/Sets view target position (by default, the camera position is 'look at center of the point cloud').

◆ ViewTarget() [2/2]

eVision.Easy3D.E3DViewer.ViewTarget ( self,
eVision.Easy3D.E3DPoint value )

Gets/Sets view target position (by default, the camera position is 'look at center of the point cloud').

◆ WireframeMode() [1/2]

bool eVision.Easy3D.E3DViewer.WireframeMode ( self)

Enables or disables the display of wireframe triangles.

Remarks:

Display wireframe triangles with true (false by default).

◆ WireframeMode() [2/2]

eVision.Easy3D.E3DViewer.WireframeMode ( self,
bool value )

Enables or disables the display of wireframe triangles.

Remarks:

Display wireframe triangles with true (false by default).