artec::sdk::base::IModel Class Reference

Container of Scan(s) and a single CompositeContainer. More...

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

Inheritance diagram for artec::sdk::base::IModel:

Public Member Functions
virtual IScan *	getElement (int index) const =0
	Element access. More...
virtual ErrorCode	setElement (int index, IScan *scan)=0
	Sets an element at the specified index. More...
virtual ErrorCode	add (const IScan *scan)=0
	Add a new scan to the model. More...
virtual ErrorCode	remove (int index)=0
	Remove scan at the defined index. More...
virtual ICompositeContainer *	getCompositeContainer () const =0
	Retrieve the Compositemesh container. More...
virtual void	setCompositeContainer (const ICompositeContainer *meshes)=0
	Set CompositeMesh container. More...
virtual int	getSize () const =0
	Retrieve size of the IModel. More...
virtual void	clear ()=0
	Remove all elements. 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

Container of Scan(s) and a single CompositeContainer.

A newly created Model is empty and contains neither Scans, nor CompositeContainer.

Examples:

project-sample.cpp.

Definition at line 60 of file IModel.h.

Member Function Documentation

virtual ErrorCode artec::sdk::base::IModel::add ( const IScan *  scan )

pure virtual

Add a new scan to the model.

Parameters

scan	Pointer to the IScan instance to add.

Returns

ErrorCode reporting about success or error

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

pure virtual

Remove all elements.

virtual ICompositeContainer* artec::sdk::base::IModel::getCompositeContainer ( ) const

pure virtual

Retrieve the Compositemesh container.

Returns

pointer to the ICompositeContainer instance

Examples:

project-sample.cpp.

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

pure virtual

Element access.

Parameters

index

Defines index of the existing element. It must be in the range of [0...getSize()].

Returns

Pointer to the IScan instance at the index

Examples:

project-sample.cpp.

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

pure virtual

Retrieve size of the IModel.

Returns

number of elements in the collection

Examples:

project-sample.cpp.

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

pure virtual

Remove scan at the defined index.

Parameters

index

Specifies the index of an existing element. It must be in the range of [0...getSize()].

Returns

ErrorCode reporting about success or error

virtual void artec::sdk::base::IModel::setCompositeContainer ( const ICompositeContainer *  meshes )

pure virtual

Set CompositeMesh container.

Parameters

meshes

Pointer to the ICompositeContainer instance to add.

virtual ErrorCode artec::sdk::base::IModel::setElement ( int  index, IScan *  scan  )

pure virtual

Sets an element at the specified index.

Parameters

index	Specifies the index of an existing element. It must be in the range of [0...getSize()].
scan	Pointer to the IScan instance to replace value at the index.

Returns

ErrorCode reporting success or error

---

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

• artec/sdk/base/IModel.h