download.php

/**********************************************************

 *                   CrossCadWare.h

 **********************************************************/


#ifndef _CROSSCADWARE_H_

#define _CROSSCADWARE_H_


//FormatsDefinition


#define DTK_IN              1   // Internal use

#define DTK_ACIS            2   // Acis files .sat or .sab

#define DTK_STEP            4   // Step files .stp .step

#define DTK_PARASOLID       5   // Parasolid files .x_t .x_b .xmt

#define DTK_IGES            6   // Iges files .igs .iges

#define DTK_CATIAV4         8   // Catia V4 files

#define DTK_CATIAV5         9   // Catia V5 files

#define DTK_PROE           12   // ProEngineer - Creo files

#define DTK_ROBFACE        13   // Robface files

#define DTK_ROBFACE_FACET  14   // Robface facetted files

#define DTK_SOLIDWORKS     15   // Solidworks files

#define DTK_SOLIDEDGE      16   // Solidedge files

#define DTK_UNIGRAPHICS    17   // Unigraphics NX files

#define DTK_UNISURF        20   // Unisurf files

#define DTK_JT             21   // Jt files

#define DTK_STL            22   // Stl files

#define DTK_VRML           23   // Vrml files

#define DTK_INVENTOR       25   // Inventor files

#define DTK_CGR            26   // Cgr files

#define DTK_3DXML          28   // 3DXml files

#define DTK_DXF            33   // Dxf 2D Files

#define DTK_CATIAV6        34   // Catia V6 files

#define DTK_DWG            35   // Dwg files

#define DTK_PLMXML         36   // PLM Xml files

#define DTK_COLLADA        37   // Collada files

#define DTK_PDF            39   // Pdf 3D files

#define DTK_OCC            42   // Open Cascade files

#define DTK_BREPOCC        42   // Open Cascade Brep files

#define DTK_PDF2D          43   // Pdf Drawing files

#define DTK_3DM            44   // Rhinoceros 3D files

#define DTK_OBJ            45   // Rhinoceros 3D files

#define DTK_PARASOLIDB     46   // Parasolid files .x_b

#define DTK_PRC            47   // PRC files

#define DTK_IFC            48   // IFC files

#define DTK_EMF            49   // EMF files

#define DTK_3MF            50   // 3MF files

#define DTK_RVT            52   // Revit files

#define DTK_CRV            53   // CreoView files

#define DTK_GLTF           54   // Gltf files

#define DTK_FBX            55   // Fbx files

#define DTK_SMG            58   // Smg files

#define DTK_F3D            59   // F3d files

#define DTK_NAVIS          62   // Navis files

#define DTK_DXF3D          63   // DXF 3D files

#define DTK_QIF            65   // Qif files

#define DTK_ZW3D           66   // Zw3d files

#define DTK_USD            67   // Usd files


//End_FormatsDefinition


///! \brief Callback function to monitor the progress of a file conversion

//!

//! \param[in] inProgressBarNumber Progress bar ID

//! \param[in] inPercent           Current progress percentage

typedef void( *Progress_dtk ) ( int* inProgressBarNumber, int* inPercent );


//MainFunctions


//! \brief Returns the version number of CrossCadWare.dll

//!

//! \return int Version number of CrossCadWare.dll

typedef int( *GetProductVersionFunction ) ( );


//! \brief Returns the release number of CrossCadWare.dll

//!

//! \return int Release number of CrossCadWare.dll

typedef int( *GetProductReleaseFunction ) ( );


//! \brief Converts an input file to the requested output format.

//!

//! Uses the Datakit/CrossCadWare libraries and the provided configuration file.

//!

//! \param[in] inInputFormat                File type to read (see supported formats defined above)

//! \param[in] inOutputFormat               File type to write (see supported formats defined above)

//! \param[in] inInputFile                  Path to the input file to read

//! \param[in] inOutputFile                 Path to the output file to write

//! \param[in] inConfigFile                 Path to the configuration file (use the config file delivered with the DLL to ensure proper options are selected)

//! \param[in] inSchemaDirectory            Path to the Parasolid schema directory, or NULL (required for Unigraphics/NX, SolidWorks, Parasolid, Solid Edge files)

//! \param[in] inProgressBarFunction        Progress callback function or NULL (see Progress_dtk() declaration above)

//! \param[in] inRemoveProgressDialogBoxes  Set to 1 to suppress dialog boxes, 0 to allow them

//! \param[in] inSerial                     Customer key ID provided by Datakit, or NULL

//! \param[in] inFutureUse0                 Reserved for future use â set to 0

//! \param[in] inFutureUse1                 Reserved for future use

//! \param[in] inFutureUse2                 Reserved for future use

//! \param[in] inFutureUse3                 Reserved for future use

//! \param[in] inSerialTest                 Test customer key ID provided by Datakit, or NULL

//!

//! \return int Error code: 0 on success, non-zero on failure (see errors below)

typedef int( *ConvertFunction )(

                int inInputFormat,

                int inOutputFormat,

                wchar_t* inInputFile,

                wchar_t* inOutputFile,

                wchar_t* inConfigFile,

                wchar_t* inSchemaDirectory,

                Progress_dtk inProgressBarFunction,

                int inRemoveProgressDialogBoxes,

                wchar_t* inSerial,

                int inFutureUse0,

                int inFutureUse1,

                int inFutureUse2,

                int inFutureUse3,

                wchar_t* inSerialTest );


//ErrorDefinitions


// dtkWarningInvalidArgument     = -1010, // File extension and file format do not match

// dtkErrorUnspecified           = -1001, // Unspecified error

// dtkErrorTypeNotSupported      = -1000, // File format invalid or not supported

// dtkWarningNoEntitiesWritten   =   -32, // No entities were written to the output file

// dtkErrorFileNotExist          =   -28, // Input file does not exist

// dtkErrorVersionNotSupported   =   -27, // File version not supported

// dtkErrorOpenOutputFile        =   -23, // Cannot open output file

// dtkErrorOpenInputFile         =   -22, // Cannot open input file

// dtkErrorSchemaNotFound        =   -15, // Missing Schema file

// dtkErrorOpenConfigFile        =   -13, // Cannot open configuration file

// dtkErrorOutputFile            =    -6, // Output file error

// dtkErrorInputFile             =    -5, // Input file error

// dtkErrorLicence               =    -4, // License error

// dtkErrorLicenceCmd            =    -44, // License error

// dtkErrorOpenFiles             =    -2, // Cannot open files

// dtkErrorAllocation            =    -1, // Memory allocation error

// dtkNoError                    =     0, // No error (success)

// dtkErrorUserBreak             =     1, // Conversion aborted by user


//End_ErrorDefinitions


//! \brief Returns the file format code corresponding to the predefined constants.

//!

//! This function checks the input file and returns the matching format code (see formats defined above)

//! If the format is unknown, the function returns 0.

//!

//! \return int Format code of the file, or 0 if unknown

typedef int  ( *CheckFileFormatFunction )( const wchar_t* inInputFile );


//! \brief Returns the file format code corresponding to the predefined constants.

//!

//! This function checks the input file and returns the matching format code (see formats defined above)

//! If the format is unknown, the function returns 0.

//!

//! \return int Format code of the file, or 0 if unknown

typedef int  ( *CheckFileFormatFunctionA )( const char* inInputFile );


//! \brief Returns the file format as a string.

//!

//! This function retrieves the format of the given file

//! and returns it as a human-readable string.

//!

//! \return wchar_t File format as string

typedef wchar_t* ( *CheckFileFormatStringFunction )( const wchar_t* inInputFile );


//! \brief Checks the version of the specified input file.

//!

//! If the license allows, the version string is returned in \p outVersion.

//! The caller is responsible for allocating and freeing \p outVersion.

//!

//! \param[in]  inInputFile Path to the input file to check

//! \param[out] outVersion  Pointer that will receive the detected version string

//!

//! \return int Error code: 0 on success, non-zero on failure (see errors above)

typedef int  ( *CheckFileVersionFunction )( const wchar_t* inInputFile, wchar_t** outVersion );


//! \deprecated use _dtkCheckFileVersion

typedef int  ( *CheckFileVersionFunctionA )( const wchar_t* inInputFile, char** outVersion );


//End_MainFunctions


//AssmFunctions


//! \brief Returns the list of children for the specified assembly file.

//!

//! This function analyzes the specified assembly file and retrieves the list

//! of child file paths (parts, sub-assemblies, etc.) referenced within it.

//!

//! \param[in]  inFileName        Path to the assembly file to process

//! \param[out] outChildren       Array of wide string pointers containing the child file paths,

//!                               including both the successfully found files and the missing ones.

//!                               Memory for this array is allocated inside the function and must

//!                               be released by the caller (each string + the array itself).

//! \param[out] outChildrenCount  Number of child file paths returned in outChildren

//! \param[in]  inSchemaDirectory Path to the schema directory (optional, may be required for certain formats)

//! \param[in]  inSerial          Customer key ID provided by Datakit (optional, may be null)

//! \param[in]  inSerialTest      Test customer key ID provided by Datakit (optional, may be null)

//!

//! \return Error code indicating the result of the operation

//!         (0 for success, non-zero for failure)

typedef int ( *FindAssemblyChildrenFunction )(

                    const wchar_t* inMyFile,

                    wchar_t**& outChildren,

                    size_t& outChildrenCount,

                    const wchar_t* inMySchemaDir,

                    wchar_t* inClientId,

                    wchar_t* inTestClientId );


//! \brief Returns the list of root assembly files found in the specified directory.

//!

//! This function scans the given directory and identifies all root assembly files

//! present within it. A root assembly is defined as a top-level assembly file that

//! is not referenced as a child of any other assembly in the same directory.

//!

//! \param[in]  inDirectory        Path to the directory to scan for root assemblies.

//! \param[out] outChildren        Array of wide string pointers containing the full paths

//!                                to the detected root assembly files. Memory for this array

//!                                and for each string is allocated inside the function and

//!                                must be released by the caller (each string + the array itself).

//! \param[out] outChildrenCount   Number of root assembly file paths returned in outChildren.

//! \param[in]  inSchemaDirectory  Path to the schema directory (optional, may be required for certain formats).

//! \param[in]  inSerial           Customer key ID provided by Datakit (optional, may be null).

//! \param[in]  inSerialTest       Test customer key ID provided by Datakit (optional, may be null).

//!

//! \return Error code indicating the result of the operation

//!         (0 for success, non-zero for failure).

typedef int ( *FindRootAssembliesFunction )(

                    const wchar_t* inDirectory,

                    wchar_t**& outChildren,

                    size_t& outChildrenCount,

                    const wchar_t* inSchemaDirectory,

                    wchar_t* inSerial,

                    wchar_t* inSerialTest );


//End_AssmFunctions


#endif