FlowEngine::WorkspaceSaverInterface Class Reference

Utility class to save output objects as .3dk binary files that can be opened by 3DF Zephyr gui. More...

#include <WorkspaceSaverInterface.h>

Public Member Functions
virtual FLE_DLL	~WorkspaceSaverInterface ()=default
	Default virtual destructor.
virtual FLE_DLL Result	addCamerasAndSparsePointCloud (ConstBuffer< CameraInterface * > cameras, const SparsePointCloudInterface &sparsePointCloud)=0
virtual FLE_DLL Result	addCamera (const CameraInterface &camera)=0
virtual FLE_DLL Result	addSparsePointCloud (const SparsePointCloudInterface &sparsePointCloud)=0
virtual FLE_DLL Result	addStereoPointCloud (const StereoPointCloudInterface &stereoPointCloud)=0
virtual FLE_DLL Result	addStereoMesh (const StereoMeshInterface &stereoMesh)=0
virtual FLE_DLL Result	addStereoTexturedMesh (const StereoTexturedMeshInterface &stereTexturedMesh)=0
virtual FLE_DLL Result	addBoundingBox (const BoundingBoxInterface &boundingBox)=0
virtual FLE_DLL Result	addControlPointConstraint (const ControlPointConstraintInterface &controlPoint)=0
virtual FLE_DLL Result	save (ConstStringBuffer filePath) const =0
virtual FLE_DLL Result	save (DynamicBufferInterface &outBuffer) const =0

Detailed Description

Utility class to save output objects as .3dk binary files that can be opened by 3DF Zephyr gui.

Constructor & Destructor Documentation

~WorkspaceSaverInterface()

virtual FLE_DLL FlowEngine::WorkspaceSaverInterface::~WorkspaceSaverInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

addBoundingBox()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addBoundingBox ( const BoundingBoxInterface &  boundingBox )

pure virtual

Adds a bounding box object to the list of objects to be saved

Parameters

[in]

boundingBox

Bounding Box object to be saved

Returns

One of the following result codes:

• Result::Success – if boundingBox was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

addCamera()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addCamera ( const CameraInterface &  camera )

pure virtual

Adds a camera object to the list of objects to be saved

Parameters

[in]

camera

camera object to be saved.

Returns

One of the following result codes:

• Result::Success – if the camera was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

Note

It's mandatory to add the related sparse point cloud object for any added cameras, consider using WorkspaceSaverInterface::addCamerasAndSparsePointCloud instead.

addCamerasAndSparsePointCloud()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addCamerasAndSparsePointCloud ( ConstBuffer< CameraInterface * >  cameras, const SparsePointCloudInterface &  sparsePointCloud  )

pure virtual

Adds a vector of cameras and their related sparse point cloud.

Parameters

[in]	cameras	a const buffer of camera pointers.
[in]	sparsePointCloud	the sparse point cloud related to the cameras.

Returns

One of the following result codes:

• Result::Success – if the camera was added to this saver successfully.
• Result::InvalidArgument – if cameras is not a valid const buffer of camera objects.
• Result::OutOfMemoryError – if the system reported a bad alloc.

addControlPointConstraint()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addControlPointConstraint ( const ControlPointConstraintInterface &  controlPoint )

pure virtual

Adds a control point constraint object to the list of objects to be saved

Parameters

[in]

controlPoint

Control Point object to be saved

Returns

One of the following result codes:

• Result::Success – if controlPoint was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

addSparsePointCloud()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addSparsePointCloud ( const SparsePointCloudInterface &  sparsePointCloud )

pure virtual

Adds a sparse point cloud object to the list of objects to be saved.

Parameters

[in]

sparsePointCloud

sparse point cloud object to be saved.

Returns

One of the following result codes:

• Result::Success – if sparsePointCloud was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

Note

Please note that it's mandatory to add all the related cameras object for the saved sparse point cloud, consider using WorkspaceSaverInterface::addCamerasAndSparsePointCloud instead.

addStereoMesh()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addStereoMesh ( const StereoMeshInterface &  stereoMesh )

pure virtual

Adds a stereo mesh object to the list of objects to be saved.

Parameters

[in]

stereoMesh

stereo mesh object to be saved.

Returns

One of the following result codes:

• Result::Success – if stereoMesh was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

addStereoPointCloud()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addStereoPointCloud ( const StereoPointCloudInterface &  stereoPointCloud )

pure virtual

Adds a stereo point cloud object to the list of objects to be saved.

Parameters

[in]

stereoPointCloud

stereo point cloud cloud object to be saved.

Returns

One of the following result codes:

• Result::Success – if stereoPointCloud was added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

addStereoTexturedMesh()

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::addStereoTexturedMesh ( const StereoTexturedMeshInterface &  stereTexturedMesh )

pure virtual

Adds a stereo textured mesh object to the list of objects to be saved.

Parameters

[in]

stereTexturedMesh

stereo textured mesh object to be saved.

Returns

One of the following result codes:

• Result::Success – if stereoTexturedMesh added to this saver successfully.
• Result::OutOfMemoryError – if the system reported a bad alloc.

save() [1/2]

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::save ( ConstStringBuffer  filePath ) const

pure virtual

Saves all previously added objects to a file in 3DK format.

Parameters

[in]

filePath

string buffer containing a UTF-8 encoded file path where to save the workspace.

Note

It's advisable to use a .3dk extension so that the file can be directly open from Zephyr.

Returns

One of the following result codes:

• Result::Success – if the file was saved with success.
• Result::InvalidArgument – if filePath is not a valid string buffer.
• Result::OutOfMemoryError – if the system reported a bad alloc.
• Result::DiskWriteError – if the file could not be saved due to filesystem related problems.

save() [2/2]

virtual FLE_DLL Result FlowEngine::WorkspaceSaverInterface::save ( DynamicBufferInterface &  outBuffer ) const

pure virtual

Saves all previously added objects to a dynamic buffer in 3DK format.

Parameters

[in]

outBuffer

a dynamic buffer that will be used to write the 3DK data.

Returns

One of the following result codes:

• Result::Success – if the workspace was serialized to the buffer successfully.
• Result::OutOfMemoryError – if system reported a bad memory allocation.
• Result::GenericError – if any other error occurred.