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

Inheritance diagram for artec::sdk::capturing::IScanner:

Public Member Functions
virtual ErrorCode	createFrameProcessor (IFrameProcessor *processor, FrameProcessorDesc desc=NULL)=0

virtual ErrorCode	initFrameProcessorDesc (FrameProcessorDesc *desc)=0
	fill desc with default processing parameters More...

virtual int	getFrameNumber () const =0
	get current frame number More...

virtual ErrorCode	capture (IFrame **frame, bool captureTexture)=0

virtual ErrorCode	captureTexture (IImage *texture, int frameNumber)=0

virtual const ScannerId *	getId () const =0
	get scanner ID More...

virtual const ScannerInfo *	getInfo () const =0
	get scanner information More...

virtual IScannerObserver *	getObserver () const =0
	get scanner event handler More...

virtual ErrorCode	setObserver (IScannerObserver *handler)=0
	set scanner event handler More...

virtual float	getGain () const =0
	gain settings More...

virtual float	getTextureGain () const =0

virtual void	setTextureGain (float gain)=0

virtual float	getTextureGainMin () const =0
	get texture gain range More...

virtual float	getTextureGainMax () const =0

virtual float	getFPS () const =0
	Returns currently requested scanner FPS. More...

virtual void	setFPS (float fps)=0
	Sets required scanner FPS. More...

virtual float	getMaximumFPS () const =0
	Returns maximum possible FPS for this scanner type. More...

virtual const artec::sdk::base::Matrix3x4D &	getTextureMappingMatrix () const =0

virtual float	getTextureIllumination () const =0

virtual ErrorCode	convertTextureFull (IImage *fullTexture, const IImage rawTexture) const =0

virtual ErrorCode	convertTextureHalf (IImage *halfTexture, const IImage rawTexture) const =0

virtual void	enableFlash (bool enable)=0
	enable/disable flash for geometry camera More...

virtual bool	isFlashEnabled () const =0

virtual void	setFlashDelay (float vl)=0
	flash delay in milliseconds More...

virtual float	getFlashDelay () const =0

virtual float	getFlashDuration () const =0
	flash duration for geometry camera only More...

virtual void	enableTextureFlash (bool enable)=0
	enable/disable flash for texture capturing More...

virtual bool	isTextureFlashEnabled () const =0

virtual void	setTriggerDelay (float delay)=0
	set/get external synchronization trigger delay in milliseconds More...

virtual float	getTriggerDelay () const =0

virtual void	setUseHwTrigger (bool vl)=0
	enable/disable scanner trigger for external synchronization More...

virtual bool	getUseHwTrigger () const =0

virtual void	setTextureUseHwTrigger (bool vl)=0
	enable/disable texture camera trigger to synchronize texture and depth More...

virtual bool	getTextureUseHwTrigger () const =0

virtual void	setTextureTriggerDelay (float delay)=0
	set/get external synchronization trigger delay for texture camera in milliseconds More...

virtual float	getTextureTriggerDelay () const =0

virtual void	setTextureShutterSpeed (float vl)=0
	set/get texture camera shutter speed (exposure time) in milliseconds More...

virtual float	getTextureShutterSpeed () const =0

virtual void	enableAutoExposure (bool enable)=0
	set auto exposure More...

virtual bool	isAutoExposureEnabled () const =0

virtual void	enableAutoWhiteBalance (bool enable)=0
	set auto white balance More...

virtual bool	isAutoWhiteBalanceEnabled () const =0

virtual ErrorCode	setScannerSynchronization (IScannerSynchronization *sync)=0
	synchronization scanners in bundle More...

virtual IScannerSynchronization *	getScannerSynchronization () const =0

virtual ErrorCode	fireTrigger (bool captureTexture)=0
	fire trigger. not a thread-safe function More...

virtual ErrorCode	retrieveFrame (IFrame **frame, bool captureTexture)=0
	retrieve captured frame. not a thread-safe function More...

virtual int	getScannerIndex () const =0
	get scanner index in bundle. 0 - when no bundle used More...

virtual void	setScannerIndex (int newIndex)=0

Public Member Functions inherited from artec::sdk::base::IRef
virtual int	addRef () const =0

virtual int	release () const =0

Detailed Description

Definition at line 74 of file IScanner.h.

Member Function Documentation

virtual ErrorCode artec::sdk::capturing::IScanner::capture	(	IFrame **	frame,
		bool	captureTexture
	)

pure virtual

make capture action safe multi-thread function

virtual ErrorCode artec::sdk::capturing::IScanner::captureTexture	(	IImage **	texture,
		int *	frameNumber
	)

pure virtual

capture texture only safe multi-thread function

virtual ErrorCode artec::sdk::capturing::IScanner::convertTextureFull	(	IImage **	fullTexture,
		const IImage *	rawTexture
	)		const

pure virtual

convert RAW buffer to RGB (use standard capturer conversion) perform de-mosaicking, correct vignetting and distortion

virtual ErrorCode artec::sdk::capturing::IScanner::convertTextureHalf	(	IImage **	halfTexture,
		const IImage *	rawTexture
	)		const

pure virtual

convert RAW texture buffer from device to half-resolution RGB (fast) perform de-mosaicking, correct vignetting and distortion

virtual ErrorCode artec::sdk::capturing::IScanner::createFrameProcessor	(	IFrameProcessor **	processor,
		FrameProcessorDesc *	desc = `NULL`
	)

pure virtual

create IFrameProcessor processor if desc == NULL, use default settings

virtual void artec::sdk::capturing::IScanner::enableAutoExposure ( bool enable )

pure virtual

set auto exposure

virtual void artec::sdk::capturing::IScanner::enableAutoWhiteBalance ( bool enable )

pure virtual

set auto white balance

virtual void artec::sdk::capturing::IScanner::enableFlash ( bool enable )

pure virtual

enable/disable flash for geometry camera

virtual void artec::sdk::capturing::IScanner::enableTextureFlash ( bool enable )

pure virtual

enable/disable flash for texture capturing

virtual ErrorCode artec::sdk::capturing::IScanner::fireTrigger ( bool captureTexture )

pure virtual

fire trigger. not a thread-safe function

virtual float artec::sdk::capturing::IScanner::getFlashDelay ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getFlashDuration ( ) const

pure virtual

flash duration for geometry camera only

virtual float artec::sdk::capturing::IScanner::getFPS ( ) const

pure virtual

Returns currently requested scanner FPS.

virtual int artec::sdk::capturing::IScanner::getFrameNumber ( ) const

pure virtual

get current frame number

virtual float artec::sdk::capturing::IScanner::getGain ( ) const

pure virtual

gain settings

virtual const ScannerId* artec::sdk::capturing::IScanner::getId ( ) const

pure virtual

get scanner ID

virtual const ScannerInfo* artec::sdk::capturing::IScanner::getInfo ( ) const

pure virtual

get scanner information

virtual float artec::sdk::capturing::IScanner::getMaximumFPS ( ) const

pure virtual

Returns maximum possible FPS for this scanner type.

virtual IScannerObserver* artec::sdk::capturing::IScanner::getObserver ( ) const

pure virtual

get scanner event handler

virtual int artec::sdk::capturing::IScanner::getScannerIndex ( ) const

pure virtual

get scanner index in bundle. 0 - when no bundle used

virtual IScannerSynchronization* artec::sdk::capturing::IScanner::getScannerSynchronization ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getTextureGain ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getTextureGainMax ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getTextureGainMin ( ) const

pure virtual

get texture gain range

virtual float artec::sdk::capturing::IScanner::getTextureIllumination ( ) const

pure virtual

get parameters that is needed for a texture brightness normalization texture flash power coefficient on a 1000mm distance (~ white plain intensity)

virtual const artec::sdk::base::Matrix3x4D& artec::sdk::capturing::IScanner::getTextureMappingMatrix ( ) const

pure virtual

get matrix for texture mapping pass it in data-processor mapTexture() function

virtual float artec::sdk::capturing::IScanner::getTextureShutterSpeed ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getTextureTriggerDelay ( ) const

pure virtual

virtual bool artec::sdk::capturing::IScanner::getTextureUseHwTrigger ( ) const

pure virtual

virtual float artec::sdk::capturing::IScanner::getTriggerDelay ( ) const

pure virtual

virtual bool artec::sdk::capturing::IScanner::getUseHwTrigger ( ) const

pure virtual

virtual ErrorCode artec::sdk::capturing::IScanner::initFrameProcessorDesc ( FrameProcessorDesc * desc )

pure virtual

fill desc with default processing parameters

virtual bool artec::sdk::capturing::IScanner::isAutoExposureEnabled ( ) const

pure virtual

virtual bool artec::sdk::capturing::IScanner::isAutoWhiteBalanceEnabled ( ) const

pure virtual

virtual bool artec::sdk::capturing::IScanner::isFlashEnabled ( ) const

pure virtual

virtual bool artec::sdk::capturing::IScanner::isTextureFlashEnabled ( ) const

pure virtual

virtual ErrorCode artec::sdk::capturing::IScanner::retrieveFrame	(	IFrame **	frame,
		bool	captureTexture
	)

pure virtual

retrieve captured frame. not a thread-safe function

virtual void artec::sdk::capturing::IScanner::setFlashDelay ( float vl )

pure virtual

flash delay in milliseconds

virtual void artec::sdk::capturing::IScanner::setFPS ( float fps )

pure virtual

Sets required scanner FPS.

virtual ErrorCode artec::sdk::capturing::IScanner::setObserver ( IScannerObserver * handler )

pure virtual

set scanner event handler

virtual void artec::sdk::capturing::IScanner::setScannerIndex ( int newIndex )

pure virtual

virtual ErrorCode artec::sdk::capturing::IScanner::setScannerSynchronization ( IScannerSynchronization * sync )

pure virtual

synchronization scanners in bundle

virtual void artec::sdk::capturing::IScanner::setTextureGain ( float gain )

pure virtual

virtual void artec::sdk::capturing::IScanner::setTextureShutterSpeed ( float vl )

pure virtual

set/get texture camera shutter speed (exposure time) in milliseconds

virtual void artec::sdk::capturing::IScanner::setTextureTriggerDelay ( float delay )

pure virtual

set/get external synchronization trigger delay for texture camera in milliseconds

virtual void artec::sdk::capturing::IScanner::setTextureUseHwTrigger ( bool vl )

pure virtual

enable/disable texture camera trigger to synchronize texture and depth

virtual void artec::sdk::capturing::IScanner::setTriggerDelay ( float delay )

pure virtual

set/get external synchronization trigger delay in milliseconds

virtual void artec::sdk::capturing::IScanner::setUseHwTrigger ( bool vl )

pure virtual

enable/disable scanner trigger for external synchronization

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

artec/sdk/capturing/IScanner.h

Public Member Functions

Detailed Description

Member Function Documentation