FlowEngine::WorkspaceLoaderInterface Class Reference

Utility class to load objects from ".3dk" binary files that can be saved using the WorkspaceSaverInterface. More...

#include <WorkspaceLoaderInterface.h>

Public Member Functions
virtual FLE_DLL	~WorkspaceLoaderInterface ()=default
	Default virtual destructor.
virtual FLE_DLL Result	load (ConstStringBuffer filePath)=0
virtual FLE_DLL Result	load (ConstStringBuffer filePath, const Version &minimumVersion)=0
virtual FLE_DLL Result	load (DynamicBufferInterface &inBuffer)=0
virtual FLE_DLL Result	getVersion (Version &outVersion) const =0
virtual FLE_DLL Index	getCameraCount () const =0
virtual FLE_DLL Index	getSparsePointCloudCount () const =0
virtual FLE_DLL Index	getStereoPointCloudCount () const =0
virtual FLE_DLL Index	getStereoMeshCount () const =0
virtual FLE_DLL Index	getStereoTexturedMeshCount () const =0
virtual FLE_DLL Index	getBoundingBoxCount () const =0
virtual FLE_DLL Index	getControlPointConstraintCount () const =0
virtual FLE_DLL Result	getCamera (Index idx, CameraInterface &outCamera) const =0
virtual FLE_DLL Result	getSparsePointCloud (Index idx, SparsePointCloudInterface &outSparsePointCloud) const =0
virtual FLE_DLL Result	getStereoPointCloud (Index idx, StereoPointCloudInterface &outDensePointCloud) const =0
virtual FLE_DLL Result	getStereoMesh (Index idx, StereoMeshInterface &outMesh) const =0
virtual FLE_DLL Result	getStereoTexturedMesh (Index idx, StereoTexturedMeshInterface &outTexturedMesh) const =0
virtual FLE_DLL Result	getBoundingBox (Index idx, BoundingBoxInterface &outBoundingBox) const =0
virtual FLE_DLL Result	getControlPointConstraint (Index idx, ControlPointConstraintInterface &outControlPointConstraint) const =0

Detailed Description

Utility class to load objects from ".3dk" binary files that can be saved using the WorkspaceSaverInterface.

Constructor & Destructor Documentation

~WorkspaceLoaderInterface()

virtual FLE_DLL FlowEngine::WorkspaceLoaderInterface::~WorkspaceLoaderInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getBoundingBox()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getBoundingBox ( Index  idx, BoundingBoxInterface &  outBoundingBox  ) const

pure virtual

Retrieve the bounding box object at the specified position.

Parameters

[in]	idx	bounding box element number. Must be less than WorkspaceLoaderInterface::getBoundingBoxCount.
[in,out]	outBoundingBox	a bounding box object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outBoundingBox was filled with the bounding box at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getBoundingBoxCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getBoundingBoxCount ( ) const

pure virtual

Returns

the number of bounding boxes in this loader.

getCamera()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getCamera ( Index  idx, CameraInterface &  outCamera  ) const

pure virtual

Retrieve the camera object at the specified position.

Parameters

[in]	idx	camera element number. Must be less than WorkspaceLoaderInterface::getCameraCount.
[in,out]	outCamera	a camera object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outCamera was filled with the camera at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getCameraCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getCameraCount ( ) const

pure virtual

Returns

the number of cameras in this loader.

getControlPointConstraint()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getControlPointConstraint ( Index  idx, ControlPointConstraintInterface &  outControlPointConstraint  ) const

pure virtual

Retrieve the control point constraint object at the specified position.

Parameters

[in]	idx	bounding box element number. Must be less than WorkspaceLoaderInterface::getControlPointConstraintCount.
[in,out]	outControlPointConstraint	a ControlPointConstraintInterface object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outControlPointConstraint was filled with the control point constraint at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getControlPointConstraintCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getControlPointConstraintCount ( ) const

pure virtual

Returns

the number of control point constraints in this loader.

getSparsePointCloud()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getSparsePointCloud ( Index  idx, SparsePointCloudInterface &  outSparsePointCloud  ) const

pure virtual

Retrieve the sparse point cloud object at the specified position.

Parameters

[in]	idx	sparse point cloud element number. Must be less than WorkspaceLoaderInterface::getSparsePointCloudCount.
[in,out]	outSparsePointCloud	a sparse point cloud object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outSparsePointCloud was filled with the sparse point cloud at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getSparsePointCloudCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getSparsePointCloudCount ( ) const

pure virtual

Returns

the number of sparse point clouds in this loader.

getStereoMesh()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getStereoMesh ( Index  idx, StereoMeshInterface &  outMesh  ) const

pure virtual

Retrieve the stereo mesh object at the specified position.

Parameters

[in]	idx	mesh element number. Must be less than WorkspaceLoaderInterface::getStereoMeshesCount.
[in,out]	outMesh	a stereo mesh object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outMesh was filled with the mesh at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getStereoMeshCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getStereoMeshCount ( ) const

pure virtual

Returns

the number of stereo meshes in this loader.

getStereoPointCloud()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getStereoPointCloud ( Index  idx, StereoPointCloudInterface &  outDensePointCloud  ) const

pure virtual

Retrieve the stereo point cloud object at the specified position.

Parameters

[in]	idx	stereo point cloud element number. Must be less than WorkspaceLoaderInterface::getStereoPointCloudCount.
[in,out]	outDensePointCloud	a stereo point cloud object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outDensePointCloud was filled with the dense point cloud at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getStereoPointCloudCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getStereoPointCloudCount ( ) const

pure virtual

Returns

the number of stereo point clouds in this loader.

getStereoTexturedMesh()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getStereoTexturedMesh ( Index  idx, StereoTexturedMeshInterface &  outTexturedMesh  ) const

pure virtual

Retrieve the stereo textured mesh object at the specified position.

Parameters

[in]	idx	textured mesh element number. Must be less than WorkspaceLoaderInterface::getStereoTexturedMeshCount.
[in,out]	outTexturedMesh	a stereo textured mesh object to be filled with the loaded information.

Returns

One of the following result codes:

• Result::Success – if outTexturedMesh was filled with the textured mesh at index idx.
• Result::InvalidArgument – if idx is not in the valid range.

getStereoTexturedMeshCount()

virtual FLE_DLL Index FlowEngine::WorkspaceLoaderInterface::getStereoTexturedMeshCount ( ) const

pure virtual

Returns

the number of stereo textured meshes in this loader.

getVersion()

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::getVersion ( Version &  outVersion ) const

pure virtual

Get the version of the loaded 3DK file.

Parameters

[out]

outVersion

the version struct containing the major and minor categories.

Returns

One of the following result codes:

• Result::Success – if outVersion was filled with the version information.
• Result::FeatureNotAvailable – if the loaded 3DK file was saved with a version <= 4.448.

Note

prior to v. 4.448 the version was not written in the 3DK.

load() [1/3]

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::load ( ConstStringBuffer  filePath )

pure virtual

Load objects from a file in 3DK format.

Parameters

[in]

filePath

string buffer containing the UTF-8 encoded path to the file.

Returns

One of the following result codes:

• Result::Success – if the loading process was successful.
• Result::InvalidArgument – if filePath is not a valid string buffer.
• Result::FileNotFound – if filePath does not point to an existing file.
• Result::GenericIOError – if the loading failed (e.g. file is corrupted).
• Result::OutOfMemoryError – if the system reported a bad alloc.

load() [2/3]

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::load ( ConstStringBuffer  filePath, const Version &  minimumVersion  )

pure virtual

Load objects from a file in 3DK format if the file version is older than the specified minium version.

Parameters

[in]	filePath	string buffer containing the UTF-8 encoded path to the file.
[in]	minimumVersion	the minimum file version allowed to load.

Note

This function is identical to the other load(), except that it will fail with Result::UnsupportedVersion if the target file has no version (FlowEngine v.4.448 and lower) or the version is older than minimumVersion.

See also

WorkspaceLoader::load

load() [3/3]

virtual FLE_DLL Result FlowEngine::WorkspaceLoaderInterface::load ( DynamicBufferInterface &  inBuffer )

pure virtual

Load objects from a dynamic buffer in 3DK format.

Parameters

[in]

inBuffer

a dynamic buffer containing the 3DK file.

Returns

One of the following result codes:

• Result::Success – if the workspace was deserialized from the buffer successfully.
• Result::InvalidArgument – if filePath is not a valid string buffer.
• Result::FileNotFound – if filePath does not point to an existing file.
• Result::GenericIOError – if the loading failed (e.g. file is corrupted).
• Result::OutOfMemoryError – if the system reported a bad alloc.