Collection of reconstructed frame meshes with attributes. More...

#include <artec/sdk/base/IScan.h>

Inheritance diagram for artec::sdk::base::IScan:

Scan-element operations
virtual IFrameMesh *	getElement (int index) const =0
	Access container element (frame mesh) by index. More...

virtual ErrorCode	setElement (int index, IFrameMesh *mesh)=0
	Access container element (frame mesh) by index. More...

virtual ErrorCode	add (IFrameMesh *frame)=0
	Add/remove reconstructed frame to scan. More...

virtual ErrorCode	add (IFrameMesh frame, const Matrix4x4D &matrix, IBlob frameAttributes=NULL)=0
	Add/remove reconstructed frame to scan. More...

virtual ErrorCode	remove (int index)=0
	Add/remove reconstructed frame to scan. More...

virtual const Matrix4x4D &	getTransformation (int index) const =0
	Access frame-mesh orientation by index. More...

virtual ErrorCode	setTransformation (int index, const Matrix4x4D &m)=0
	Access frame-mesh orientation by index. More...

virtual IBlob *	getAttributes (int index) const =0
	Access frame attributes. Index must be in range [0, getSize()-1]. More...

virtual ErrorCode	setAttributes (int index, IBlob *attributes)=0
	Access frame attributes. Index must be in range [0, getSize()-1]. More...

Scan-attribute operations
virtual ScannerType	getScannerType () const =0
	Get the device type that produces the frames. More...

virtual const Matrix4x4D &	getScanTransformation () const =0
	Access scan transformation. More...

virtual void	setScanTransformation (const Matrix4x4D &m)=0
	Access scan transformation. More...

virtual IBlob *	getScanAttributes () const =0
	Access scan attributes. More...

virtual void	setScanAttributes (IBlob *attributes)=0
	Access scan attributes. More...

virtual const Matrix3x4D &	getTextureMappingMatrix () const =0
	Access matrix for texture mapping. More...

virtual void	setTextureMappingMatrix (const Matrix3x4D &m)=0
	Access matrix for texture mapping. More...

General container operations
virtual int	getSize () const =0
	Get elements number in scan. More...

virtual void	clear ()=0
	Delete all scan elements. More...

virtual const Uuid &	getUuid () const =0
	Access scan uuid. More...

virtual void	setUuid (const Uuid &uuid)=0
	Get elements number in scan. More...

virtual const wchar_t *	getName () const =0
	Access scan name. More...

virtual void	setName (const wchar_t *name)=0
	Access scan name. More...

Additional Inherited Members
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

Collection of reconstructed frame meshes with attributes.

Scan is a collection (container) of reconstructed frames with its own transformation and additional information (scan attributes). Each reconstructed frame consists of frame mesh, transformation matrix and frame-mesh attributes.

Examples:: project-sample.cpp.

Definition at line 79 of file IScan.h.

Member Function Documentation

virtual ErrorCode artec::sdk::base::IScan::add ( IFrameMesh * frame )

pure virtual

Add/remove reconstructed frame to scan.

Transformation matrix is identity by default.

virtual ErrorCode artec::sdk::base::IScan::add	(	IFrameMesh *	frame,
		const Matrix4x4D &	matrix,
		IBlob *	frameAttributes = `NULL`
	)

pure virtual

Add/remove reconstructed frame to scan.

Transformation matrix is identity by default.

virtual void artec::sdk::base::IScan::clear ( )

pure virtual

Delete all scan elements.

virtual IBlob* artec::sdk::base::IScan::getAttributes ( int index ) const

pure virtual

Access frame attributes. Index must be in range [0, getSize()-1].

virtual IFrameMesh* artec::sdk::base::IScan::getElement ( int index ) const

pure virtual

Access container element (frame mesh) by index.

Index must be in range [0, getSize()-1]. Replacing frame mesh at index position using setElement() will not affect transformation matrix and attributes.

Examples:: project-sample.cpp.

virtual const wchar_t* artec::sdk::base::IScan::getName ( ) const

pure virtual

Access scan name.

virtual IBlob* artec::sdk::base::IScan::getScanAttributes ( ) const

pure virtual

Access scan attributes.

virtual ScannerType artec::sdk::base::IScan::getScannerType ( ) const

pure virtual

Get the device type that produces the frames.

virtual const Matrix4x4D& artec::sdk::base::IScan::getScanTransformation ( ) const

pure virtual

Access scan transformation.

Examples:: project-sample.cpp.

virtual int artec::sdk::base::IScan::getSize ( ) const

pure virtual

Get elements number in scan.

Examples:: project-sample.cpp.

virtual const Matrix3x4D& artec::sdk::base::IScan::getTextureMappingMatrix ( ) const

pure virtual

Access matrix for texture mapping.

virtual const Matrix4x4D& artec::sdk::base::IScan::getTransformation ( int index ) const

pure virtual

Access frame-mesh orientation by index.

Index must be in range [0, getSize()-1]. Replacing transformation matrix at index position using setTransformation() will not affect frame mesh and attributes. Matrix with zero elements will be returned if an element index is out of range.

virtual const Uuid& artec::sdk::base::IScan::getUuid ( ) const

pure virtual

Access scan uuid.

virtual ErrorCode artec::sdk::base::IScan::remove ( int index )

pure virtual

Add/remove reconstructed frame to scan.

Transformation matrix is identity by default.

virtual ErrorCode artec::sdk::base::IScan::setAttributes	(	int	index,
		IBlob *	attributes
	)

pure virtual

Access frame attributes. Index must be in range [0, getSize()-1].

virtual ErrorCode artec::sdk::base::IScan::setElement	(	int	index,
		IFrameMesh *	mesh
	)

pure virtual

Access container element (frame mesh) by index.

Index must be in range [0, getSize()-1]. Replacing frame mesh at index position using setElement() will not affect transformation matrix and attributes.

virtual void artec::sdk::base::IScan::setName ( const wchar_t * name )

pure virtual

Access scan name.

virtual void artec::sdk::base::IScan::setScanAttributes ( IBlob * attributes )

pure virtual

Access scan attributes.

virtual void artec::sdk::base::IScan::setScanTransformation ( const Matrix4x4D & m )

pure virtual

Access scan transformation.

virtual void artec::sdk::base::IScan::setTextureMappingMatrix ( const Matrix3x4D & m )

pure virtual

Access matrix for texture mapping.

virtual ErrorCode artec::sdk::base::IScan::setTransformation	(	int	index,
		const Matrix4x4D &	m
	)

pure virtual

Access frame-mesh orientation by index.

Index must be in range [0, getSize()-1]. Replacing transformation matrix at index position using setTransformation() will not affect frame mesh and attributes. Matrix with zero elements will be returned if an element index is out of range.

virtual void artec::sdk::base::IScan::setUuid ( const Uuid & uuid )

pure virtual

Get elements number in scan.

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

artec/sdk/base/IScan.h

Scan-element operations

Scan-attribute operations

General container operations

Additional Inherited Members

Detailed Description

Member Function Documentation