global.h

Handles Hexahedral, Tetrahedral, Quadrilateral, and Triangle meshes. Lagrangian, Hierarchic, and Mon

/* CORE SOURCE CODE REMOVED */

/*
*****************************************************************
*****************************************************************
*******                                                  ********
****** (C) Copyright 1988-2001  by AMTEC ENGINEERING INC. *******
*******                                                  ********
*****************************************************************
*****************************************************************
*/

#ifndef _GLOBAL_H
#define _GLOBAL_H

#if defined EXTERN
#undef EXTERN
#endif
#if defined Q_MAINMODULE && defined TECPLOTKERNEL
#define EXTERN
#else
#define EXTERN extern
#endif



/****************************************************************
 *                                                              *
 *                          MACROS                              *
 *                                                              *
 ****************************************************************/
#if defined TRUE
#undef TRUE
#endif
#if defined FALSE
#undef FALSE
#endif
#if defined MIN
#undef MIN
#endif
#if defined MAX
#undef MAX
#endif
#if defined ROUND
#undef ROUND
#endif
#if defined ROUND2
#undef ROUND2
#endif
#if defined TRUNC
#undef TRUNC
#endif

#define TRUE                  ((Boolean_t)1)
#define FALSE                 ((Boolean_t)0)

/****************************************************************
 *                                                              *
 *                           MACROS                             *
 *                                                              *
 ****************************************************************/
#define ABS(X)                ((X) >= 0 ? (X) : -(X) )
#define MAX(X,Y)              ((X) > (Y) ? (X) : (Y) )
#define MIN(X,Y)              ((X) < (Y) ? (X) : (Y) )
#define BESTSHOWCOLOR(X)      ((X) == White_C ? Black_C : White_C)
#define ROUND(X)              ((short)((X)+0.499))
#define ROUNDL(X)             ((LgIndex_t)((X)+0.499))
#define ROUND2(X)             ((X) >= 0 ? ((int)((X)+0.499)) : ((int)((X)-0.499)))
#define TRUNC(X)              ((short) (X))
#define RAD_TO_DEG(rad)       (180.*(rad)/PI)
#define DEG_TO_RAD(deg)       (PI*(deg)/180.)
#define CAPITAL(C)            ((islower(C) ? toupper(C) : (C)))
#define ISWHITESPACE(C)       ((C == ' ') || (C == '\t') || (C == '\n'))
#define ISSEPARATOR(C)        ((C == ' ') || (C == '\t') || (C == ','))
#define IJKINDEX(I,J,K)       ((I) + \
                               ((J)*CZData->NumIPts) + \
                               ((K)*CZData->NumIJPts))
#define IINDEX(N)             ((N) % CZData->NumIPts)
#define JINDEX(N)             (((N) % CZData->NumIJPts)/CZData->NumIPts)
#define KINDEX(N)             ((N)/CZData->NumIJPts)
#define SWITCH(A,B)           {double T = A; A = B; B = T;}
#define FPRINTFOK(x)          (Boolean_t)((x) > 0)
#define GRAPHICSARE3D(F)      ((F->FrameMode == Frame_ThreeD))

/* convenience macros for implication, P -> Q, and equivalence, P <-> Q. */
#define IMPLICATION(P,Q) (!(P) || (Q))
#define EQUIVALENCE(P,Q) ((P) == (Q))

/* suppress compiler warnings about unused parameters */
#ifndef UNUSED
# define UNUSED(param) (void)param
#endif 

/**
 * Reverses the byte order of the specified 2 byte buffer.
 *
 * param Buffer
 *     Pointer to the 2 bytes needing byte order reversal.
 */
#define REVERSE_2BYTES(Buffer) \
          { \
            char Byte0 = ((char *)(Buffer))[0]; \
            ((char *)(Buffer))[0] = ((char *)(Buffer))[1]; \
            ((char *)(Buffer))[1] = Byte0; \
          }

/**
 * Reverses the byte order of the specified 4 byte buffer.
 *
 * param Buffer
 *     Pointer to the 4 bytes needing byte order reversal.
 */
#define REVERSE_4BYTES(Buffer) \
          { \
            char Byte0 = ((char *)(Buffer))[0]; \
            char Byte1 = ((char *)(Buffer))[1]; \
            ((char *)(Buffer))[0] = ((char *)(Buffer))[3]; \
            ((char *)(Buffer))[3] = Byte0; \
            ((char *)(Buffer))[1] = ((char *)(Buffer))[2]; \
            ((char *)(Buffer))[2] = Byte1; \
          }

/**
 * Reverses the byte order of the specified 8 byte buffer.
 *
 * param Buffer
 *     Pointer to the 8 bytes needing byte order reversal.
 */
#define REVERSE_8BYTES(Buffer) \
          { \
            char Byte0 = ((char *)(Buffer))[0]; \
            char Byte1 = ((char *)(Buffer))[1]; \
            char Byte2 = ((char *)(Buffer))[2]; \
            char Byte3 = ((char *)(Buffer))[3]; \
            ((char *)(Buffer))[0] = ((char *)(Buffer))[7]; \
            ((char *)(Buffer))[7] = Byte0; \
            ((char *)(Buffer))[1] = ((char *)(Buffer))[6]; \
            ((char *)(Buffer))[6] = Byte1; \
            ((char *)(Buffer))[2] = ((char *)(Buffer))[5]; \
            ((char *)(Buffer))[5] = Byte2; \
            ((char *)(Buffer))[3] = ((char *)(Buffer))[4]; \
            ((char *)(Buffer))[4] = Byte3; \
          }


/****************************************************************
 *                                                              *
 *             ADDON MSWIN IMPORT/EXPORT DEFINITIONS            *
 *                                                              *
 ****************************************************************/
#if defined MSWIN
#  define STDCALL __stdcall
#else
#  define STDCALL
#endif /* MSWIN */

#if defined (__cplusplus)
# define EXTERNC extern "C"
#else
# define EXTERNC
#endif /* __cplusplus */

#if defined MSWIN && defined ADDON
# define LINKTOADDON EXTERNC _declspec ( dllimport )
#else
# define LINKTOADDON EXTERNC
#endif /* MSWIN && ADDON */

/* Note: Add-ons should never define AMTEC_INTERNAL_MAKELIBTEC */
#if defined MSWIN && !defined TECPLOTKERNEL && defined AMTEC_INTERNAL_MAKELIBTEC
# undef LINKTOADDON
# define LINKTOADDON EXTERNC _declspec ( dllexport )
#endif

/*
 *
 * Usage:
 * EXPORTFROMADDON void STDCALL InitTecAddOn(void) { ... }
 *
 */

#if defined MSWIN && defined ADDON
# define EXPORTFROMADDON EXTERNC _declspec ( dllexport )
#else
# define EXPORTFROMADDON EXTERNC
#endif /* MSWIN && ADDON */

#define EXPORTFROMDLL EXPORTFROMADDON 

/* CORE SOURCE CODE REMOVED */


/* CORE SOURCE CODE REMOVED */


/****************************************************************
 *                                                              *
 *                       HARD CONSTANTS                         *
 *                                                              *
 ****************************************************************/
/* CORE SOURCE CODE REMOVED */

#define MAXINDEX                (LgIndex_t)2147483646   /* int */
#define MAXZONEMAP               32700                  /* int */
#define LARGEDOUBLE              1.0e+150               /* double */
#define SMALLDOUBLE              1.0e-150               /* double */
#define LARGESTEXPONENT          150                    /* int */
#define SMALLESTEXPONENT         -150                   /* int */
#if defined VMS
#  define LARGESTDOUBLEEXPONENT  307  /* int */
#  define SMALLESTDOUBLEEXPONENT -307 /* int */
#  define LARGESTDOUBLE          1.0e+307 /* double */
#  define LARGEFLOAT             1.0e+37  /* float */
#  define SMALLFLOAT             1.0e-37  /* float */
#else
#  define LARGESTDOUBLEEXPONENT  308
#  define SMALLESTDOUBLEEXPONENT -307
#  define LARGESTDOUBLE          1.0e+308
#  define LARGEFLOAT             3.40282347E+38
#  define SMALLFLOAT             1.17549435E-38
/* Do not remove SMALLSTDOUBLE: needed for ActiveX library */
#  define SMALLSTDOUBLE          1.0e-307 /* double */
#endif
#define LARGELONG                MAXINDEX /* long */
#define LARGESHORT               32766    /* short */
#define ETX                      3        /* int */
#define LN10                     2.30258509299404568402 /* double */
#define PIOVER2                  1.57079632679489661923 /* double */
#define TWOPI                    6.28318530717958647692 /* double */
#if defined PI
#undef PI
#endif
#define PI                       3.14159265358979323846 /* double */
#define ANGLEEPSILON             1.0e-10                /* double */
#define LARGESTANGLE             (4*PI+ANGLEEPSILON)    /* double */
#define DEGPERRADIANS            57.295779513082323     /* double */
#define CMPERINCH                2.54                   /* double */
#define POINTSPERINCH            72.0                   /* double */
#define FONTMOVEMARK             192                    /* int */
#define FONTDECISIONMARK         128                    /* int */
#define FONTLINEMARK             64                     /* int */ 
#define BAD_SET_VALUE            ((SetIndex_t)-1)       /* int */
#define SOLID_TRANSLUCENCY       0                      /* int */
#define BAD_DISTANCE             (-1.0)                 /* double */
/* MIN_CIRCUMFERENTIAL_INDEX is the min J dimension for circular zones */
#define MIN_CIRCUMFERENTIAL_INDEX  4                    /* int */

/* CORE SOURCE CODE REMOVED */

/* CORE SOURCE CODE REMOVED */

#define CurBinaryFileVersion         75  /* int */
#define TecplotInterfaceVersion      90  /* int */            

#define    MaxNumZonesOrVars         MAXZONEMAP /* int */
#define    MaxNumPickObjects         1500 /* int */
#define    MaxXAxes                  5    /* int */
#define    MaxYAxes                  5    /* int */
#define    MaxGeoSegments            50   /* int */
#define    MaxPtsCircleOrEllipse     720  /* int */
#define    MaxFrames                 128  /* int */
#define    MaxCustomLabelSets        10   /* int */
#define    MaxCustomLabelsPerSet     5000 /* int */
#define    MaxFontMoves              20000  /* int */
#define    MaxColorMapOverrides      16     /* int */
#define    MaxValueBlankConstraints  8      /* int */
#define    MaxChrsDatasetTitle       256    /* int */
#define    MaxChrsZnTitle            64     /* int */
#define    MaxChrsVarName            64     /* int */
#define    MaxNumViews               16     /* int */
#define    MaxBasicSizes             5      /* int */
#define    MaxColorMapControlPoints  9      /* int */
#define    MaxRawColorMapEntries     800    /* int */
#define    MaxDataSetReaders         100    /* int */
#define    MaxExtendedCurveFits      100    /* int */
#define    MaxColorMapCycles         20     /* int */


/* Dimension Limits */

#define    MinPaperDimInWorkArea     0.5    /* double */
#define    MinFrameWidth             0.25   /* double */
#define    MinFrameHeight            0.25   /* double */
#define    MinAxisLength             0.1    /* double */


#define    BadEnumValue              255    /* int */


/* CORE SOURCE CODE REMOVED */

/* CORE SOURCE CODE REMOVED */

#define    Black_C           ((ColorIndex_t)0)
#define    Red_C             ((ColorIndex_t)1)
#define    Green_C           ((ColorIndex_t)2)
#define    Blue_C            ((ColorIndex_t)3)
#define    Cyan_C            ((ColorIndex_t)4)
#define    Yellow_C          ((ColorIndex_t)5)
#define    Purple_C          ((ColorIndex_t)6)
#define    White_C           ((ColorIndex_t)7)

#define    Custom1_C         ((ColorIndex_t)8)
#define    Custom2_C         ((ColorIndex_t)9)
#define    Custom3_C         ((ColorIndex_t)10)
#define    Custom4_C         ((ColorIndex_t)11)
#define    Custom5_C         ((ColorIndex_t)12)
#define    Custom6_C         ((ColorIndex_t)13)
#define    Custom7_C         ((ColorIndex_t)14)
#define    Custom8_C         ((ColorIndex_t)15)
#define    Custom9_C         ((ColorIndex_t)16)

#define    Custom10_C         ((ColorIndex_t)17)
#define    Custom11_C         ((ColorIndex_t)18)
#define    Custom12_C         ((ColorIndex_t)19)
#define    Custom13_C         ((ColorIndex_t)20)
#define    Custom14_C         ((ColorIndex_t)21)
#define    Custom15_C         ((ColorIndex_t)22)
#define    Custom16_C         ((ColorIndex_t)23)
#define    Custom17_C         ((ColorIndex_t)24)
#define    Custom18_C         ((ColorIndex_t)25)
#define    Custom19_C         ((ColorIndex_t)26)

#define    Custom20_C         ((ColorIndex_t)27)
#define    Custom21_C         ((ColorIndex_t)28)
#define    Custom22_C         ((ColorIndex_t)29)
#define    Custom23_C         ((ColorIndex_t)30)
#define    Custom24_C         ((ColorIndex_t)31)
#define    Custom25_C         ((ColorIndex_t)32)
#define    Custom26_C         ((ColorIndex_t)33)
#define    Custom27_C         ((ColorIndex_t)34)
#define    Custom28_C         ((ColorIndex_t)35)
#define    Custom29_C         ((ColorIndex_t)36)

#define    Custom30_C         ((ColorIndex_t)37)
#define    Custom31_C         ((ColorIndex_t)38)
#define    Custom32_C         ((ColorIndex_t)39)
#define    Custom33_C         ((ColorIndex_t)40)
#define    Custom34_C         ((ColorIndex_t)41)
#define    Custom35_C         ((ColorIndex_t)42)
#define    Custom36_C         ((ColorIndex_t)43)
#define    Custom37_C         ((ColorIndex_t)44)
#define    Custom38_C         ((ColorIndex_t)45)
#define    Custom39_C         ((ColorIndex_t)46)

#define    Custom40_C         ((ColorIndex_t)47)
#define    Custom41_C         ((ColorIndex_t)48)
#define    Custom42_C         ((ColorIndex_t)49)
#define    Custom43_C         ((ColorIndex_t)50)
#define    Custom44_C         ((ColorIndex_t)51)
#define    Custom45_C         ((ColorIndex_t)52)
#define    Custom46_C         ((ColorIndex_t)53)
#define    Custom47_C         ((ColorIndex_t)54)
#define    Custom48_C         ((ColorIndex_t)55)
#define    Custom49_C         ((ColorIndex_t)56)

#define    Custom50_C         ((ColorIndex_t)57)
#define    Custom51_C         ((ColorIndex_t)58)
#define    Custom52_C         ((ColorIndex_t)59)
#define    Custom53_C         ((ColorIndex_t)60)
#define    Custom54_C         ((ColorIndex_t)61)
#define    Custom55_C         ((ColorIndex_t)62)
#define    Custom56_C         ((ColorIndex_t)63)

#define    MultiColor_C      ((ColorIndex_t)(-1))
#define    NoColor_C         ((ColorIndex_t)(-2))
#define    InvalidColor_C    ((ColorIndex_t)(-255))

/* CORE SOURCE CODE REMOVED */

/****************************************************************
 *                                                              *
 *                          SIMPLE TYPEDEFS                     *
 *                                                              *
 ****************************************************************/



#if defined DECALPHA || defined LINUXALPHA || defined COMPAQALPHA
#define LONGIS64
#endif


#if defined CRAY
typedef    unsigned int    UInt64_t;
#endif

#if defined MSWIN
typedef    unsigned __int64 UInt64_t;
#endif

#if defined LONGIS64
typedef    unsigned int    UInt32_t;
typedef    int             LgInteger_t;
#else
typedef    unsigned long   UInt32_t;
typedef    long int        LgInteger_t;
#endif

typedef    unsigned short  UInt16_t;

typedef    int             LgIndex_t;
typedef    LgIndex_t       NodeMap_t;
typedef    LgIndex_t       ScreenDim_t;

/*
 *  The following type is used for passing
 *  arbituary integers or pointers in parameters
 *  to the setvalue function.
 *  NOTE the following:
 *
 *  Pointers are 8 bytes on the DEC ALPHA (same with long's)
 *  Just about everything is 8 bytes on CRAY.
 */

#if defined CRAY
typedef char*      ArbParam_t;
#else
#  if defined LONGIS64
   typedef long ArbParam_t;
#  else
   typedef LgIndex_t  ArbParam_t;
#  endif
#endif
typedef    ArbParam_t      UniqueID_t;

/* used to hold file offset and size values */
typedef long FileOffset_t;

/*
 *  SmInteger must be at least a short....
 */

typedef    unsigned char    Byte_t;
typedef    short            SmInteger_t;
typedef    SmInteger_t      ColorIndex_t;
typedef    SmInteger_t      EntIndex_t;

typedef    char             Boolean_t;
typedef    char            *ZoneName_t;
typedef    char            *VarName_t;
typedef    char            *LString_t;

typedef    LgIndex_t        HeapLength_t;
typedef    LgIndex_t        SegPtsArray_t[MaxGeoSegments];
typedef    double           BasicSize_t[MaxBasicSizes];
typedef    double          *VarList_t;

typedef    long             SetIndex_t;

typedef    unsigned long    SetData_t;
typedef    SetData_t       *SetData_pt;

/* CORE SOURCE CODE REMOVED */

typedef    char             SymbolChar_t[3];




/****************************************************************
 *                                                              *
 *                     ENUMERATED TYPEDEFS                      *
 *                                                              *
 ****************************************************************/


/* CORE SOURCE CODE REMOVED */

/* Used by some of the image exporters/animators */
typedef struct
  {
    Byte_t  R;
    Byte_t  G;
    Byte_t  B;
  } RGBTriple_s; 

typedef RGBTriple_s RGBPalette_t[256];

typedef enum
  {
    StateChange_VarsAltered,
    StateChange_VarsAdded,
    StateChange_ZonesDeleted,
    StateChange_ZonesAdded,
    StateChange_NodeMapsAltered,
    StateChange_FrameDeleted,
    StateChange_NewTopFrame,
    StateChange_Style,
    StateChange_DataSetReset,
    StateChange_NewLayout,
    StateChange_CompleteReset,
    StateChange_XYMapAssignment,
    StateChange_ContourLevels,
    StateChange_ModalDialogLaunch,
    StateChange_ModalDialogDismiss,
    StateChange_QuitTecplot,
    StateChange_ZoneName,
    StateChange_VarName,
    StateChange_XYMapName,
    StateChange_XYMapAddDeleteOrReorder,
    StateChange_View,
    StateChange_ColorMap,
    StateChange_ContourVar,
    StateChange_Streamtrace,
    StateChange_NewAxisVariables,
    StateChange_MouseModeUpdate,
    StateChange_PickListCleared,
    StateChange_PickListGroupSelect,
    StateChange_PickListSingleSelect,
    StateChange_PickListStyle,
    StateChange_DataSetFileName,
    StateChange_UnsuspendInterface, /* was StateChange_DrawGraphicsOn */
    StateChange_SuspendInterface, /* was StateChange_DrawGraphicsOff */
    StateChange_DataSetLockOn,
    StateChange_DataSetLockOff,
    StateChange_Text,
    StateChange_Geom,
    StateChange_DataSetTitle,
    StateChange_DrawingInterrupted,
    StateChange_PrintPreviewLaunch,
    StateChange_PrintPreviewDismiss,
    END_StateChange_e,
    StateChange_Invalid = BadEnumValue,
    /* Deprecated values */
    StateChange_DrawGraphicsOn = StateChange_UnsuspendInterface,
    StateChange_DrawGraphicsOff = StateChange_SuspendInterface
  } StateChange_e; /*<help> "StateChange_DrawGraphicsOn is deprecated. Use StateChange_UnsuspendInterface\n"*/
                   /*<help> "StateChange_DrawGraphicsOff is deprecated. Use StateChange_SuspendInterface"*/

typedef enum
  {
    StateChangeMode_v75,
    StateChangeMode_v80,
    END_StateChangeMode_e,
    StateChangeMode_Invalid = BadEnumValue
  } StateChangeMode_e;

typedef enum
{
  LayoutPackageObject_Image,
  LayoutPackageObject_Layout,
  LayoutPackageObject_Data,
  END_LayoutPackageObject_e,
  LayoutPackageObject_Invalid = BadEnumValue
} LayoutPackageObject_e;

typedef enum
  {
    VarLoadMode_ByName,
    VarLoadMode_ByPosition,
    END_VarLoadMode_e,
    VarLoadMode_Invalid = BadEnumValue
  } VarLoadMode_e;

typedef enum
  {
    ImageSelection_OnePerFrame,
    ImageSelection_WorkspaceOnly,
    END_ImageSelection_e,
    ImageSelection_Invalid = BadEnumValue
  } ImageSelection_e;

typedef enum
  {
    LibraryType_Unknown,
    LibraryType_V7Standard,
    LibraryType_V7ActiveX,
    END_LibraryType_e,
    LibraryType_Invalid = BadEnumValue
  } LibraryType_e; /* <help> "Add-on types" */


typedef enum
  {
    AssignOp_Equals,
    AssignOp_PlusEquals,
    AssignOp_MinusEquals,
    AssignOp_TimesEquals,
    AssignOp_DivideEquals,
    AssignOp_ConvertFromCm,
    AssignOp_ConvertFromIn,
    AssignOp_ConvertFromPt,