Artec 3D Scanning SDK  2.0
Public Member Functions | List of all members
artec::sdk::capturing::IFrameProcessor Class Referenceabstract

Raw frames processor (frames from scanner). More...

#include <artec/sdk/capturing/IFrameProcessor.h>

+ Inheritance diagram for artec::sdk::capturing::IFrameProcessor:

Public Member Functions

virtual ErrorCode reconstructMesh (artec::sdk::base::IFrameMesh **mesh, const IFrame *frame)=0
 Method reconstructs a surface from the frame data, but it doesn't texturize the output even if texture is captured. More...
 
virtual ErrorCode reconstructAndTexturizeMesh (artec::sdk::base::IFrameMesh **mesh, const IFrame *frame)=0
 Method both reconstructs a surface from the frame data and applies texture to the output. More...
 
virtual ErrorCode setSensitivity (float sensitivity)=0
 Set the "improve by neighbor" sensitivity parameter used in mesh reconstruction. More...
 
virtual float getSensitivity () const =0
 Get the "improve by neighbor" sensitivity parameter used in mesh reconstruction. More...
 
virtual ErrorCode setScanningRange (float rangeNear, float rangeFar)=0
 Adjust scanning range. More...
 
virtual ErrorCode getScanningRange (float *rangeNear, float *rangeFar) const =0
 Get scanning range. More...
 
virtual ErrorCode setROI (artec::sdk::base::RectF *rect)=0
 Adjust region of scanning interest. More...
 
virtual ErrorCode getROI (artec::sdk::base::RectF *rect) const =0
 Get region of scanning interest. More...
 
- Public Member Functions inherited from artec::sdk::base::IRef
virtual int addRef () const =0
 Increase object reference counter. More...
 
virtual int release () const =0
 Decrease object reference counter. More...
 

Detailed Description

Raw frames processor (frames from scanner).

It provides several methods to handle scanner's parameters.

Definition at line 28 of file IFrameProcessor.h.

Member Function Documentation

virtual ErrorCode artec::sdk::capturing::IFrameProcessor::getROI ( artec::sdk::base::RectF rect) const
pure virtual

Get region of scanning interest.

Parameters
rect- rect to return.
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::getScanningRange ( float *  rangeNear,
float *  rangeFar 
) const
pure virtual

Get scanning range.

Parameters
rangeNear- near range limit
rangeFar- far range limit
virtual float artec::sdk::capturing::IFrameProcessor::getSensitivity ( ) const
pure virtual

Get the "improve by neighbor" sensitivity parameter used in mesh reconstruction.

Returns
sensitivity - value in the range of 0.0f to 1.0f
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::reconstructAndTexturizeMesh ( artec::sdk::base::IFrameMesh **  mesh,
const IFrame frame 
)
pure virtual

Method both reconstructs a surface from the frame data and applies texture to the output.

The latter is performed only if texture is captured.

Warning
This is a slow method. Use reconstructMesh() instead.
Parameters
meshpoints to mesh to be reconstructed
frame- source frame entity
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::reconstructMesh ( artec::sdk::base::IFrameMesh **  mesh,
const IFrame frame 
)
pure virtual

Method reconstructs a surface from the frame data, but it doesn't texturize the output even if texture is captured.

Texture mapping should be explicitly performed through the IFrameMesh::mapTexture() method.

Parameters
meshpoints to mesh to be reconstructed
frame- source frame entity
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::setROI ( artec::sdk::base::RectF rect)
pure virtual

Adjust region of scanning interest.

It can be changed during capture.

Parameters
rect- new region of interest. If it is NULL, then ROI is disabled.
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::setScanningRange ( float  rangeNear,
float  rangeFar 
)
pure virtual

Adjust scanning range.

It can be changed during capture.

Parameters
rangeNear- near range limit
rangeFar- far range limit
virtual ErrorCode artec::sdk::capturing::IFrameProcessor::setSensitivity ( float  sensitivity)
pure virtual

Set the "improve by neighbor" sensitivity parameter used in mesh reconstruction.

It can be changed while capture is in progress.

Parameters
sensitivity- value in the range of 0.0f to 1.0f

The documentation for this class was generated from the following file: