SCENE C++ API  2.0.27
Public Member Functions | Static Public Member Functions | List of all members
LSLocalWorkspace Class Reference

Interface to access information and functionality of local workspaces. More...

#include <lslocalworkspace.h>

+ Inheritance diagram for LSLocalWorkspace:

Public Member Functions

 ~LSLocalWorkspace ()
 Destroys the workspace. More...
 
LSResult::Result saveWorkspace ()
 Saves the current workspace state back to the local workspace file. More...
 
- Public Member Functions inherited from LSWorkspace
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...
 

Static Public Member Functions

static LSResult::Result loadWorkspace (LSString workspacePath, ref_ptr< LSLocalWorkspace > &workspaceOut)
 Loads a local workspace from the file system. More...
 

Additional Inherited Members

- Public Attributes inherited from LSWorkspace
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...
 
- 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

Interface to access information and functionality of local workspaces.

Version
SCENE API Version 2.0.0.

Constructor & Destructor Documentation

◆ ~LSLocalWorkspace()

Destroys the workspace.

Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ loadWorkspace()

static LSResult::Result loadWorkspace ( LSString  workspacePath,
ref_ptr< LSLocalWorkspace > &  workspaceOut 
)
static

Loads a local workspace from the file system.

When working with the Standalone API you should also call LSStandaloneContext::setCurrentWorkspace() after successfully loading a project.

Parameters
workspacePathThe file system path to the workspace file to be loaded.
workspaceOutOut parameter in which the workspace instance is provided if the workspace was successfully loaded.
Returns
An LSResult result code.
Version
SCENE API Version 2.0.0.

◆ saveWorkspace()

LSResult::Result saveWorkspace ( )

Saves the current workspace state back to the local workspace file.

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