FlowEngine::BoundingBoxInterface Class Reference

An oriented bounding box. More...

#include <BoundingBoxInterface.h>

Public Member Functions
virtual FLE_DLL	~BoundingBoxInterface ()=default
	Default virtual destructor.
virtual FLE_DLL void	getTranslation (Point3 &outTranslation) const =0
virtual FLE_DLL void	getHalfSize (Point3 &outHalfSize) const =0
virtual FLE_DLL void	getOrientation (Quaternion &outOrientation) const =0
virtual FLE_DLL void	setTranslation (const Point3 &translation)=0
virtual FLE_DLL void	setHalfSize (const Point3 &halfSize)=0
virtual FLE_DLL void	setOrientation (const Quaternion &orientation)=0
virtual FLE_DLL Result	computeFromPoints (const SparsePointCloudInterface &pointCloud, bool useOutlierRejection, float additionalExpansionPerc=0.03f)=0
virtual FLE_DLL Result	computeFromCameras (const SparsePointCloudInterface &pointCloud, Buffer< CameraInterface * > inCameras, float additionalExpansionPerc=0.1f)=0
virtual FLE_DLL Result	exportToXml (ConstStringBuffer filePath) const =0
virtual FLE_DLL Result	importFromXml (ConstStringBuffer filePath)=0

Detailed Description

An oriented bounding box.

Its parameters can be set manually or from a sparse point cloud.

Constructor & Destructor Documentation

~BoundingBoxInterface()

virtual FLE_DLL FlowEngine::BoundingBoxInterface::~BoundingBoxInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

computeFromCameras()

virtual FLE_DLL Result FlowEngine::BoundingBoxInterface::computeFromCameras ( const SparsePointCloudInterface &  pointCloud, Buffer< CameraInterface * >  inCameras, float  additionalExpansionPerc = 0.1f  )

pure virtual

Computes a bounding box from cameras and point cloud, assuming an orbit around an object.

Parameters

[in]	pointCloud	a point cloud with at least 2 points.
[in]	inCameras	vector of cameras
[in]	additionalExpansionPerc	Additional expansion factor for the bounding box. Must be >= 0 procedure to discard far camera positions in the bounding box computation. Otherwise, it will use all the points in the point cloud.

Postcondition

Valid dimensions (> 0), translation and orientation, or the previous values on error.

Returns

One of the following result codes:

• Result::Success – if the bounding box parameters were updated successful.
• Result::InvalidArgument – if pointCloud does not contain at least 2 points or additionalExpansionPerc is negative
• Result::GenericError – if the automatic outlier rejection procedure failed.

computeFromPoints()

virtual FLE_DLL Result FlowEngine::BoundingBoxInterface::computeFromPoints ( const SparsePointCloudInterface &  pointCloud, bool  useOutlierRejection, float  additionalExpansionPerc = 0.03f  )

pure virtual

Computes appropriate bounding parameters from a sparse point cloud points.

Parameters

[in]	pointCloud	a point cloud with at least 2 points.
[in]	useOutlierRejection	If set to true, use an outliers rejection
[in]	additionalExpansionPerc	Additional expansion factor for the bounding box. Must be >= 0 procedure to discard far points in the bounding box computation. Otherwise, it will use all the points in the point cloud.

Postcondition

Valid dimensions (> 0), translation and orientation, or the previous values on error.

Returns

One of the following result codes:

• Result::Success – if the bounding box parameters were updated successful.
• Result::InvalidArgument – if pointCloud does not contain at least 2 points or additionalExpansionPerc is negative
• Result::GenericError – if the automatic outlier rejection procedure failed.

exportToXml()

virtual FLE_DLL Result FlowEngine::BoundingBoxInterface::exportToXml ( ConstStringBuffer  filePath ) const

pure virtual

Exports this bounding box parameters to an xml file

Parameters

[in]

filePath

string buffer containing the utf-8 encoded path to where to save the data

Returns

One of the following result codes:

• Result::Success – if the bounding box parameters were successfully exported to the specified xml file.
• Result::InvalidArgument – if filePath is not a valid string buffer.
• Result::DiskWriteError – if the write operation failed.

getHalfSize()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::getHalfSize ( Point3 &  outHalfSize ) const

pure virtual

Returns the half size of the bounding box

Parameters

[out]

outHalfSize

the bounding box half size

getOrientation()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::getOrientation ( Quaternion &  outOrientation ) const

pure virtual

Returns the orientation of the bounding box (as axis-angle)

Parameters

[out]

outOrientation

the bounding box orientation

getTranslation()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::getTranslation ( Point3 &  outTranslation ) const

pure virtual

Returns the translation of the bounding box

Parameters

[out]

outTranslation

the bounding box translation

importFromXml()

virtual FLE_DLL Result FlowEngine::BoundingBoxInterface::importFromXml ( ConstStringBuffer  filePath )

pure virtual

Imports bounding box parameters from an xml file

Parameters

[in]

filePath

string buffer containing the utf-8 encoded path to where the file is located.

Returns

One of the following result codes:

• Result::Success – if the bounding box parameters were successfully exported to the specified xml file.
• 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 parsing failed for any reason.

Postcondition

valid parameters imported from the specified file, or the previous values if an error occurred.

setHalfSize()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::setHalfSize ( const Point3 &  halfSize )

pure virtual

Change the half size of the bounding box

Parameters

[in]

halfSize

the new bounding box half size

setOrientation()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::setOrientation ( const Quaternion &  orientation )

pure virtual

Change the orientation of the bounding box (as axis-angle)

Parameters

[in]

orientation

the new bounding box orientation

setTranslation()

virtual FLE_DLL void FlowEngine::BoundingBoxInterface::setTranslation ( const Point3 &  translation )

pure virtual

Change the translation of the bounding box

Parameters

[in]

translation

the new bounding box translation