COLNEO Pro 1.0
Loading...
Searching...
No Matches
View3dAPI

Description

3D Viewer API interface.

API is provided by Javascript object (WebForms, Macros) "cnView3dAPI".

Since
11.2014, jh

(c) COLNEO GmbH

Functions

TOOLS
ApiJsonResponse resetView ()
 
ApiJsonResponse requestUpdate ()
 
ApiJsonResponse getScreenshot ()
 
ApiJsonResponse createViewpoint (QString name, QVariantMap &options)
 
CAMERA
ApiJsonResponse getCamera ()
 
ApiJsonResponse setCamera (QVariantMap &cam)
 
ApiJsonResponse zoomAll ()
 
ApiJsonResponse zoomToObjects (QStringList &objectIds)
 
ApiJsonResponse zoomToPoints (QVariantMap &pointarray)
 
CLIPPING
ApiJsonResponse setClippingPlanes (QVariantMap &clipping)
 
ApiJsonResponse getClippingPlanes ()
 
ApiJsonResponse resetClipping ()
 
PICKING
ApiJsonResponse getPickedPoints ()
 
ApiJsonResponse startPickedPointsLog ()
 
ApiJsonResponse stopPickedPointsLog ()
 
ApiJsonResponse getPickedFaces ()
 
ApiJsonResponse clearPickedFaces ()
 
ApiJsonResponse startPickedFacesLog ()
 
ApiJsonResponse stopPickedFacesLog ()
 
CONFIG
ApiJsonResponse getConfig ()
 
ApiJsonResponse setConfig (QVariantMap &cfg)
 
ApiJsonResponse resetConfig ()
 
NAVIGATION
ApiJsonResponse setNavigationMode (QVariantMap &cfg)
 
ApiJsonResponse getNavigationMode ()
 
TOOLTIPS / LEGEND
ApiJsonResponse addTooltip (QVariantMap &cfg)
 
ApiJsonResponse removeTooltips (QVariantMap &idlist)
 
ApiJsonResponse removeAllTooltips ()
 

Function Documentation

◆ addTooltip

ApiJsonResponse addTooltip ( QVariantMap & cfg)
slot
Since
1.0.0, 2025.02, jh

◆ clearPickedFaces

ApiJsonResponse clearPickedFaces ( )
slot
Since
1.0.0, 2025.02, jh

◆ createViewpoint

ApiJsonResponse createViewpoint ( QString name,
QVariantMap & options )
slot

Create Viewpoint.

A viewpoint is created as Smartset with a view (camera,clipping) attached.

Parameters
name
options
Returns
data : {}
Since
1.0, 2025.04, jh

◆ getCamera

ApiJsonResponse getCamera ( )
slot

...

Returns
{
...
}
Since
1.0.0, ...

◆ getClippingPlanes

ApiJsonResponse getClippingPlanes ( )
slot
Since
1.0.0, 2025.02, jh

◆ getConfig

ApiJsonResponse getConfig ( )
slot
Since
1.0.0, 2025.02, jh

◆ getNavigationMode

ApiJsonResponse getNavigationMode ( )
slot
Since
1.0.0, 2025.02, jh

◆ getPickedFaces

ApiJsonResponse getPickedFaces ( )
slot
Since
1.0.0, 2025.02, jh

◆ getPickedPoints

ApiJsonResponse getPickedPoints ( )
slot
Since
1.0.0, 2025.02, jh

◆ getScreenshot

ApiJsonResponse getScreenshot ( )
slot

Get current view as Base64 encoded string.

Returns
data: " ... base64 encoded string ... "
Since
1.0, 2025.02, jh

◆ removeAllTooltips

ApiJsonResponse removeAllTooltips ( )
slot
Since
1.0.0, 2025.02, jh

◆ removeTooltips

ApiJsonResponse removeTooltips ( QVariantMap & idlist)
slot
Since
1.0.0, 2025.02, jh

◆ requestUpdate

ApiJsonResponse requestUpdate ( )
slot

Request an update/repaint of the 3D view.

◆ resetClipping

ApiJsonResponse resetClipping ( )
slot
Since
1.0.0, 2025.02, jh

◆ resetConfig

ApiJsonResponse resetConfig ( )
slot
Since
1.0.0, 2025.02, jh

◆ resetView

ApiJsonResponse resetView ( )
slot

==> clearSelection(), showAll(), resetClipping()

◆ setCamera

ApiJsonResponse setCamera ( QVariantMap & cam)
slot

...

Parameters
cam= { }
See also
getCamera()
Since
1.0.0, ...

◆ setClippingPlanes

ApiJsonResponse setClippingPlanes ( QVariantMap & clipping)
slot
Since
1.0.0, 2025.02, jh

◆ setConfig

ApiJsonResponse setConfig ( QVariantMap & cfg)
slot

Set configuration of 3D View.
To repaint 3D call requestUpdate().

cfg = {
"backgroundcolor" : "#FFAAAA"
}
Since
1.0.0, 2025.02, jh

◆ setNavigationMode

ApiJsonResponse setNavigationMode ( QVariantMap & cfg)
slot

Set navigation mode of 3D view.

Available modes:
[ orbit , walk, clip, measure, redline ]

Parameters
cfg= { "mode" : " ... mode ... " }
Since
1.0.0, 2025.02, jh

◆ startPickedFacesLog

ApiJsonResponse startPickedFacesLog ( )
slot
Since
1.0.0, 2025.02, jh

◆ startPickedPointsLog

ApiJsonResponse startPickedPointsLog ( )
slot
Since
1.0.0, 2025.02, jh

◆ stopPickedFacesLog

ApiJsonResponse stopPickedFacesLog ( )
slot
Since
1.0.0, 2025.02, jh

◆ stopPickedPointsLog

ApiJsonResponse stopPickedPointsLog ( )
slot
Since
1.0.0, 2025.02, jh

◆ zoomAll

ApiJsonResponse zoomAll ( )
slot
Since
1.0.0, 2025.02, jh

◆ zoomToObjects

ApiJsonResponse zoomToObjects ( QStringList & objectIds)
slot
Since
1.0.0, 2025.02, jh

◆ zoomToPoints

ApiJsonResponse zoomToPoints ( QVariantMap & pointarray)
slot
Since
1.0.0, 2025.02, jh