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

Bundle scanning procedure controller. More...

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

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

Public Member Functions

virtual ScanningState getState ()=0
 Get current scanning state (ScanningState_Preview, ScanningState_Record, etc.). More...
 
virtual ErrorCode setState (ScanningState state)=0
 Set new scanning state. More...
 
- 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
 Returns the required number of threads. More...
 
virtual ErrorCode start (const AlgorithmWorkset *runSet)=0
 Sets the environment up, makes a processing schedule. More...
 
virtual ErrorCode process (int threadIndex)=0
 Executes the algorithm's processing. More...
 
virtual ErrorCode finish ()=0
 Sums everything up in the end. More...
 
virtual ErrorCode reset ()=0
 Cleans the environment up. 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

Bundle scanning procedure controller.

This class needs AlgorithmWorkset because the way of its calling follows the one for the algorithms.

Definition at line 57 of file IScanningProcedureBundle.h.

Member Function Documentation

virtual ScanningState artec::sdk::scanning::IScanningProcedureBundle::getState ( )
pure virtual

Get current scanning state (ScanningState_Preview, ScanningState_Record, etc.).

Returns
current scanning state.
virtual ErrorCode artec::sdk::scanning::IScanningProcedureBundle::setState ( ScanningState  state)
pure virtual

Set new scanning state.

It can be changed while capture is in progress.

Parameters
state- current scanning state.

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