Interface for loading/saving Artec Studio projects. More...

#include <artec/sdk/project/IProject.h>

Inheritance diagram for artec::sdk::project::IProject:

Public Member Functions
virtual int	getProjectVersion ()=0
	Get current project version. More...

Functions to create asynchronous job
virtual ErrorCode	createLoader (IJob *pLoader, ProjectLoaderSettings settings)=0
	Create a job that loads project entries. More...

virtual ErrorCode	createSaver (IJob *pSaver, ProjectSaverSettings settings)=0
	Create a job that saves the project. More...

virtual ErrorCode	createDeleter (IJob *pDeleter, ProjectDeleterSettings settings)=0
	Create a job that deletes the project. More...

virtual ErrorCode	createCopier (IJob *pCopier, ProjectCopierSettings settings)=0
	Create a job that copies the project. More...

Functions to manipulate project entry
virtual int	getEntryCount () const =0
	Get the number of entries (scans/models) available in the project. More...

virtual ErrorCode	getEntry (int entryIndex, EntryInfo entry, IString *entryName=NULL) const =0
	Get an information structure for an entry specified by an index. 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 loading/saving Artec Studio projects.

Use it to fetch scans and ICompositeMesh's objects from Arteс Studio projects, assemble projects from scans and models (composite meshes) and save them in Arteс Studio format.

Examples:: project-sample.cpp.

Definition at line 73 of file IProject.h.

Member Function Documentation

virtual ErrorCode artec::sdk::project::IProject::createCopier	(	IJob **	pCopier,
		ProjectCopierSettings *	settings
	)

pure virtual

Create a job that copies the project.

Note: Not implemented yet

Parameters

pCopier	a copy job to be created
settings	settings for a copy operation

Returns: Error code

virtual ErrorCode artec::sdk::project::IProject::createDeleter	(	IJob **	pDeleter,
		ProjectDeleterSettings *	settings
	)

pure virtual

Create a job that deletes the project.

Note: Not implemented yet

Parameters

pDeleter	A delete job to be created
settings	Settings for a delete operation

Returns: Error code

virtual ErrorCode artec::sdk::project::IProject::createLoader	(	IJob **	pLoader,
		ProjectLoaderSettings *	settings
	)

pure virtual

Create a job that loads project entries.

Parameters

pLoader	A load job to be created
settings	Settings for a load operation

Returns: Error code

Examples:: project-sample.cpp.

virtual ErrorCode artec::sdk::project::IProject::createSaver	(	IJob **	pSaver,
		ProjectSaverSettings *	settings
	)

pure virtual

Create a job that saves the project.

Parameters

pSaver	A save job to be created
settings	Settings for a save operation

Returns: Error code

Examples:: project-sample.cpp.

virtual ErrorCode artec::sdk::project::IProject::getEntry	(	int	entryIndex,
		EntryInfo *	entry,
		IString **	entryName = `NULL`
	)		const

pure virtual

Get an information structure for an entry specified by an index.

Parameters

entryIndex	A zero-based entry index [0,..,N-1]
entry	An entry structure to be filled in
entryName	An entry name to be filled in. Can be NULL if the name is not necessary

Returns: Error code

Examples:: project-sample.cpp.

virtual int artec::sdk::project::IProject::getEntryCount ( ) const

pure virtual

Get the number of entries (scans/models) available in the project.

Returns: A total number of entries (as stated in metadata) available in the project

Examples:: project-sample.cpp.

virtual int artec::sdk::project::IProject::getProjectVersion ( )

pure virtual

Get current project version.

Returns: Current project version

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

artec/sdk/project/IProject.h

Public Member Functions

Detailed Description

Member Function Documentation