tecutilo.h

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

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

#if defined ADDON
/* CORE SOURCE CODE REMOVED */

/* 
BEGINMSWINSECTION
*/
#ifdef MSWIN 
/* Add new Windows only functions here */
LINKTOADDON Boolean_t STDCALL TecUtilInterfaceWinAddPreMsgFn(PreTranslateMessage_pf PreTranslateMessageProc);
#endif
/* 
ENDMSWINSECTION 
*/

/* 
BEGINMOTIFSECTION 
*/

#ifdef MOTIF
/* Add new Motif only functions here */
#endif
/* 
ENDMOTIFSECTION
*/



LINKTOADDON Boolean_t STDCALL   TecUtilTimerAddCallback(UInt32_t               Interval,
                                                        ArbParam_t             ClientData,
                                                        AddOnTimerCallback_pf  Callback);

/*
 * Use Tecplot's file dialogs to get a filename(s) to read or write.
 */
LINKTOADDON Boolean_t STDCALL TecUtilDialogGetFileName (SelectFileOption_e   DialogOption,
                                                        char               **FileName,
                                                        const char          *FileTypeName,
                                                        const char          *DefaultFileName,
                                                        const char          *DefaultFilter);
LINKTOADDON Boolean_t STDCALL TecUtilDialogGetFileNames (SelectFileOption_e   DialogOption,
                                                         StringList_pa       *FileNames,
                                                         const char          *FileTypeName,
                                                         StringList_pa       DefaultFileNames,
                                                         const char          *DefaultFilter);
/*
 * Turn on or off the automatic updating of the sensitivities of the
 * mouse mode buttons in the sidebar.
 */
LINKTOADDON void STDCALL TecUtilSidebarAutoSensitivity(Boolean_t DoAuto);
                                                   
/*
 * Set the sensitivity for a mouse mode button in the tecplot sidebar.
 * This is usually called after calling TecUtilSidebarAutoSensitivity
 * with a value of FALSE.
 * USE CAUTION WHEN ACTIVATING A BUTTON - FOR EXAMPLE, DO NOT ACTIVATE THE
 * CONTOUR BUTTON WHEN NO CONTOURING VARIABLE HAS BEEN DEFINED!
 * When you wish to return control of the sidebar back to tecplot then
 * call TecUtilSidebarAutoSensitivity with TRUE.
 */
LINKTOADDON void STDCALL TecUtilSidebarSetSensitivity(MouseButtonMode_e MouseMode,
                                                      Boolean_t         IsSensitive);




/*
 * Probe callback function and supporting query functions.  User installs callback
 * and later uses query functions to get probed information.
 */
LINKTOADDON Boolean_t STDCALL TecUtilProbeInstallCallback(ProbeDestination_pf ProbeDestination,
                                                          const char         *InformationLineText);
LINKTOADDON void STDCALL TecUtilProbeAllowCOBs(void);
LINKTOADDON double STDCALL TecUtilProbeXYGetIndValue(void);
LINKTOADDON Boolean_t STDCALL TecUtilProbeXYGetDepValue(EntIndex_t MapNum,
                                                        double    *DepValue);
LINKTOADDON EntIndex_t STDCALL TecUtilProbeXYGetSourceMap(void);
LINKTOADDON LgIndex_t STDCALL TecUtilProbeGetPointIndex(void);
LINKTOADDON CZType_e STDCALL TecUtilProbeFieldGetCZType(void);
LINKTOADDON double STDCALL TecUtilProbeFieldGetValue(EntIndex_t VarNum);
LINKTOADDON EntIndex_t STDCALL TecUtilProbeFieldGetZone(void);
LINKTOADDON IJKPlanes_e STDCALL TecUtilProbeFieldGetPlane(void);
LINKTOADDON LgIndex_t  STDCALL TecUtilProbeFieldGetCell(void);



LINKTOADDON Boolean_t STDCALL TecUtilExtractInstallCallback(ExtractDestination_pf ExtractDestination,
                                                            const char           *InformationLineText);




/*
 *  TecUtilDataSetCreate
 *
 *  Input variables are:
 *
 *  VarNames................... String list of Names of the variables.
 *                              This array list strings must be allocated and
 *                              deallocated by the calling function using the
                                TecUtilStringList functions.
 *                              Tecplot makes its own copy of this list.
 *  ResetStyle ................ TRUE=Remove existing Text/Geoms etc.
 */
LINKTOADDON Boolean_t STDCALL TecUtilDataSetCreate(const char    *DataSetTitle,
                                                   StringList_pa VarNames,
                                                   Boolean_t     ResetStyle);





LINKTOADDON VarLoadMode_e STDCALL TecUtilDataSetGetVarLoadMode(void);


/*
 *
 *   ZoneType can be one of:
 *                            ZoneType_Ordered, 
 *                            ZoneType_FETriangle
 *                            ZoneType_FEQuad
 *                            ZoneType_FETetra 
 *                            ZoneType_FEBrick  
 *
 *   If ZoneType_Ordered, then IMax,JMax,KMax are simply the 
 *   dimensions of the zone.  If FE_xxxx then IMax is the number 
 *   of data points and JMax is the number of elements.
 *   KMax is not used if ZoneType is FE_xxxx.
 *
 *   VarDataType is an array of FieldDataType_e which currently 
 *   can be set to one of:       
 *
 *           FieldDataType_Float,
 *           FieldDataType_Double,
 *           FieldDataType_LongInt,
 *           FieldDataType_ShortInt,
 *           FieldDataType_Byte,
 *           FieldDataType_Bit
 *
 *   Or you may set VarDataType to be NULL, in which case
 *   the data type of the vars in the first zone of the
 *   dataset are used.  NOTE: TecUtilDataSetAddZone cannot be
 *   called if a dataset does not already exist.  Call
 *   TecUtilDataSetCreate first.
 */
LINKTOADDON Boolean_t STDCALL TecUtilDataSetAddZone(const char      *Name,
                                                    LgIndex_t        IMax,
                                                    LgIndex_t        JMax,
                                                    LgIndex_t        KMax,
                                                    ZoneType_e       Type,
                                                    FieldDataType_e *VarDataType_Array);

/*
BEGIN ARGLIST NOTES TecUtilAddZoneX
  TecUtilArgListAppendString(ArgList, SV_NAME,             <string>);
  TecUtilArgListAppendInt(ArgList,    SV_ZONETYPE,         (LgIndex_t)<ZoneType_e>);
  TecUtilArgListAppendInt(ArgList,    SV_ZONE,             <int>);
  TecUtilArgListAppendInt(ArgList,    SV_IMAX,             <int>);
  TecUtilArgListAppendInt(ArgList,    SV_JMAX,             <int>);
  TecUtilArgListAppendInt(ArgList,    SV_KMAX,             <int>);
  TecUtilArgListAppendArray(ArgList,  SV_VARDATATYPE       (FieldDataType_e *));
END ARGLIST NOTES
*/
LINKTOADDON Boolean_t STDCALL TecUtilDataSetAddZoneX(ArgList_pa ArgList);

/*
 * Reallocate the size of a zone.   An attempt is made to copy the
 * old values into the new but no guarentees are made.  
 *
 * If the zone is reduced in size and the zone was FE then a check
 * is made on the connectivity list.  Any index references outside
 * the allowed range are set to 0 (i.e. the first datapoint).
 *
 * If the zone is expanded then the calling function is responsible
 * for inserting the new values in the expanded area.
 *
 */
LINKTOADDON Boolean_t STDCALL TecUtilZoneRealloc(EntIndex_t Zone,
                                                 LgIndex_t  NewIMaxOrNumDataPoints,
                                                 LgIndex_t  NewJMaxOrNumElements,
                                                 LgIndex_t  NewKMax);


/*
 * Add a variable to the current dataset. 
 * The variable is initialized to zero.
 *
 *   FieldDataType is an array of FieldDataType_e which currently 
 *   can be set to one of:       
 *
 *           FieldDataType_Float,
 *           FieldDataType_Double,
 *           FieldDataType_LongInt,
 *           FieldDataType_ShortInt,
 *           FieldDataType_Byte,
 *           FieldDataType_Bit
 *
 *   Or you may set FieldDataType to be NULL, in which case
 *   Tecplot tries to figure out a good type for you?
 *
 */
LINKTOADDON Boolean_t STDCALL TecUtilDataSetAddVar(const char *VarName,
                                                   FieldDataType_e *FieldDataType_Array);
 

/************************************************************************
 * AddOn callbacks.                                                     *
 *                                                                      *
 * The functions provided below allow you to add or remove callbacks to *
 * tecplot for various events that may occur during a tecplot session.  *
 ************************************************************************/

/*
 * Include a function in the list of functions to call when tecplot is
 * Considering to quit.
 */
LINKTOADDON Boolean_t STDCALL TecUtilQuitAddQueryCallback(MopupQueryAddOnCallback_pf QuitQueryCallback);

LINKTOADDON Boolean_t STDCALL TecUtilStateChangeSetMode(StateChangeAddOnCallback_pf Callback,
                                                        StateChangeMode_e           Mode);

/*
 * Include a function in the list of functions to call when either a dataset
 * has changed or the style has changed in tecplot.  See ADDON.h for the
 * parameters for the callback function.