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

Interface for captured frame (image + depth). More...

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

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

Public Member Functions

virtual int getFrameNumber () const =0
 Used for sorting frames in the capture order both in the single and the multi-thread modes. More...
 
virtual const IImagegetTexture () const =0
 Returns raw texture image without correction. More...
 
virtual const IImagegetDepth () const =0
 Returns depth image. More...
 
virtual const TimeStampgetCaptureTimeStamp () const =0
 Returns frame capture time stamp. 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 for captured frame (image + depth).

Don't confuse it with IFrameMesh!

Definition at line 25 of file IFrame.h.

Member Function Documentation

virtual const TimeStamp* artec::sdk::capturing::IFrame::getCaptureTimeStamp ( ) const
pure virtual

Returns frame capture time stamp.

Return high-precision time for Artec scanners.

Returns
pointer to TimeStamp.
virtual const IImage* artec::sdk::capturing::IFrame::getDepth ( ) const
pure virtual

Returns depth image.

It doesn't work for Artec 3D scanners!

Returns
pointer to depth image.
virtual int artec::sdk::capturing::IFrame::getFrameNumber ( ) const
pure virtual

Used for sorting frames in the capture order both in the single and the multi-thread modes.

Returns
int frame number.
virtual const IImage* artec::sdk::capturing::IFrame::getTexture ( ) const
pure virtual

Returns raw texture image without correction.

See IScanner::convertTextureFull.

Returns
pointer to the raw texture image.

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