SCENE C++ API  2.0.22
Public Member Functions | List of all members
LSWorkspace Class Reference

Provides general access to all SCENE workspace types. More...

#include <lsworkspace.h>

+ Inheritance diagram for LSWorkspace:

Public Member Functions

ref_ptr< LSObjectgetRootObject () const
 Gets the root object of the workspace object tree. More...
 
LSPod< std::vector< ref_ptr< LSScan > > > getScans () const
 Convenience function to acquire a list of all scans which are part of the object tree. More...
 
bool importData (const LSString &filePath)
 Imports data from a file into this workspace. More...
 
LSPod< std::vector< ref_ptr< LSObject > > > getSelectedObjects () const
 Gets the current list of selected objects with this workspace. More...
 
ref_ptr< LSPointCloudgetPointCloud () const
 Gets the project point cloud of this workspace. More...
 
LSResult::Result createPointCloud ()
 Creates a project point cloud of all scans in that workspace. More...
 
LSResult::Result deletePointCloud ()
 Deletes the project point cloud. More...
 
ref_ptr< LSPointSelectiongetPointSelection () const
 Gets the current spatial point selection of this workspace. More...
 

Public Attributes

Signals
LSSignal< ref_ptr< LSWorkspaceEvent > > onObjectSelectionChanged
 Dispatched when the object selection has changed. More...
 
LSSignal< ref_ptr< LSWorkspaceEvent > > onPointSelectionChanged
 Dispatched when the point selection has changed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

Provides general access to all SCENE workspace types.

Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ getRootObject()

ref_ptr<LSObject> getRootObject ( ) const

Gets the root object of the workspace object tree.

Version
SCENE API Version 2.0.0.

◆ getScans()

LSPod<std::vector<ref_ptr<LSScan> > > getScans ( ) const

Convenience function to acquire a list of all scans which are part of the object tree.

Returns
A list containing all scans which are part of the workspace.
Version
SCENE API Version 2.0.0.

◆ importData()

bool importData ( const LSString filePath)

Imports data from a file into this workspace.

The specified file may be of any supported scan or project type.

Parameters
filePathThe path to the file to be imported.
Returns
true if the file was successfully imported, false otherwise.
Version
SCENE API Version 2.0.3.

◆ getSelectedObjects()

LSPod<std::vector<ref_ptr<LSObject> > > getSelectedObjects ( ) const

Gets the current list of selected objects with this workspace.

Returns
Al list containing all selected objects of this workspace.
Version
SCENE API Version 2.0.0.

◆ getPointCloud()

ref_ptr<LSPointCloud> getPointCloud ( ) const

Gets the project point cloud of this workspace.

Returns
The project point cloud if it exists, a nullptr otherwise.
Version
SCENE API Version 2.0.0.

◆ createPointCloud()

LSResult::Result createPointCloud ( )

Creates a project point cloud of all scans in that workspace.

If the project contains modifications, the project must be saved before the creation is possible. Otherwise LSResult::Internal will be returned. Project must to be open with write access. Otherwise LSResult::Internal will be returned.

Returns
An LSResult result code.
Version
SCENE API Version 2.0.14.

◆ deletePointCloud()

LSResult::Result deletePointCloud ( )

Deletes the project point cloud.

If the project contains modifications, the project must be saved before the deletion is possible. Otherwise LSResult::Internal will be returned. Project must to be open with write access. Otherwise LSResult::Internal will be returned.

Returns
An LSResult result code.
Version
SCENE API Version 2.0.14.

◆ getPointSelection()

ref_ptr<LSPointSelection> getPointSelection ( ) const

Gets the current spatial point selection of this workspace.

Returns
The current point selection if it exists, a nullptr otherwise.
Version
SCENE API Version 2.0.0.

Member Data Documentation

◆ onObjectSelectionChanged

LSSignal<ref_ptr<LSWorkspaceEvent> > onObjectSelectionChanged

Dispatched when the object selection has changed.

Version
SCENE API Version 2.0.0.

◆ onPointSelectionChanged

LSSignal<ref_ptr<LSWorkspaceEvent> > onPointSelectionChanged

Dispatched when the point selection has changed.

Version
SCENE API Version 2.0.0.