MC3DDataFileExport.h

Go to the documentation of this file.

/**
* @file MC3DDataFileExport.h
* @brief Function prototypes for file export functions
*
* @author LMI Technologies
*/

#ifndef _MC3DDataFileExport_h
#define _MC3DDataFileExport_h

#include "MC3DDefs.h"

#if defined(WIN32) || defined(WIN64)
#  define MC3D_EXPORT __declspec(dllexport)
#else
#  define MC3D_EXPORT   
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/**
Image types
*/
#define MC_DATA_FILE_IMAGE_TYPE_CAMERA (char)0
#define MC_DATA_FILE_IMAGE_TYPE_HEIGHT (char)1

/**
A structure for file input parameters
*/
struct TMC3D_DataFileFD3Data
{
   short m_nSizeX;      /**< Size in X */
   short m_nSizeY;      /**< Size in Y */
   double   m_dScaleX;     /**< Scaling factor in X direction */
   double   m_dScaleY;     /**< Scaling factor in Y direction */
   double   m_dScaleZ;     /**< Scaling factor in Z direction */
   char  m_cImageType;  /**< Image type, see  MC_DATA_FILE_IMAGE_TYPE_CAMERA and MC_DATA_FILE_IMAGE_TYPE_HEIGHT */
};


/**
Returns the version of the MikroCAD 3d library

@return           Version number
*/
MC3D_EXPORT int __cdecl MC3D_Version();

/**
Saves height data in FD3 format

@param   pszFileName File name
@param   pnData         Input data array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   fScaleX     Scaling factor in x direction
@param   fScaleY     Scaling factor in y direction
@param   fScaleZ     Scaling factor in z direction
@param   cImageType     Image type
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_WriteDataFileFD3(
   const char     *pszFileName,
   short       *pnData,
   short        nSizeX,
   short        nSizeY,
   float        fScaleX = 1.0f,
   float        fScaleY = 1.0f,
   float        fScaleZ = 1.0f,
   char         cImageType = MC_DATA_FILE_IMAGE_TYPE_HEIGHT);

/**
Saves height data with valid array in FD3 format

@param   pszFileName File name
@param   pnData         Input data array
@param   pbValid     Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   fScaleX     Scaling factor in x direction
@param   fScaleY     Scaling factor in y direction
@param   fScaleZ     Scaling factor in z direction
@param   cImageType     Image type
@return           Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_WriteDataFileFD3Valid(
   const char     *pszFileName,
   short       *pnData,
   bool        *pbValid,
   short        nSizeX,
   short        nSizeY,
   float        fScaleX = 1.0f,
   float        fScaleY = 1.0f,
   float        fScaleZ = 1.0f,
   char         cImageType = MC_DATA_FILE_IMAGE_TYPE_HEIGHT);

/**
Read description from a FD3 file

@param   pszFileName File name
@return           TMC3D_DataFileFD3Data structure
*/
MC3D_EXPORT TMC3D_DataFileFD3Data * __cdecl MC3D_ReadDescriptionDataFD3(
   char  *pszFileName);

/**
Read data from a FD3 file

@param   pszFileName File name
@param   pnData      Output Data array
@return           Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_ReadDataFileFD3(
   char  *pszFileName,
   short *pnData);

#ifdef __cplusplus
}
#endif

#endif // _MC3DDataFileExport_h