Artec 3D Scanning SDK  2.0
Classes | Enumerations | Functions
artec::sdk::project Namespace Reference

Classes

struct  EntryInfo
 Information on project entry (scan or model), e.g. its type and identifier. More...
 
class  IProject
 Interface for loading/saving Artec Studio projects. More...
 
struct  ProjectCopySettings
 Settings for a copy operation. More...
 
struct  ProjectDeleterSettings
 Settings for a delete operation. More...
 
struct  ProjectLoaderSettings
 Settings for a load operation. More...
 
struct  ProjectSaverSettings
 Settings for a save operation. More...
 
struct  ProjectSettings
 Project settings. More...
 

Enumerations

enum  EntryType {
  EntryType_Scan = 0x0,
  EntryType_CompositeMesh = 0x1,
  EntryType_Unknown = 0xFFFFFFFF
}
 Type of the project entry (scan or model) More...
 

Functions

ErrorCode APROJECT_LINK_SPEC createNewProject (IProject **pProject, ProjectSettings *settings)
 Create a new project. More...
 
ErrorCode APROJECT_LINK_SPEC openProject (IProject **pProject, const wchar_t *path)
 Open an existing project. More...
 
int APROJECT_LINK_SPEC getMaximumSupportedProjectVersion ()
 Get maximum supported project version. More...
 

Enumeration Type Documentation

Type of the project entry (scan or model)

Enumerator
EntryType_Scan 

Entry is a scan.

EntryType_CompositeMesh 

Entry is a 3D mesh model.

EntryType_Unknown 

Entry type is unknown.

Definition at line 6 of file EntryType.h.

Function Documentation

ErrorCode APROJECT_LINK_SPEC artec::sdk::project::createNewProject ( IProject **  pProject,
ProjectSettings settings 
)

Create a new project.

Parameters
pProjectDestination project
settingsProject creation parameters, e.g. path
Returns
Error code
int APROJECT_LINK_SPEC artec::sdk::project::getMaximumSupportedProjectVersion ( )

Get maximum supported project version.

Returns
All projects wits smaller or equal version will be read correctly
Note
If the project version exceeds this value, the project can still be read. Some data, however, might be missing.
ErrorCode APROJECT_LINK_SPEC artec::sdk::project::openProject ( IProject **  pProject,
const wchar_t *  path 
)

Open an existing project.

Parameters
pProjectDestination project
pathProject path
Returns
Error code
Examples:
project-sample.cpp.