artec::sdk::scanning::IScanningProcedure Class Referenceabstract

#include <artec/sdk/scanning/IScanningProcedure.h>

+ Inheritance diagram for artec::sdk::scanning::IScanningProcedure:

Public Member Functions

virtual ScanningState getState ()=0
 get current scanning event handler More...
 
virtual ErrorCode setState (ScanningState state)=0
 set new scanning event handler More...
 
virtual ErrorCode setSensitivity (float sensitivity)=0
 
virtual float getSensitivity ()=0
 
virtual ErrorCode setScanningRange (float rangeNear, float rangeFar)=0
 
virtual ErrorCode getScanningRange (float *rangeNear, float *rangeFar)=0
 
virtual ErrorCode setROI (artec::sdk::base::RectF *rect)=0
 
virtual ErrorCode getROI (artec::sdk::base::RectF *rect)=0
 
- Public Member Functions inherited from artec::sdk::base::IJob
virtual const char * getDebugName () const =0
 Returns short job name for debug purposes. More...
 
virtual unsigned int getThreadsRequired () const =0
 
virtual ErrorCode start (const AlgorithmWorkset *runSet)=0
 
virtual ErrorCode process (int threadIndex)=0
 
virtual ErrorCode finish ()=0
 
virtual ErrorCode reset ()=0
 
- Public Member Functions inherited from artec::sdk::base::IRef
virtual int addRef () const =0
 
virtual int release () const =0
 

Detailed Description

IScanningProcedure is controler of scanning procedure. This class needs AlgorithmWorkset because the way of its calls is the same as in algorithms.

Definition at line 153 of file IScanningProcedure.h.

Member Function Documentation

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::getROI ( artec::sdk::base::RectF rect)
pure virtual

Get scanning region of interest

Parameters
rect- rect to return
virtual ErrorCode artec::sdk::scanning::IScanningProcedure::getScanningRange ( float *  rangeNear,
float *  rangeFar 
)
pure virtual

Update scanning range

Parameters
rangeNear- near range limit
rangeFar- far range limit
virtual float artec::sdk::scanning::IScanningProcedure::getSensitivity ( )
pure virtual

Get "improve by neighbor" sensitivity parameter used im mesh reconstruction

Returns
sensitivity - value between 0.0f and 1.0f
virtual ScanningState artec::sdk::scanning::IScanningProcedure::getState ( )
pure virtual

get current scanning event handler

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::setROI ( artec::sdk::base::RectF rect)
pure virtual

Update scanning region of interest can be changed while capture in progress call with rect == NULL for disable ROI

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::setScanningRange ( float  rangeNear,
float  rangeFar 
)
pure virtual

Update scanning range can be changed while capture in progress

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::setSensitivity ( float  sensitivity)
pure virtual

Set "improve by neighbor" sensitivity parameter used im mesh reconstruction can be changed while capture in progress

Parameters
sensitivity- value between 0.0f and 1.0f
virtual ErrorCode artec::sdk::scanning::IScanningProcedure::setState ( ScanningState  state)
pure virtual

set new scanning event handler


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