tecutilq.h

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

#if defined EXTERN
#undef EXTERN
#endif
#if defined TECUTILQMODULE
#define EXTERN
#else
#define EXTERN extern
#endif

#if defined ADDON

/* CORE SOURCE CODE REMOVED */

/* 
BEGINMSWINSECTION
*/
#ifdef MSWIN 
/* Add new Windows only functions here */
#endif
/* 
ENDMSWINSECTION 
*/

/* 
BEGINMOTIFSECTION 
*/

#ifdef MOTIF
/* Add new Motif only functions here */
LINKTOADDON void STDCALL TecUtilInterfaceGetMotifHandles(XtAppContext *AppContext,
                                                         Widget       *MainWidget);
#endif
/* 
ENDMOTIFSECTION
*/

LINKTOADDON Boolean_t STDCALL TecUtilBlankingCheckDataPoint(EntIndex_t Zone,
                                                            LgIndex_t  PointIndex);
 
LINKTOADDON Boolean_t STDCALL TecUtilBlankingCheckFECell(EntIndex_t Zone,
                                                         LgIndex_t  CellIndex);
 
LINKTOADDON Boolean_t STDCALL TecUtilBlankingCheckIJKCell(EntIndex_t  Zone,
                                                          IJKPlanes_e ZonePlane,
                                                          LgIndex_t   CellIndex);

LINKTOADDON int           STDCALL TecUtilLockGetCount(void);
LINKTOADDON Boolean_t     STDCALL TecUtilLockIsOn(void);

LINKTOADDON LgIndex_t     STDCALL TecUtilGetTecplotVersion(void);
LINKTOADDON char *        STDCALL TecUtilTecplotGetHomeDirectory(void);

LINKTOADDON int           STDCALL TecUtilFrameGetCount(void);
LINKTOADDON FrameMode_e   STDCALL TecUtilFrameGetMode(void);

LINKTOADDON int           STDCALL TecUtilPickListGetCount (void);
LINKTOADDON PickObjects_e STDCALL TecUtilPickListGetType (int PickListIndex);
LINKTOADDON char *        STDCALL TecUtilPickListGetFrameName (int PickListIndex);
LINKTOADDON void          STDCALL TecUtilAxisGetRange(char   Axis,
                                                      short  AxisNum,
                                                      double *AxisMin,
                                                      double *AxisMax);
LINKTOADDON char          STDCALL TecUtilPickListGetAxisKind (int PickListIndex);
LINKTOADDON int           STDCALL TecUtilPickListGetAxisNumber (int PickListIndex);
LINKTOADDON EntIndex_t    STDCALL TecUtilPickListGetZoneNumber (int PickListIndex);
LINKTOADDON void          STDCALL TecUtilPickListGetZoneIndices (int PickListIndex,
                                                                LgIndex_t *IIndex,
                                                                LgIndex_t *JIndex,
                                                                LgIndex_t *KIndex);
LINKTOADDON EntIndex_t    STDCALL TecUtilPickListGetXYMapNumber (int PickListIndex);
LINKTOADDON LgIndex_t     STDCALL TecUtilPickListGetXYMapIndex (int PickListIndex);
LINKTOADDON Text_ID       STDCALL TecUtilPickListGetText (int PickListIndex);
LINKTOADDON Geom_ID       STDCALL TecUtilPickListGetGeom (int PickListIndex);
LINKTOADDON void          STDCALL TecUtilPickListGetGeomInfo (int PickListIndex,
                                                                SmInteger_t *PolylineNum,
                                                                LgIndex_t   *PointIndex);

LINKTOADDON void STDCALL TecUtilVarGetMinMax(EntIndex_t Var,
                                             double     *VarMin,
                                             double     *VarMax);


LINKTOADDON void STDCALL TecUtilDataFECellGetNodes(EntIndex_t Zone,
                                                 int        Face,
                                                 LgIndex_t  CellIndex,
                                                 LgIndex_t *I1,
                                                 LgIndex_t *I2,
                                                 LgIndex_t *I3,
                                                 LgIndex_t *I4);

LINKTOADDON void STDCALL TecUtilDataIJKCellGetIndices(EntIndex_t  Zone,
                                                      IJKPlanes_e Plane,
                                                      LgIndex_t   CellIndex,
                                                      LgIndex_t  *I1,
                                                      LgIndex_t  *I2,
                                                      LgIndex_t  *I3,
                                                      LgIndex_t  *I4);

/* General query */
LINKTOADDON ArbParam_t STDCALL TecUtilFieldStyleGetArbValue(EntIndex_t  Zone,
                                                            const char *S1,
                                                            const char *S2,
                                                            const char *S3);

LINKTOADDON double STDCALL TecUtilFieldStyleGetDoubleValue( EntIndex_t Zone,
                                                            const char *S1,
                                                            const char *S2,
                                                            const char *S3);

LINKTOADDON ArbParam_t STDCALL TecUtilXYMapStyleGetArbValue(EntIndex_t XYMap,
                                                            const char *S1,
                                                            const char *S2,
                                                            const char *S3);

LINKTOADDON double STDCALL TecUtilXYMapStyleGetDoubleValue( EntIndex_t XYMap,
                                                            const char *S1,
                                                            const char *S2,
                                                            const char *S3);



/*
 * Query for Unique ID's
 */
LINKTOADDON UniqueID_t STDCALL TecUtilFrameGetUniqueID(void);
LINKTOADDON UniqueID_t STDCALL TecUtilDataSetGetUniqueID(void);
LINKTOADDON UniqueID_t STDCALL TecUtilZoneGetUniqueID(EntIndex_t Zone);
LINKTOADDON UniqueID_t STDCALL TecUtilVarGetUniqueID(EntIndex_t Var);


/*
 * Get var or zone number from unique id.
 */
LINKTOADDON EntIndex_t STDCALL TecUtilVarGetNumByUniqueID(UniqueID_t UniqueID);
LINKTOADDON EntIndex_t STDCALL TecUtilZoneGetNumByUniqueID(UniqueID_t UniqueID);

/*
 * Get the variable number within the dataset.
 *
 * Var may be one of 'X','Y','Z','U','V','W','C','S'
 *
 * This returns -1 on error.
 *
 */
LINKTOADDON EntIndex_t STDCALL TecUtilVarGetNumByAssignment(char Var);

/*
 * Get the variable number within the dataset.
 *
 * Varname is a "simple" variable name
 *
 * This returns -1 on error.
 *
 */
LINKTOADDON EntIndex_t STDCALL TecUtilVarGetNumByName(const char *VarName);



/*
 * Get the pointer to the raw field data in tecplot.
 * Use this function with extreme caution.  
 *
 * DO NOT ASSUME THAT RAW DATA INTERNAL TO TECPLOT
 * REMAINS IN THE SAME LOCATION AT ALL TIMES.  ALWAYS
 * CALL THIS FUNCTION AFTER ANY EVENT WHERE
 * TECPLOT ITSELF MAY MOVE/ALTER THE RAW DATA.
 *
 * ALSO MAKE SURE AND CALL Action_SetResetFlagsOnVarValueChange
 * (See ACTION2.h) * AFTER ANY FIELD VALUES HAVE CHANGED.
 *
 * Return variables:
 *
 *    DataPtr....... The address to raw data.
 *    FieldDataType. The data type of the raw data.
 *                   currently this is one of:
 *
 *                         FieldDataType_Float,
 *                         FieldDataType_Double,
 *                         FieldDataType_LongInt,
 *                         FieldDataType_ShortInt,
 *                         FieldDataType_Byte,
 *                         FieldDataType_Bit,
 *                         FieldDataType_Invalid,
 *
 * A return value of FALSE indicates invalid dataset, zone, or
 * var parameters.
 *
 */
LINKTOADDON void STDCALL TecUtilDataValueGetRawPtr(EntIndex_t        Zone, /* <-activex> */
                                                   EntIndex_t        Var,
                                                   void            **DataPtr,
                                                   FieldDataType_e  *FieldDataType);

LINKTOADDON void STDCALL TecUtilDataNodeGetRawPtr(EntIndex_t Zone,
                                                  NodeMap_t  **NodeMapPtr);

LINKTOADDON void STDCALL TecUtilDataFaceNbrGetRawPtr(EntIndex_t Zone,
                                                     LgIndex_t  **FNPtr);

/*
 * TecUtilZoneGetName, TecUtilVarGetName, TecUtilXYMapGetName return a copy
 * of the zone and variable names. The client is responsible
 * for releasing the string with TecUtilStringDealloc().
 */
LINKTOADDON Boolean_t STDCALL TecUtilZoneGetName(EntIndex_t   Zone,
                                                 char       **ZName);
LINKTOADDON Boolean_t STDCALL TecUtilVarGetName(EntIndex_t   VarNum,
                                                char       **VName);
LINKTOADDON Boolean_t STDCALL TecUtilXYMapGetName(EntIndex_t Map,
                                                  char       **Name);


/*
 * Do all that Action_SetIJK does but also assign globals:
 * XD,YD,ZD,VU,VV,VW,VB,VC,VS,NM,SD, and FS
 */
LINKTOADDON void STDCALL TecUtilZoneGetInfo(EntIndex_t    CurZone,
                                            LgIndex_t     *IMax,
                                            LgIndex_t     *JMax,