FlowEngine::BulkAccessInterface Class Reference

#include <BulkAccessInterface.h>

Inheritance diagram for FlowEngine::BulkAccessInterface:

Public Types
enum	DataType {   DataType_Positions , DataType_Normals , DataType_Colors , DataType_TexCoords ,   DataType_SplatInfo }

Public Member Functions
virtual FLE_DLL Index	getPointCount () const =0
virtual FLE_DLL Result	getPointData (DataType type, Buffer< void > outData) const =0
virtual FLE_DLL Result	setPointData (DataType type, ConstBuffer< void > data)=0
virtual FLE_DLL	~BulkAccessInterface ()=default

Detailed Description

Interface for all FlowEngine objects with functions to access data in bulk.

Member Enumeration Documentation

DataType

enum FlowEngine::BulkAccessInterface::DataType

Enumerator
DataType_Positions
DataType_Normals	The 3D coordinates of the points in the object. Memory layout is 3 * sizeof( double )
DataType_Colors	The normal vectors at each point in the object. Memory layout is 3 * sizeof( float )
DataType_TexCoords	The RGB color values at each point in the object. Memory layout is 3 * sizeof( uint8_t )
DataType_SplatInfo	The 2D texture coordinates at each point in the object. Memory layout is 2 * sizeof( float )

Constructor & Destructor Documentation

~BulkAccessInterface()

virtual FLE_DLL FlowEngine::BulkAccessInterface::~BulkAccessInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getPointCount()

virtual FLE_DLL Index FlowEngine::BulkAccessInterface::getPointCount ( ) const

pure virtual

Implemented in FlowEngine::StereoMeshInterface, FlowEngine::StereoPointCloudInterface, and FlowEngine::StereoTexturedMeshInterface.

getPointData()

virtual FLE_DLL Result FlowEngine::BulkAccessInterface::getPointData ( DataType  type, Buffer< void >  outData  ) const

pure virtual

Copies point data from the object.

Parameters

type	the type of data to be copied. See BulkAccessInterface::DataType for the available types and their expected formats.
outData	a buffer large enough to countain getPointCount() elements. See BulkAccessInterface::DataType for the expected format and memory layout. The caller is responsible for allocating and managing the memory for this buffer.

Note

This feature is not available in the free version of the SDK.

Returns

one of the following result codes:

• Result::Success – if the point positions were successfully copied to outData.
• Result::InvalidArgument – if outData is not a valid buffer or is not large enough to hold all point positions.
• Result::FeatureNotAvailable – if this method is called by the free version of the SDK.

setPointData()

virtual FLE_DLL Result FlowEngine::BulkAccessInterface::setPointData ( DataType  type, ConstBuffer< void >  data  )

pure virtual

Copies point data to the object.

Parameters

type	the type of data to be copied. See BulkAccessInterface::DataType for the available types and their expected formats.
data	a buffer containing the point data to be copied to the object. See BulkAccessInterface::DataType for the expected format and memory layout.

Note

This feature is not available in the free version of the SDK.

Returns

one of the following result codes:

• Result::Success – if the point positions were successfully copied from inData to the object.
• Result::InvalidArgument – if inData is not a valid buffer or does not contain enough data to fill all point positions.
• Result::FeatureNotAvailable – if this method is called by the free version of the SDK.