Interface to start/pause/stop recording, control scanner sensitivity, FOV, ROI, etc. More...

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

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

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...

virtual ErrorCode	setSensitivity (float sensitivity)=0
	Set the "improve by neighbor" sensitivity parameter. More...

virtual float	getSensitivity ()=0
	Get the current "improve by neighbor" sensitivity parameter. More...

virtual ErrorCode	setScanningRange (float rangeNear, float rangeFar)=0
	Update scanning range. More...

virtual ErrorCode	getScanningRange (float rangeNear, float rangeFar)=0
	Get current scanning range. More...

virtual ErrorCode	setROI (artec::sdk::base::RectF *rect)=0
	Update region of scanning interest (ROI). More...

virtual ErrorCode	getROI (artec::sdk::base::RectF *rect)=0
	Get current region of scanning interest (ROI). 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

Interface to start/pause/stop recording, control scanner sensitivity, FOV, ROI, etc.

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

Definition at line 187 of file IScanningProcedure.h.

Member Function Documentation

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

pure virtual

Get current region of scanning interest (ROI).

Parameters

rect	- region of interest to return

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::getScanningRange	(	float *	rangeNear,
		float *	rangeFar
	)

pure virtual

Get current scanning range.

Parameters

rangeNear	- near range limit to return
rangeFar	- far range limit to return

virtual float artec::sdk::scanning::IScanningProcedure::getSensitivity ( )

pure virtual

Get the current "improve by neighbor" sensitivity parameter.

Used for mesh reconstruction.

Returns: sensitivity - value in the range of 0.0f to 1.0f

virtual ScanningState artec::sdk::scanning::IScanningProcedure::getState ( )

pure virtual

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

Returns: current scanning state.

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

pure virtual

Update region of scanning interest (ROI).

Can be changed while capture is in progress.

Parameters

rect	- region of interest. NULL means disabled ROI.

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

pure virtual

Update scanning range.

Can be changed while capture is in progress.

Parameters

rangeNear	- near range limit
rangeFar	- far range limit

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

pure virtual

Set the "improve by neighbor" sensitivity parameter.

Used for mesh reconstruction. It can be changed while capture is in progress. It doesn't take effect for EVA cameras

Parameters

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

virtual ErrorCode artec::sdk::scanning::IScanningProcedure::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:

artec/sdk/scanning/IScanningProcedure.h

Public Member Functions

Detailed Description

Member Function Documentation