tecutilo.h

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

 */
LINKTOADDON Boolean_t STDCALL TecUtilStateChangeAddCallback(StateChangeAddOnCallback_pf StateChangeCallback);

/*
 * Inform tecplot of a state change.  Currently this must be called in the following
 * situations:
 *
 *       - Launch and dismiss of modal dialogs (Windows only).
 *       - After a variable has been added and subsequently modified.
 *       - After a variable has been modified.
 *       - After TecUtilDataSetAddZone has been called and the field data has
 *         been modified (Use StateChange_ZonesAdded).
 *       - After the node map has been altered.
 *
 * The CallData parameter is required for the following state changes:
 *
 *   StateChange_VarsAltered        (A set of variables)
 *   StateChange_VarsAdded          (A set of variables)
 *   StateChange_ZonesDeleted       (A set of zones)
 *   StateChange_ZonesAdded         (A set of zones)
 *   StateChange_NodeMapsAltered    (A set of zones)
 * 
 *  See GLOBAL.h for a list of the enumerated values.  They start with StateChange_
 */
LINKTOADDON void STDCALL TecUtilStateChanged(StateChange_e StateChange,
                                             ArbParam_t    CallData);

/*
 * Include a function in the list of functions to call when a special AddOn macro command 
 * is processed.  AddOnIDString must be a unique string used to determine the appropriate
 * macro callback to use when a $!ADDONCOMMAND command is processed.
 */
LINKTOADDON Boolean_t STDCALL TecUtilMacroAddCommandCallback(const char                  *AddOnIDString,
                                                             MacroCommandAddOnCallback_pf CallbackFunction);


/*
 * If tecplot is currently "Recording" then append 
 * a $!ADDONCOMMAND command to the file.
 * AddOnIDString is a unique string that is used to determine the
 * appropriate callback function to use when the macro command is later
 * processed.
 *
 */
LINKTOADDON Boolean_t STDCALL TecUtilMacroRecordAddOnCommand(const char *AddOnIDString,
                                                             const char *Command);

 /*
  * Like TecUtilMacroRecordAddOnCommand except you can take advantage of the
  * optional RAWDATA section that can hang off of an $!ADDONCOMMAND command.
  */

LINKTOADDON Boolean_t STDCALL TecUtilMacroRecordAddOnComRaw(const char *AddOnIDString,
                                                            const char *Command,
                                                            const char *RawData);

/*
 * Send any old thing you want to a macro record file.
 */
LINKTOADDON Boolean_t STDCALL TecUtilMacroRecordRawCommand(const char *Command);




/*
 * Send an event to the low level event dispatcher in tecplot.  Use this with
 * caution.
 */
LINKTOADDON void STDCALL TecUtilDispatchWorkAreaEvent(int       I,
                                                      int       J,
                                                      int       ButtonOrKey,
                                                      Event_e   Event,
                                                      Boolean_t IsShifted,
                                                      Boolean_t IsAlted,
                                                      Boolean_t IsControlled);

/*
 * Add a user defined menu to tecplot.
 *
 * Parameter                 Notes
 *
 * MenuLabel................ Text to put on the menu option.
 * Mnemonic................. Character to underline in MenuLabel.
 *                           Use '\0' if you don't want a mnemonic.
 * Callbackvalue............ Value you want passed to MenuOptionCallback.
 * MenuOptionCallback....... Function you create.  This is called
 *                           with Callbackvalue as its only parameter.
 * NewSubOption              No longer a parameter.
 *
 */

LINKTOADDON Boolean_t STDCALL TecUtilMenuAddOption(const char            *ParentPath,
                                                   const char            *MenuLabel,
                                                   char                   Mnemonic,
                                                   DynamicMenuCallback_pf MenuOptionCallback);


/*
 * Set the sensitivity of a menu option based on its label.
 */
LINKTOADDON Boolean_t STDCALL TecUtilMenuSetSensitivity(const char      *ParentPath,
                                                         const char      *MenuLabel,
                                                         Boolean_t  IsSensitive);

/****************************************************************************
 *          DataSet Converters and Loaders.                                 *
 *                                                                          *
 * A Converter is an addon that connects to tecplot in a way such that      *
 * tecplot uses it's own file/io dialogs to read the non-Tecplot data into  *
 * tecplot and the converter is a simple function that only knows how       *
 * to convert from it's own data format into tecplot's binary format.       *
 *                                                                          *
 * Converters are registered with tecplot by calling:                       *
 *                                                                          *
 *              TecUtilImportAddConverter                                   *
 *                                                                          *
 * An loader works like this:                                               *
 *     - TecUtilMenuAddOption is called to register a callback              *
 *       (most often used to bring up a dialog) to the loader addon         *
 *                                                                          *
 *     - The loader registers itself with tecplot by calling                *
 *       TecUtilImportAddLoader                                             *
 *                                                                          *
 *     When a request is made to use the loader function:                   *
 *                                                                          *
 *        - The loader creates a new dataset and loads the data into        *
 *          tecplot by hand.                                                *
 *                                                                          *
 *        - The loader then calls TecUtilImportSetLoaderInstr               *
 *          to assign the specific instructions needed to load the data     *
 *          into the current dataset.   These instructions will be included *
 *          in any layout files written out.                                *
 ****************************************************************************/
LINKTOADDON Boolean_t STDCALL TecUtilImportAddConverter(DataSetConverter_pf DataSetConverterFunction,
                                                          const char         *DataSetConverterName,
                                                          const char         *FNameFilter);


LINKTOADDON Boolean_t STDCALL TecUtilImportAddLoader(DataSetLoader_pf                    DataSetLoaderFunction,
                                                      const char                         *DataSetLoaderName,
                                                      DynamicMenuCallback_pf              LoaderSelectionCallback,
                                                      DataSetLoaderInstructionOverride_pf InstructionOverride);


LINKTOADDON Boolean_t STDCALL TecUtilImportSetLoaderInstr(const char    *DataSetLoaderName,
                                                          StringList_pa Instructions);


                                                                     
LINKTOADDON void STDCALL TecUtilImportWriteLoaderInstr(const char   *DataSetLoaderName,
                                                        StringList_pa Instructions);
/*
 * Register version information for an addon with tecplot.  This MUST only be called from the
 * addon initialization function.
 */
LINKTOADDON void STDCALL TecUtilAddOnRegisterInfo(const char *OfficialName,
                                                         const char *Version,
                                                         const char *Author);
LINKTOADDON Boolean_t STDCALL TecUtilAddOnGetRegisteredInfo(const char *OfficialName,
                                                    char **Version,
                                                    char **Author);


/* 
 *  Extended Curve Fit Registration
 */

LINKTOADDON Boolean_t STDCALL TecUtilCurveRegisterExtCrvFit(const char   *CurveFitName,
                                  GetXYDataPointsCallback_pf              GetXYDataPointsCallback,
                                  GetProbeValueCallback_pf                GetProbeValueCallback,
                                  GetCurveInfoStringCallback_pf           GetCurveInfoStringCallback,
                                  GetCurveSettingsCallback_pf             GetCurveSettingsCallback,                                  
                                  GetAbbreviatedSettingsStringCallback_pf GetAbbreviatedSettingsStringCallback);


/*
 * Use tecplot's error message capability.  This has the following
 * features:
 *
 *     1.  Automatic word wrapping.
 *     2.  Goes to batch.log file if in batch mode.
 *     3.  Goes to stderr if graphics are not initialized.
 */
LINKTOADDON void STDCALL TecUtilDialogErrMsg(const char *Message);

/*
 * NOTE: Offset starts at 1.
 */
LINKTOADDON void STDCALL TecUtilDataValueSetByRef(FieldData_pa FD,
                                              LgIndex_t    PointIndex,
                                              double       Value);

LINKTOADDON void STDCALL TecUtilDataNodeSetByZone(EntIndex_t Zone,
                                                       LgIndex_t  Element,
                                                       LgIndex_t  Corner,
                                                       LgIndex_t  Node);

LINKTOADDON void STDCALL TecUtilDataNodeSetByRef(NodeMap_pa  NM,
                                             LgIndex_t   Element,
                                             LgIndex_t   Corner,
                                             LgIndex_t   Node);

LINKTOADDON void STDCALL TecUtilLockOn(void);

LINKTOADDON void STDCALL TecUtilLockOff(void);

LINKTOADDON void STDCALL TecUtilDialogLaunchPercentDone(const char     *Label,
                                                         Boolean_t ShowTheScale);
LINKTOADDON void STDCALL TecUtilDialogSetPercentDoneText(const char *Text);

LINKTOADDON Boolean_t STDCALL TecUtilDialogCheckPercentDone(int PercentDone);

LINKTOADDON void STDCALL TecUtilDialogDropPercentDone(void);

LINKTOADDON Boolean_t STDCALL TecUtilMacroExecuteCommand(const char *Command);

LINKTOADDON void STDCALL TecUtilInterrupt(void);


LINKTOADDON void STDCALL TecUtilGeomDelete(Geom_ID GID);
LINKTOADDON void STDCALL TecUtilTextDelete(Text_ID TID);

LINKTOADDON Boolean_t STDCALL TecUtilPickGeom(Geom_ID GID);
LINKTOADDON Boolean_t STDCALL TecUtilPickText(Text_ID TID);

LINKTOADDON Boolean_t  STDCALL TecUtilGeomIsValid(Geom_ID GID);
LINKTOADDON Boolean_t  STDCALL TecUtilTextIsValid(Text_ID TID);
LINKTOADDON char *     STDCALL TecUtilStringAlloc(int   MaxLength, /* <-activex> */
                                                  const char *DebugInfo);
LINKTOADDON void       STDCALL TecUtilStringDealloc(char **S); /* <-activex> */


/* STRING LIST FUNCTIONS */