dtk_api.hpp

Go to the documentation of this file.

#ifndef _UTIL_API_DTK_HPP_
#define _UTIL_API_DTK_HPP_
 
#include "def/define.h"
#include "util/dtk_maindoc.hpp"
#include "util/dtk_maindoc_ptr.hpp"
#include "util/error_dtk.hpp"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include <cstdio>
 
class Dtk_Config;
class Dtk_ColorTable;
class Dtk_Reader;
class Dtk_Log;
typedef Dtk_SmartPtr<Dtk_Log> Dtk_LogPtr;
class Dtk_Preview;
typedef Dtk_SmartPtr<Dtk_Preview> Dtk_PreviewPtr;
class Dtk_GraphicalData;
typedef Dtk_SmartPtr<Dtk_GraphicalData>          Dtk_GraphicalDataPtr;
 
enum dtk_BodyMode
{
    DTK_BODYMODE_NOPREFERENCE = 0, //no preference (faster)
    DTK_BODYMODE_UVSURFACIC,       //Prepare data to get UV boundaries (Needed for Tesselation Lib)
    DTK_BODYMODE_COMPLETETOPOLOGY, //default : Prepare data to get 3D and corresponding UV boundaries 
    DTK_BODYMODE_3DTOPOLOGY        //Prepare data to get 3D boundaries 
};
 
 
class Dtk_SearchFileEnum
{
public:
     Dtk_SearchFileEnum()
     {
 
     };
     ~Dtk_SearchFileEnum()
     {
 
     };
 
     enum RecursivityEnum
     {
          NoRecursivity = 0,
          RootFolderFirstRecursivity,
          SubFolderFirstRecursivity
     };
     enum PriorityModeEnum
     {
          LocalSearch = 0,
          ReadPathSearch,
          AdditionalPathSearch,
          RelativePathSearch,
          BelowPathSearch,
          AbovePathSearch 
     };
 
     enum Status
     {
          Enable = 0,
          Disable,
     };
 
private:
 
};
 
 
 
 
class Dtk_API
{
protected:
     class Dtk_Handle;       // Not defined here
     std::unique_ptr<Dtk_Handle> _Private;   // Handle
     static Dtk_API *_CurrentAPI;
 
     static Dtk_Reader * _VdaReader;
    static Dtk_Reader * _V5Reader;
    static Dtk_Reader * _V6Reader;
     static Dtk_Reader * _InvReader;
     static Dtk_Reader * _IgesReader;
     static Dtk_Reader * _V4Reader;
     static Dtk_Reader * _UgReader;
     static Dtk_Reader * _XmtReader;
     static Dtk_Reader * _SwReader;
     static Dtk_Reader * _SeReader;
     static Dtk_Reader * _ProeReader;
     static Dtk_Reader * _JtReader;
     static Dtk_Reader * _StepReader;
     static Dtk_Reader * _AcisReader;
     static Dtk_Reader * _CgrReader;
     static Dtk_Reader * _CaddsReader;
     static Dtk_Reader * _ProCeraReader;
     static Dtk_Reader * _CerconReader;
     static Dtk_Reader * _DcmReader;
     static Dtk_Reader * _CerecReader;
     static Dtk_Reader * _XmlReader;
     static Dtk_Reader * _DxfReader;
     static Dtk_Reader * _PlmXmlReader;
     static Dtk_Reader * _Lava3mReader;
     static Dtk_Reader * _RnXmlReader;
    static Dtk_Reader * _3dmReader;
     static Dtk_Reader * _DwgReader;
     static Dtk_Reader * _ObjReader;
     static Dtk_Reader * _IfcReader;
     static Dtk_Reader * _BRepOccReader;
     static Dtk_Reader * _RevitReader;
     static Dtk_Reader * _CreoviewReader;
     static Dtk_Reader * _StlReader;
     static Dtk_Reader * _FbxReader;
     static Dtk_Reader * _SdnfReader;
     static Dtk_Reader * _CgmReader;
     static Dtk_Reader * _ArtReader;
     static Dtk_Reader * _SmgReader;
     static Dtk_Reader * _PrcReader;
     static Dtk_Reader * _F3dReader;
     static Dtk_Reader * _GltfReader;
     static Dtk_Reader * _DstvReader;
     static Dtk_Reader * _NavisReader;
     static Dtk_Reader * _QifReader;
     static Dtk_Reader * _DwgDtkReader;
     static Dtk_Reader * _Zw3dReader;
     static Dtk_Reader * _UsdReader;
 
     Dtk_ErrorStatus _InitData(const Dtk_string& inTemporyDirectory,const Dtk_string &inClientCode);
     Dtk_API();
     virtual ~Dtk_API();
 
private :
     friend class Dtk_Node;
     friend class Dtk_Component;
     friend class Dtk_APIContext;
     friend class Dtk_MainDocWrapper;
 
    friend class CatiaV5Reader;
    friend class CatiaV6Reader;
     friend class VdaReader;
     friend class InvReader;
     friend class CatiaV4Reader;
     friend class IgesReader;
     friend class UgReader;
     friend class XmtReader;
     friend class SwReader;
     friend class SeReader;
     friend class ProeReader;
     friend class JtReader;
     friend class StepReader;
     friend class PsReader;
     friend class AcisReader;
     friend class CgrReader;
     friend class CaddsReader;
     friend class ProCeraReader;
     friend class CerconReader;
     friend class CerecReader;
     friend class XmlReader;
     friend class DcmReader;
     friend class DxfReader;
     friend class PlmXmlReader;
     friend class LavaReader;
     friend class RnXmlReader;
    friend class _3dmReader;
     friend class DwgReader;
     friend class ObjReader;
     friend class IfcReader;
     friend class SolidEdgeReader;
    friend class BRepOccReader;
     friend class RevitReader;
     friend class CreoviewReader;
     friend class StlReader;
     friend class FbxReader;
     friend class SdnfReader;
     friend class CgmReader;
     friend class ArtReader;
     friend class SmgReader;
     friend class PrcReader;
     friend class F3dReader;
     friend class GltfReader;
     friend class DstvReader;
     friend class NavisReader;
     friend class QifReader;
     friend class DwgDtkReader;
     friend class Zw3dReader;
     friend class UsdReader;
 
     Dtk_ErrorStatus _ActivateReader();
     Dtk_ErrorStatus _DesactivateReader();
 
     void _WriteTimeLog();
    virtual void InitLog();
 
public:
    //! \brief GetVersion of DatakitLibs
    Dtk_string GetVersion()const;
     //! \brief Start DATAKIT API
     //! \param [in] inTemporyDirectory : Directory where API can write temporary files.
     //! \param [out] outErrorCode : Error code if API returned is NULL.
     //! \param [in] inCustomerID : Customer ID if you have one.
     //! \return Pointer on API if OK, NULL if can't write in inTemporyDirectory or can't find licence
     static Dtk_API* StartAPI(const Dtk_string& inTemporyDirectory,Dtk_ErrorStatus &outErrorCode, const Dtk_string& inCustomerID=Dtk_string());
 
     //! \brief Stop DATAKIT API
     //! \param [in] inAPI : Api to stop.
     static void StopAPI(Dtk_API*& inAPI, Dtk_bool inWriteTimeInLog = 1);
     //! \brief Get DATAKIT API
     //! \return Pointer on API
     static Dtk_API* GetAPI();
 
     //! \brief Deactivate FlexlmCall
     // avoid license check for unlimited customer
     static void DeactivateFlexlmCall();
 
 
     //! \brief Add customer Id for evaluation 
     //! \param [in] inEvaluationID : Additionnal ID .
     //! \return dtkNoError if OK
     Dtk_ErrorStatus AddEvaluationID( Dtk_string inEvaluationID );
 
     void BreakApi();
     Dtk_bool IsBroken();
 
     Dtk_Config *GetConfig();
     Dtk_ColorTable *GetColorTable();
 
    const Dtk_LogPtr& GetLog();
 
     Dtk_ID AddRenderInfosInTable(const Dtk_RenderInfosPtr &inNewRenderInfos);
     Dtk_Size_t GetNumRenderInfosInTable() const;
     Dtk_RenderInfosPtr GetRenderInfosInTable(Dtk_ID inId) const;
 
     Dtk_ID AddPhysicalMaterialInfosInTable(const Dtk_PhysicalMaterialInfosPtr &inNewMaterialInfos);
     Dtk_Size_t GetNumPhysicalMaterialInfosInTable() const;
     Dtk_PhysicalMaterialInfosPtr GetPhysicalMaterialInfosInTable(Dtk_ID inId) const;
 
 
     Dtk_ID AddBuildingMaterialInTable(const Dtk_BuildingMaterialPtr &inNewBuildingMaterial);
     Dtk_Size_t GetNumBuildingMaterialInTable() const;
     Dtk_BuildingMaterialPtr GetBuildingMaterialInTable(Dtk_ID inId) const;
 
     Dtk_ID AddCurveLineTypeDefinitionInTable( const Dtk_LineTypeDefinitionPtr & inNewLineTypeDefinition );
     Dtk_Size_t GetNumCurveLineTypeDefinitionsInTable() const;
     Dtk_LineTypeDefinitionPtr GetCurveLineTypeDefinitionInTable( const Dtk_ID inId ) const;
 
     //! \brief Set Log File.
     //! \param [in] inLogFile : File where API can write infos.
     //! \return dtkNoError if OK
     Dtk_ErrorStatus SetLogFile(const Dtk_string& inLogFile);
 
     //! \brief Set Schema Directory needed for Unigraphics, Parasolid, Solidedge, Solidworks and Jt readers.
     //! \param [in] inSchemaDir : Directory where API can find Parasolid Schema.
     //! \return dtkNoError if OK
     Dtk_ErrorStatus SetSchemaDir(const Dtk_string& inSchemaDir);
     //! \brief Change TemporyDirectory
     //! \param [in] inWorkingDir : Directory where API can write temporary files.
     //! \return dtkNoError if OK
     Dtk_ErrorStatus SetWorkingDir(const Dtk_string& inWorkingDir);
     const Dtk_string & GetLogFile() const ;
     const Dtk_string & GetSchemaDir()const;
    const Dtk_string & GetWorkingDir()const;
 
 
     Dtk_ErrorStatus WriteInLogFile(const Dtk_string &inString);
     Dtk_ErrorStatus WriteInLogFile(const char *inString);
 
     Dtk_ErrorStatus WriteInDebugFile(const Dtk_string &inString);
 
     Dtk_ErrorStatus LoadConfigFile(const Dtk_string &inConfigFile);
     Dtk_ErrorStatus LoadConfigFile(FILE *inConfigFile);
 
     //! \brief Independant method to get DtkReaderType associated to inFileName
     //! \param [in] inInputFile : File to read.
     //! \return Module type or UnknownModule 
     DtkReaderType GetFileReaderType(const Dtk_string& inFileName); 
 
     //! \brief Independant method to get version of inInputFile.
     //! \param [in] inInputFile : File to read.
     //! \param [out] outVersion : File Version if found.
     //! \return dtkErrorFutureVersion for futures unknown versions  
     //! \return dtkErrorVersionNotSupported if version not supported 
     //! \return dtkNoError if OK
     Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string& outVersion);
 
     //! \brief Independant method to get preview of inInputFile.
    //! \param [in] inInputFile : File to read.
    //! \param [out] outPreview : File Preview if found.
    //! \return dtkNoError if OK  
     Dtk_ErrorStatus GetFilePreview(const Dtk_string &inInputFile, Dtk_PreviewPtr& outPreview);
 
     //! \brief Open a Document (call EndDocument to close it)
     //! \param [in] inInputFile : File to read.
     //! \param [out] outDocument : Assembly Tree corresponding to inInputFile.
     //! \return dtkNoError if OK 
     Dtk_ErrorStatus OpenDocument(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
     //! \brief Open a Document for graphical representation(call EndDocument to close it)
     //! \param [in] inInputFile : File to read.
     //! \param [out] outDocument : Assembly Tree corresponding to Graphical representation of inInputFile.
     //! \return dtkNoError if OK 
     Dtk_ErrorStatus OpenDocumentGraphic( const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument );
 
     //! \brief Close a Document.
     //! \param [in,out] inoutDocument : Assembly Tree opened with OpenDocument or OpenDocumentGraphic.
     //! \return Pointer on API
     Dtk_ErrorStatus EndDocument(Dtk_MainDocPtr& inoutDocument);
 
     //! \brief Read Component from Assembly Tree (Call EndComponent to free data allocated)
     //! \param [in] inComponent : Component to read.
     //! \param [out] outRootNode :  Root of construction tree read. Can be NULL if component is empty
     //! \return dtkNoError if OK 
     //! \return dtkErrorComponentAlreadyLoaded if you already read a Dtk_Component without calling EndComponent.
     Dtk_ErrorStatus ReadComponent(
          const Dtk_ComponentPtr& inComponent,
          Dtk_NodePtr& outRootNode);
 
     //! \brief Read graphical data from Component (Call EndComponent to free data allocated)
     //! \param [in] inComponent : Component to read.
     //! \param [out] outGraphicalData : Dtk_GraphicalData with meshes or drawing 
     //! \return dtkNoError if OK
     //! \return dtkErrorComponentAlreadyLoaded if you already read a Dtk_Component without calling EndComponent.
     Dtk_ErrorStatus ReadComponentGraphic(
          const Dtk_ComponentPtr& inComponent,
          Dtk_GraphicalDataPtr& outGraphicalData );
 
     //! \brief EndComponent 
     //! release data allocated by ReadComponent or ReadComponentGraphic. 
     //! You have to call EndComponent at least once for each call of ReadComponent or ReadComponentGraphic.
     //! \param [in] inComponent : Component to free.
     //! \return dtkNoError if OK
     Dtk_ErrorStatus EndComponent(Dtk_ComponentPtr& inComponent);
 
    //! \brief Clear Search Path initialised with AddSearchPathForAssembly
    //! \return dtkNoError if OK
    Dtk_ErrorStatus ClearSearchPathForAssembly();
    //! \brief Add search path to find missing files of assemblies
    //! \param [in] inPath : Path to search missing files
    //! \param [out] inRecursiveFlag : Search in subdirectories of inPath if DTK_TRUE
    //! \return dtkNoError if OK
    Dtk_ErrorStatus AddSearchPathForAssembly(Dtk_string &inPath, Dtk_bool inRecursiveFlag);
    Dtk_ErrorStatus GetSearchPathForAssembly(Dtk_tab<Dtk_string> &outPathArray, Dtk_tab<Dtk_bool> &outRecursiveFlagArray) const;
 
    //! \brief Add search path to find missing files
    //! \param [in] inRecursivityEnum : value of which search type from Dtk_SearchFileEnum::RecursivityEnum
    //! \param [in] inPath : Path to search file
    //! \return dtkNoError if OK
     Dtk_ErrorStatus AddSearchPath(const Dtk_SearchFileEnum::RecursivityEnum& inRecursivityEnum , const Dtk_string &inPath);
 
 
     //! \brief Clear Search Priority 
     //! \return dtkNoError if OK
     Dtk_ErrorStatus ClearSearchPriority();
 
 
     //! \brief Set Search Position
     //! \param [in] inPosition : position into search array 0..5
     //! \param [out] inSearchEnum : Search enum
     //! \return dtkNoError if OK
     Dtk_ErrorStatus SetSearchPositionMode(Dtk_Int32 inPosition, Dtk_SearchFileEnum::PriorityModeEnum inSearchEnum);
 
 
     //! \brief Clear Search Path initialised with AddSearchPathForFonts
     //! \return dtkNoError if OK
     Dtk_ErrorStatus ClearSearchPathForFonts();
     //! \brief Add search path to find fonts
     //! \param [in] inPath : Path to search fonts
     //! \return dtkNoError if OK
     Dtk_ErrorStatus AddSearchPathForFonts( const Dtk_string &inPath );
     Dtk_ErrorStatus GetSearchPathForFonts( Dtk_tab<Dtk_string> &outPathArray ) const;
 
     //! \brief Returns List of Failed Licence ever checked
     //! \param [out] outList : List of Product Name
     Dtk_ErrorStatus GetInvalidLicenseList(Dtk_tab<Dtk_string> &outList);
 
     Dtk_ErrorStatus PopulateComponentsTree(
          const Dtk_string& inInputFile,
          Dtk_MainDocPtr& inoutDocument,
          Dtk_ComponentPtr& outRootComponent);
 
     //!\brief Activate Search File Engine to find missing files of assembly
     //! You can then choose additional directories and search priority.
     void ActivateSearchFileEngine();
     //!\brief Deactivate Search File Engine - Use default software search strategy
     void DeactivateSearchFileEngine();
     //!\brief Returns if Search File Engine is activated or not
     Dtk_bool IsSearchFileEngineActivated();
     
     //! \brief Activate 3D Projection for drawing (Activated by default)
     void Activate3DProjectionForDrawing();
     //! \brief Deactivate 3D Projection for drawing
     void Deactivate3DProjectionForDrawing();
     //! \brief Returns if 3D Projection for drawing is activated or not
     Dtk_bool Is3DProjectionForDrawingActivated();
 
     //! \brief From V66 Use old way to read Revolution Surface
     void ActivateReversedRevolution();
     Dtk_bool IsReversedRevolutionActivated();
 
     //! \deprecated Not usefull anymore - Always Activaded from V73.
     SetAsDeprecated("2025.4 ", "Not usefull anymore - Always Activaded from V73")
     void ActivateNewFdtRead_Deprecated254();
     //! \deprecated Not usefull anymore - Always TRUE from V73.
     SetAsDeprecated("2025.4 ", "Not usefull anymore - Always TRUE from V73")
     Dtk_bool IsNewFdtReadActivated_Deprecated254();
 
 
     //! \brief Set Body Topology Preference
     //   DTK_BODYMODE_UVSURFACIC,       //Prepare data to get UV boundaries 
     //   DTK_BODYMODE_COMPLETETOPOLOGY, //default : Prepare data to get 3D and corresponding UV boundaries 
     //   DTK_BODYMODE_3DTOPOLOGY        //Prepare data to get 3D boundaries 
     void SetBodyModePreference(dtk_BodyMode inMode);
     dtk_BodyMode GetBodyModePreference();
 
     //! \brief Disable/Enable Control for extra module
     void SetControlOnExtraModule(Dtk_bool inControl);
     Dtk_bool IsExtraControlEnable();
 
 
     //! \brief Split Periodic Faces when we read a model
     // Available for readers : Unigraphics, Solidworks, Solidedge, Parasolid, Acis, Inventor
     void ActivateSplitForPeriodicFaces();
 
     //! \brief Split Multi Turns Faces when we read a model
     // Available for readers : Unigraphics, Solidworks, Solidedge, Parasolid
     void ActivateSplitForMultiTurnsFaces();
 
     //! \brief Keep Kernel Data option (see "How to use KeepKernelData option")
     // Available for readers : Unigraphics, Solidworks, Solidedge, Parasolid
     void ActivateKeepKernelData();
 
     //! \brief read customers attribut
     // Available for readers : Unigraphics, Solidworks, Solidedge, Parasolid, Jt
     // if inRead == DTK_TRUE, force reading customers attributs
     void SetReadCustomAttribut( Dtk_bool bRead );
 
     //! \brief Activate read to retrieve feature tree
     // Available for readers : Unigraphics, Solidedge
     // default DTK_FALSE
     // if inForceFeatureData==DTK_TRUE , force name entity from name feature
     //!\note Feature tree reading for Creo, Solidworks, CatiaV5 and CatiaV6 readers is always active.
     void ActivateFeaturesRead( Dtk_Int32 inForceFeatureData =DTK_FALSE);
 
     //! \brief Desactivate Drawing read
     // Available for readers : Unigraphics
     //! \note for 2D readers drawing read is active.
     void DesactivateDrawingRead();
 
     //!\brief Allow Local Path Search for files of assembly
     // default DTK_TRUE
     void SetLocalPathSearchFlag( Dtk_bool inActivationFlag );
 
     //!\brief Allow Internal Read Path Search for files of assembly
     // default DTK_TRUE
     void SetInternalReadPathSearchFlag( Dtk_bool inActivationFlag );
 
     //!\brief Allow Additionnal Path Search for files of assembly
     // default DTK_TRUE
     void SetAdditionnalPathSearchFlag(Dtk_bool inActivationFlag);
 
     //!\brief Allow Relative Search for files of assembly
     // default DTK_FALSE
     void SetRelativePathSearchFlag(Dtk_bool inActivationFlag);
 
     //!\brief Allow Below Search for files of assembly
     // default DTK_FALSE
     void SetBelowPathSearchFlag(Dtk_bool inActivationFlag);
 
     //!\brief Allow Above Search for files of assembly
     // default DTK_FALSE
     void SetAbovePathSearchFlag(Dtk_bool inActivationFlag);
 
 
     //! \brief Force to update the intern assembly definition by extern definition
     void ForceUpdateAssembly();
 
     //! \brief GetColor in API Lut form index
     //! \param [in] inIndex : Color Index
     //! \param [out] outColor : RGB Color corresponding to inIndex
     //! \return dtkNoError if OK
     Dtk_ErrorStatus GetColorInTable(const Dtk_Int32 inIndex, Dtk_RGB &outColor);
 
     //! \brief Get Number of Colors in API Lut  
     //! \return Number of Colors
     Dtk_Size_t GetNumColorInTable() const;
 
 
    //! \brief Internal Use
     Dtk_ErrorStatus ReadConnectedEntity(const Dtk_MainDocPtr &inDoc, const Dtk_NodeConnectorPtr &inConnector, Dtk_tab<Dtk_EntityPtr> &outEntity);
 
     //temporaire
     void ManageSearchFile(Dtk_SearchFileEnum::Status inStatus);
 
};
 
Dtk_bool IsDtkApiStarted() ;
Dtk_bool IsDtkApiBroken() ;
 
Dtk_string dtkTypeError( Dtk_Int32 errNumero );
int dtkDumpTypeError( Dtk_Int32 errNumero, Dtk_string inMyDumpFile );
 
 
#endif