Obsolete Members for SceneView

SceneView

The following members of class SceneView are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

Protected Functions

Member Function Documentation

[since Esri::ArcGISRuntime 100.6, deprecated] bool SceneView::isManualRendering() const

This function is deprecated. We strongly advise against using it in new code.

Returns a bool that determines whether the SceneView is under manual rendering control.

This property determines whether the SceneView will use manual rendering updates rather than the using this API's internal rendering mechanism.

When this property is true, you must call renderFrame for any updates to be drawn on the screen. Calling renderFrame isn't necessary when this property is false. The default value is false.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also renderFrame.

[since Esri::ArcGISRuntime 100.6, deprecated] void SceneView::renderFrame()

This function is deprecated. We strongly advise against using it in new code.

Manually render the current frame.

This call will block the caller until the latest changes have been rendered to the screen.

This method may be called from the main/GUI thread or a sub-thread. Do not mix calls from the main thread and a sub-thread to this method in the same application session.

If calling this method from a timer event, be sure to stop the timer before shutting down the application.

In certain situations you may be able to achieve better rendering performance by utilizing the single-threaded renderer. This is already the default setting on some platforms.

// use the environment variable to use the "basic" rendering loop
// for the Qt Quick Scene Graph
qputenv("QSG_RENDER_LOOP", "basic");

For more information, see here https://links.esri.com/qtquick-visualcanvas-scenegraph-rendering

This function was introduced in Esri::ArcGISRuntime 100.6.

See also isManualRendering.

[deprecated] Esri::ArcGISRuntime::TaskWatcher SceneView::screenToLocation(double screenX, double screenY)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously converts a screen coordinate relative to the upper-left corner of the scene view to a location in map coordinates.

This is a high performance calculation executed on the GPU using a triangular mesh. Note that elevation values are approximated, and as the distance between the camera and the surface increases, the precision of the elevation value decreases.

This method will wait for the next drawing cycle to get the exact point from the graphics card that is at the screen coordinate supplied. This location could be on the surface, a building, or a feature.

To call this method, assign a scene to the scene view, ensure that it is loaded and the draw status is DrawStatus::Completed).

• screenX - The screen's x-coordinate to convert to map coordinate.
• screenY - The screen's y-coordinate to convert to map coordinate.

Note: This operation could return an empty point (clicked outside the earth).

[virtual protected, deprecated] void SceneView::screenToLocationCompletedEvent(QUuid taskId, const Esri::ArcGISRuntime::Point &location)

This function is deprecated. We strongly advise against using it in new code.

Override this method to perform custom logic when a screenToLocation operation completes.

• taskId - The task ID of the operation.
• location - The location in scene coordinates.

[virtual, since Esri::ArcGISRuntime 100.6, deprecated] void SceneView::setManualRendering(bool manualRendering)

This function is deprecated. We strongly advise against using it in new code.

Sets the SceneView rendering mode manualRendering.

When the SceneView is using manual rendering, you must call renderFrame on a regular interval for the view to update.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also isManualRendering() and renderFrame.

[deprecated] Esri::ArcGISRuntime::TaskWatcher SceneView::setViewpointCamera(const Esri::ArcGISRuntime::Camera &camera)

This function is deprecated. We strongly advise against using it in new code.

Immediately changes the display to the viewpoint specified by the given camera.

The Camera determines at what position and angle the scene is viewed. Animates the display to the viewpoint specified by the given camera.

• camera - The new camera information for the scene view.

[deprecated] Esri::ArcGISRuntime::TaskWatcher SceneView::setViewpointCamera(const Esri::ArcGISRuntime::Camera &camera, float durationSeconds)

This function is deprecated. We strongly advise against using it in new code.

Animates the display to the viewpoint specified by the given camera using the specified duration to arrive.

The Camera determines at what position and angle the scene is viewed.

Use SceneView::setViewpointCamera to set a viewpoint that animates over a specified duration.

• camera - The new camera information for the scene view.
• durationSeconds - The time for the transition animation to complete, in seconds.

[virtual protected, deprecated] void SceneView::setViewpointCameraCompletedEvent(bool success)

This function is deprecated. We strongly advise against using it in new code.

Override this method to perform custom logic when a setViewpointCamera operation completes.

• success true if setting the viewport camera completed successfully.