How to use Dtk_API Class

Table of Contents

• Description
• Sample to start
• Dtk_API options and configuration
  • General options
  • Geometrical options

Description

Dtk_API is a singleton.
You have to Enable the readers you want to use and then Start the API. When API is started you can Use OpenDocument() method to read a file.
This method recognizes file format and calls corresponding Dtk_Reader. You have to close the opened document with EndDocument() method to free data used by the reader. At the end, you need to stop the API.

Sample to start

//First You have to Enable the readers you want to use 
_3dmReader::Enable();
AcisReader::Enable();
CaddsReader::Enable();
CatiaV4Reader::Enable();
CatiaV5Reader::Enable();
CatiaV6Reader::Enable();
CerconReader::Enable();
CerecReader::Enable();
CgmReader::Enable(); 
CgrReader::Enable();
CreoviewReader::Enable();
DcmReader::Enable();
DwgDtkReader::Enable();
F3dReader::Enable(); 
FbxReader::Enable();
GltfReader::Enable();
IfcReader::Enable();
IgesReader::Enable();
InvReader::Enable();
JtReader::Enable();
LavaReader::Enable();
NavisReader::Enable();
ObjReader::Enable();
PlmXmlReader::Enable();
ProCeraReader::Enable();
ProeReader::Enable();
PsReader::Enable();
 QifReader::Enable();
RevitReader::Enable();
SmgReader::Enable();
StlReader::Enable();
StepReader::Enable();
SolidEdgeReader::Enable();
SwReader::Enable();
UgReader::Enable();
VdaReader::Enable(); 
Zw3dReader::Enable();
 
//Then You have to Start DATAKIT API
Dtk_ErrorStatus errorStatus = dtkNoError; 
Dtk_API * MyAPI = Dtk_API::StartAPI(TemporaryWorkingDirectory, errorStatus);
if(MyAPI == NULL)
{
    printf("Can't Start DATAKIT API\n");
    return errorStatus;
}
 
//And Open Document
MyAPI->OpenDocument(inInputFile, TmpDoc);
 
//Your function to write the document  .....
 
//We close the opened document
err = MyAPI->EndDocument(TmpDoc);
 
//At the end you stop DATAKIT API
Dtk_API::StopAPI(MyAPI);

Dtk_API options and configuration

You can activate some options

General options

• Dtk_API::ActivateKeepKernelData()
  see more information on How to use KeepKernelData option
• Dtk_API::ActivateSearchFileEngine()
  see more information on How to use Search File Engine
• Dtk_API::ActivateFeaturesRead()
• Dtk_API::DesactivateDrawingRead()
  

Geometrical options

• Dtk_API::ActivateSplitForPeriodicFaces()