Tecplot: TECUTILO.h Source File

00001 #ifndef _TECUTILO_H
00002 /*
00003 ******************************************************************
00004 ******************************************************************
00005 *******                                                   ********
00006 ******             (C) 1988-2008 Tecplot, Inc.             *******
00007 *******                                                   ********
00008 ******************************************************************
00009 ******************************************************************
00010 */
00011 
00012 /* CORE SOURCE CODE REMOVED */
00013 
00017 #if defined EXTERN
00018 #undef EXTERN
00019 #endif
00020 #if defined TECUTILOMODULE
00021 #define EXTERN
00022 #else
00023 #define EXTERN extern
00024 #endif
00025 
00026 /*{{<windows_only> TecUtilInterfaceWinAddPreMsgFn PreTranslateMessage_pf </windows_only> }}*/
00027 
00028 #if defined MSWIN  || defined DOCUMENT_BUT_DONT_COMPILE
00029 /* Add new Windows-only functions here */
00072 Boolean_t TecUtilInterfaceWinAddPreMsgFn(PreTranslateMessage_pf PreTranslateMessageProc);
00073 #endif
00074 
00075 /* The engine functions are excluded from all derived libraries (libtec and fglue) */
00076 
00077 /*{{<exclude_all>
00078     TecGUIMFCSidebarRegister
00079     TecEngPageCreateNew
00080     TecEngPageCreateRegisterCallback
00081     TecEngPageDestroyRegisterCallback
00082     TecEngPageNewCurrentRegisterCallback
00083     TecEngPolarCacheGetInnerGridRadiusAndDelta
00084     TecEngInit
00085     TecEngGetHelpAbout
00086     TecEngRenderDestRegisterCallback RenderDestCallback_pf
00087     TecEngRenderQueryRegisterCallback RenderQueryCallback_pf
00088     TecEngRenderDestSizeRegisterCallback RenderDestSizeCallback_pf
00089     TecEngSwapBuffersRegisterCallback SwapBuffersCallback_pf
00090     TecEngKeyStateRegisterCallback KeyStateCallback_pf
00091     TecEngMouseButtonStateRegisterCallback MouseButtonStateCallback_pf
00092     TecEngWaitCursorStateRegisterCallback WaitCursorStateCallback_pf
00093     TecEngCursorStyleRegisterCallback BaseCursorStyleCallback_pf
00094     TecEngProcessBusyEventsRegisterCallback ProcessBusyEventsCallback_pf
00095     TecEngDotPitchRegisterCallback DotPitchCallback_pf
00096     TecEngScreenSizeRegisterCallback ScreenSizeCallback_pf
00097     TecEngDialogMessageBoxRegisterCallback DialogMessageBoxCallback_pf
00098     TecEngStartup
00099     TecEngCleanupOnAbnormalShutdown
00100     TecEngInitiateShutdown
00101     TecEngFinalizeShutdown
00102     TecEngProcessTasksOnIdle
00103     TecEngPageDamaged
00104     TecUtilParentLockStart
00105     TecUtilParentLockFinish  
00106     TecEngOffscreenImageCreateRegisterCallback TecEngOffscreenImageCreate_pf
00107     TecEngOffscreenImageDestroyRegisterCallback TecEngOffscreenImageDestroy_pf
00108     TecEngOffscreenImageGetRGBRowRegisterCallback TecEngOffscreenImageGetRGBRow_pf
00109     TecEngWinPrintImageRegisterCallback WinPrintImageCallback_pf
00110     TecEngWinPrinterGetContextRegisterCallback WinPrinterGetContextCallback_pf
00111     TecEngStatusLineRegisterCallback TecEngStatusLineCallback_pf
00112     TecEngPercentDoneRegisterCallback TecEngPercentDoneCallback_pf
00113 
00114 
00115     TecGUICreateDialogBar
00116     TecGUIGetTPMainWnd
00117 
00118  </exclude_all> }}*/
00119 
00120 /*{{<exclude_python> 
00121                     TecUtilAddOnRegisterInfo 
00122                     TecUtilDataSetAddPostConvInstr
00123                     TecUtilDataSetDefVarLoadFinish 
00124                     TecUtilDataValueCanMemMapData
00125                     TecUtilDataValueMemMapData
00126                     TecUtilDispatchWorkAreaEvent
00127                     TecUtilGeomGetXYZAnchorPos
00128                     TecUtilGeomSetXYZAnchorPos
00129                     TecUtilMenuSetSensitivity
00130                     TecUtilProbeXYGetDepValue
00131                     TecUtilProbeXYGetIndValue
00132                     TecUtilProbeXYGetSourceMap
00133                     TecUtilSidebarAutoSensitivity 
00134                     TecUtilSidebarSetSensitivity
00135                     TecUtiltDataSetDefVarLoadFinish
00136                     TecUtilTextGetXYPos
00137                     TecUtilTextSetXYPos
00138                     TecUtilThreadCreateDetached ThreadFunction_pf
00139                     TecUtilThreadMutexAlloc
00140                     TecUtilThreadMutexDealloc
00141                     TecUtilThreadMutexLock
00142                     TecUtilThreadMutexUnlock
00143                     TecUtilThreadConditionAlloc
00144                     TecUtilThreadConditionDealloc
00145                     TecUtilThreadSignalCondition
00146                     TecUtilThreadBroadcastCondition
00147                     TecUtilThreadWaitForCondition
00148                     TecUtilThreadTimedWaitForCondition
00149                     TecUtilThreadPoolJobControlAlloc
00150                     TecUtilThreadPoolJobControlDealloc
00151                     TecUtilThreadPoolAddJob ThreadPoolJob_pf
00152                     TecUtilThreadPoolWait
00153                     TecUtilThreadPoolGetNumConcurrentJobs
00154 </exclude_python>}}*/
00155 
00156 /*{{<exclude_fglue> 
00157                     TecUtilDataFEPolyGetCellNodesSizeAndCenter
00158                     TecUtilTimerAddCallback AddOnTimerCallback_pf 
00159                     TecUtilDataSetAddVar
00160                     TecUtilStringAlloc 
00161                     TecUtilStringDealloc 
00162                     TecUtilStringListGetRawStringPtr
00163                     TecUtilDataSetAddZone
00164                     TecUtilStateChangeAddCallback 
00165                     TecUtilStateChangeSetMode 
00166                     StateChangeAddOnCallback_pf
00167                     StateChangeAddOnCallbackV2_pf
00168                     TecUtilAuxDataGetItemByIndex
00169                     TecUtilAuxDataGetItemByName
00170                     TecUtilAuxDataSetItem
00171                     TecUtilCheckActiveAllocs
00172                     TecUtilStateChangeGetName
00173                     TecUtilThreadCreateDetached ThreadFunction_pf
00174                     TecUtilThreadMutexAlloc
00175                     TecUtilThreadMutexDealloc
00176                     TecUtilThreadMutexLock
00177                     TecUtilThreadMutexUnlock
00178                     TecUtilThreadConditionAlloc
00179                     TecUtilThreadConditionDealloc
00180                     TecUtilThreadSignalCondition
00181                     TecUtilThreadBroadcastCondition
00182                     TecUtilThreadWaitForCondition
00183                     TecUtilThreadTimedWaitForCondition
00184                     TecUtilThreadPoolJobControlAlloc
00185                     TecUtilThreadPoolJobControlDealloc
00186                     TecUtilThreadPoolAddJob ThreadPoolJob_pf
00187                     TecUtilThreadPoolWait
00188                     TecUtilThreadPoolGetNumConcurrentJobs
00189   </exclude_fglue> }}*/
00190 
00191 /*{{<exclude_tcl> 
00192                     TecUtilStringAlloc 
00193                     TecUtilStringDealloc 
00194                     TecUtilInterfaceWinAddPreMsgFn
00195                     TecUtilTimerAddCallback
00196                     TecUtilOnIdleQueueAddCallback
00197                     TecUtilProbeInstallCallback
00198                     TecUtilExtractInstallCallback
00199                     TecUtilQuitAddQueryCallback
00200                     TecUtilEventAddPreDrawCallback
00201                     TecUtilEventAddPostDrawCallback
00202                     TecUtilStateChangeSetMode
00203                     TecUtilStateChangeAddCallback
00204                     TecUtilMacroAddCommandCallback
00205                     TecUtilConvAddPostReadCallback
00206                     TecUtilMenuAddOption
00207                     TecUtilMenuInsertOption
00208                     TecUtilMenuInsertToggle
00209                     TecUtilMenuRegisterSensitivityCallback
00210                     TecUtilMenuAddToolTip
00211                     TecUtilImportAddConverter
00212                     TecUtilImportAddLoader
00213                     TecUtilAddOnRegForeignLibLoader
00214                     TecUtilDynamicLabelRegisterCallback
00215                     TecUtilCurveRegisterExtCrvFit
00216                     TecUtilDataValueCustomLOD
00217                     TecUtilStringListSort
00218                     TecUtilReadBinaryData
00219                     TecUtilTecForeign
00220                     TecUtilTecIni
00221                     TecUtilTecZne
00222                     TecUtilTecZneX
00223                     TecUtilTecDat
00224                     TecUtilTecNod
00225                     TecUtilTecEnd
00226                     TecUtilTecLab
00227                     TecUtilTecUsr
00228                     TecUtilTecFil
00229                     TecUtilTecTxt
00230                     TecUtilTecTxtX
00231                     TecUtilTecGeo
00232                     TecUtilTecGeoX
00233                     TecUtilTecAux
00234                     TecUtilTecZAux
00235                     TecUtilTecVAux
00236                     TecUtilTecFace
00237                     TecUtilTecPoly
00238                     TecUtilTecPolyX
00239                     TecUtilGeomImageGetImage
00240                     TecUtilThreadCreateDetached ThreadFunction_pf
00241                     TecUtilThreadMutexAlloc
00242                     TecUtilThreadMutexDealloc
00243                     TecUtilThreadMutexLock
00244                     TecUtilThreadMutexUnlock
00245                     TecUtilThreadConditionAlloc
00246                     TecUtilThreadConditionDealloc
00247                     TecUtilThreadSignalCondition
00248                     TecUtilThreadBroadcastCondition
00249                     TecUtilThreadWaitForCondition
00250                     TecUtilThreadTimedWaitForCondition
00251                     TecUtilThreadPoolJobControlAlloc
00252                     TecUtilThreadPoolJobControlDealloc
00253                     TecUtilThreadPoolAddJob ThreadPoolJob_pf
00254                     TecUtilThreadPoolWait
00255                     TecUtilThreadPoolGetNumConcurrentJobs
00256   </exclude_tcl> }}*/
00257 
00340 Boolean_t   TecUtilTimerAddCallback(UInt32_t               Interval,
00341                                                         ArbParam_t             ClientData,
00342                                                         AddOnTimerCallback_pf  TimerCallback);
00343 
00435 Boolean_t TecUtilOnIdleQueueAddCallback(OnIdleCallback_pf Callback,
00436                                                             ArbParam_t        ClientData);
00437 
00503 Boolean_t TecUtilDialogGetFolderName(const char  *Title,
00504                                                          char       **FolderName); /*OUT*/
00505 
00632 Boolean_t TecUtilDialogGetFolderNameX(ArgList_pa ArgList);
00633 
00724 Boolean_t TecUtilDialogGetFileName(SelectFileOption_e   DialogOption,
00725                                                        char               **FileName,        /*OUT*/
00726                                                        const char          *FileTypeName,
00727                                                        const char          *DefaultFileName,
00728                                                        const char          *DefaultFilter);
00836 Boolean_t TecUtilDialogGetFileNames(SelectFileOption_e   DialogOption,
00837                                                         StringList_pa       *FileNames,        /*OUT*/
00838                                                         const char          *FileTypeName,
00839                                                         StringList_pa        DefaultFileNames,
00840                                                         const char          *DefaultFilter);
01054 Boolean_t TecUtilDialogGetFileNamesX(ArgList_pa ArgList);
01055 
01110 Boolean_t TecUtilFileDownloadURL(const char  *SourceURL,
01111                                                      const char  *LocalDestinationFile,
01112                                                      Boolean_t    IsAscii,
01113                                                      Boolean_t    ConfirmOverwrite);
01167 Boolean_t TecUtilFileUploadURL(const char *LocalSourceFile,
01168                                                    const char *DestinationURL,
01169                                                    Boolean_t   IsAscii,
01170                                                    Boolean_t   ConfirmOverwrite);
01205 Boolean_t TecUtilFileIsURL(const char *URLFName);
01206 
01236 void TecUtilArrayDealloc(void **Array); /*INOUT*/
01237 
01265 MouseButtonMode_e TecUtilMouseGetCurrentMode(void);
01266 
01301 Boolean_t TecUtilMouseIsValidMode(MouseButtonMode_e MouseMode);
01302 
01338 Boolean_t TecUtilMouseSetMode(MouseButtonMode_e MouseMode);
01339 
01340 
01341 
01342 
01363 void TecUtilSidebarAutoSensitivity(Boolean_t DoAuto);
01364 
01365 
01366 
01388 void TecUtilSidebarSetSensitivity(MouseButtonMode_e MouseMode,
01389                                                       Boolean_t         IsSensitive);
01390 
01391 
01392 
01393 
01569 void TecUtilProbeAtFieldPositionX(ArgList_pa ArgList);
01570   
01571 
01694 void TecUtilProbeAtFieldIndexX(ArgList_pa ArgList);
01695 
01790 void TecUtilProbeAtLinePositionX(ArgList_pa ArgList);
01791 
01914 void TecUtilProbeAtLineIndexX(ArgList_pa ArgList);
01915 
01916 
02051 Boolean_t TecUtilProbeInstallCallback(ProbeDestination_pf ProbeDestination,
02052                                                           const char         *InformationLineText);
02053 
02166 Boolean_t TecUtilProbeInstallCallbackX(ArgList_pa ArgList);
02167 
02196 void TecUtilProbeAllowCOBs(void);
02197 
02198 
02199 
02218 double TecUtilProbeXYGetIndValue(void);
02219 
02220 
02221 
02250 double TecUtilProbeLinePlotGetIndValue(void);
02251 
02252 
02274 Boolean_t TecUtilProbeXYGetDepValue(EntIndex_t MapNum,
02275                                                         double    *DepValue); /*OUT*/
02321 Boolean_t TecUtilProbeLinePlotGetDepValue(EntIndex_t MapNum,
02322                                                               double    *DepValue); /*OUT*/
02323 
02324 
02325 
02344 EntIndex_t TecUtilProbeXYGetSourceMap(void);
02345 
02346 
02347 
02382 EntIndex_t TecUtilProbeLinePlotGetSourceMap(void);
02383 
02418 char TecUtilProbeLinePlotGetIndAxisKind(void);
02419 
02455 int TecUtilProbeLinePlotGetIndAxisNumber(void);
02456 
02487 LgIndex_t TecUtilProbeGetPointIndex(void);
02518 CZType_e TecUtilProbeFieldGetCZType(void);
02553 double TecUtilProbeFieldGetValue(EntIndex_t VarNum);
02582 EntIndex_t TecUtilProbeFieldGetZone(void);
02612 IJKPlanes_e TecUtilProbeFieldGetPlane(void);
02613 
02649 SmInteger_t TecUtilProbeFieldGetFaceNumber(void);
02650 
02690 LgIndex_t  TecUtilProbeFieldGetFaceCell(void);
02691 
02731 LgIndex_t  TecUtilProbeFieldGetCell(void);
02732 
02773 Boolean_t TecUtilProbeFieldGetName(char **Name);
02774 
02815 FieldData_pa TecUtilProbeFieldGetReadableNativeRef(EntIndex_t Var);
02816 
02857 FieldData_pa TecUtilProbeFieldGetReadableDerivedRef(EntIndex_t Var);
02858 
02899 FieldData_pa TecUtilProbeFieldGetReadableNLRef(EntIndex_t Var);
02900 
02941 FieldData_pa TecUtilProbeFieldGetReadableCCRef(EntIndex_t Var);
02942 
02999 Boolean_t TecUtilExtractInstallCallback(ExtractDestination_pf ExtractDestination,
03000                                                             const char           *InformationLineText);
03001 
03002 
03003 
03004 
03072 Boolean_t TecUtilDataSetCreate(const char    *DataSetTitle,
03073                                                    StringList_pa VarNames,
03074                                                    Boolean_t     ResetStyle);
03075 
03076 
03077 
03116 VarLoadMode_e TecUtilDataSetGetVarLoadMode(void);
03117 
03162 void TecUtilZoneSetBuildZoneOptInfo(EntIndex_t Zone,
03163                                                         Boolean_t  BuildZoneOptInfo);
03164 
03185 Boolean_t TecUtilDataSetDefVarLoadFinish(Boolean_t IsDataSetOk);
03186 
03208 Boolean_t TecUtiltDataSetDefVarLoadFinish(Boolean_t IsDataSetOk);
03209 
03210 
03321 Boolean_t TecUtilDataSetAddZone(const char      *Name,
03322                                                     LgIndex_t        IMax,
03323                                                     LgIndex_t        JMax,
03324                                                     LgIndex_t        KMax,
03325                                                     ZoneType_e       ZoneType,
03326                                                     FieldDataType_e *VarDataType_Array);
03327 
03328 
03329 
03330 
03879 Boolean_t TecUtilDataSetAddZoneX(ArgList_pa ArgList);
03880 
03881 
03882 
03883 
03884 
03885 
03886 
04104 Boolean_t TecUtilDataSetAddVarX(ArgList_pa ArgList);
04105 
04106 
04184 Boolean_t TecUtilZoneRealloc(EntIndex_t Zone,
04185                                                  LgIndex_t  NewIMaxOrNumDataPoints,
04186                                                  LgIndex_t  NewJMaxOrNumElements,
04187                                                  LgIndex_t  NewKMax);
04188 
04189 
04258 Boolean_t TecUtilDataSetAddVar(const char      *VarName,
04259                                                    FieldDataType_e *FieldDataType_Array);
04260  
04261 
04300 Boolean_t TecUtilQuitAddQueryCallback(MopupQueryAddOnCallback_pf QuitQueryCallback);
04301 
04343 Boolean_t TecUtilEventAddPreDrawCallback(DrawEventCallback_pf DrawEventCallback,
04344                                                              ArbParam_t           ClientData);
04345 
04387 Boolean_t TecUtilEventAddPostDrawCallback(DrawEventCallback_pf DrawEventCallback,
04388                                                               ArbParam_t           ClientData);
04389 
04437 Boolean_t TecUtilStateChangeSetMode(StateChangeAddOnCallback_pf Callback,
04438                                                         StateChangeMode_e           Mode);
04439 
04556 Boolean_t TecUtilStateChangeAddCallback(StateChangeAddOnCallback_pf StateChangeCallback);
04557 
04558 
04559 
04560 
04561 
04562 
04641 void TecUtilStateChanged(StateChange_e StateChange,
04642                                              ArbParam_t    CallData);
04643 
04728 Boolean_t TecUtilStateChangeRemoveCBX(ArgList_pa ArgList);
04729 
04759 Boolean_t TecUtilStateChangeRemoveCallback(void *AddOnStateChangeCallback);
04760 
04999 Boolean_t TecUtilStateChangeAddCallbackX(ArgList_pa ArgList);
05000 
05001 
05044 Boolean_t TecUtilStateChangeGetIndex(LgIndex_t *Index); /*OUT*/
05045 
05046 
05047 
05087 Boolean_t TecUtilStateChangeGetPageUniqueID(UniqueID_t *UniqueID); /*OUT*/
05088 
05128 Boolean_t TecUtilStateChangeGetFrameUniqueID(UniqueID_t *UniqueID); /*OUT*/
05129 
05169 Boolean_t TecUtilStateChangeGetDataSetUniqueID(UniqueID_t *UniqueID); /*OUT*/
05170 
05210 Boolean_t TecUtilStateChangeGetUniqueID(UniqueID_t *UniqueID); /*OUT*/
05211 
05212 
05213 
05255 Boolean_t TecUtilStateChangeGetArbEnum(LgIndex_t *ArbEnum); /*OUT*/
05256 
05314 Boolean_t TecUtilStateChangeGetZoneSet(Set_pa *ZoneSetRef); /*OUTREF*/
05315 
05362 Boolean_t TecUtilStateChangeGetVarSet(Set_pa *VarSetRef); /*OUTREF*/
05363 
05422 Boolean_t TecUtilStateChangeGetName(char **NameRef); /*OUTREF*/
05423 
05455 Boolean_t TecUtilStateChangeGetMap(EntIndex_t *Map); /*OUT*/
05456 
05501 Boolean_t TecUtilStateChangeGetZone(EntIndex_t *Zone); /*OUT*/
05502 
05534 Boolean_t TecUtilStateChangeGetVar(EntIndex_t *Var); /*OUT*/
05535 
05576 Boolean_t TecUtilStateChangeGetStyleParam(int          Param,
05577                                                               const char **StyleParam); /*OUTREF*/
05578 
05579 
05829 void TecUtilStateChangeGetInfoX(ArgList_pa ArgList);
05830 
05831 
06020 void TecUtilStateChangedX(ArgList_pa ArgList);
06021 
06107 Boolean_t TecUtilMacroAddCommandCallback(const char                *CommandProcessorIDString,
06108                                                              MacroCommandExtCallback_pf MacroCommandCallback);
06109 
06110 
06157 Boolean_t TecUtilMacroRecordExtCommand(const char *CommandProcessorIDString,
06158                                                            const char *Command);
06159 
06181 Boolean_t TecUtilMacroRecordAddOnCommand(const char *AddOnIDString,
06182                                                              const char *Command);
06183 
06184 
06255 Boolean_t TecUtilMacroRecordExtComRaw(const char *CommandProcessorIDString,
06256                                                           const char *Command,
06257                                                           const char *RawData);
06258 
06281 Boolean_t TecUtilMacroRecordAddOnComRaw(const char *AddOnIDString,
06282                                                             const char *Command,
06283                                                             const char *RawData);
06284 
06329 Boolean_t TecUtilMacroRecordRawCommand(const char *Command);
06330 
06331 
06389 Boolean_t TecUtilDataSetAddJournalCommand(const char *CommandProcessorIDString,
06390                                                               const char *Instructions,
06391                                                               const char *RawData);
06392 
06427 Boolean_t TecUtilDataSetAddRawJournalCom(const char *Command);
06428 
06429 
06452 Boolean_t TecUtilDataSetAddPostConvInstr(const char *AddOnIDString,
06453                                                              const char *Instructions,
06454                                                              const char *RawData);
06455 
06456 
06457 
06458 
06459 
06460 
06461 
06462 
06463 
06464 
06501 void TecUtilDataSetSuspendMarking(Boolean_t DoSuspend);
06502 
06503 
06560 void TecUtilDispatchWorkAreaEvent(int       I,
06561                                                       int       J,
06562                                                       int       ButtonOrKey,
06563                                                       Event_e   Event,
06564                                                       Boolean_t IsShifted,
06565                                                       Boolean_t IsAlted,
06566                                                       Boolean_t IsControlled);
06567 
06599 void TecUtilToolbarActivate(Boolean_t Activate);
06600 
06705 Boolean_t TecUtilMenuAddOption(const char            *MenuPath,
06706                                                    const char            *MenuLabel,
06707                                                    char                   Mnemonic,
06708                                                    DynamicMenuCallback_pf MenuOptionCallback);
06709 
06739 Boolean_t TecUtilMenuAddSeparator(const char *MenuPath);
06740 
06785 void TecUtilMenuAddStatusLineHelp(Menu_pa     MenuItem,
06786                                                       const char *StatusLineHelp);
06787 
06788 
06805 Boolean_t TecUtilMenuSetSensitivity(const char *MenuPath,
06806                                                         const char *MenuLabel,
06807                                                         Boolean_t   IsSensitive);
06808 
06838 Menu_pa TecUtilMenuGetMain(void);
06839 
06881 Menu_pa TecUtilMenuGetStandard(StandardMenu_e StandardMenu);
06882 
06949 Menu_pa TecUtilMenuInsertSubMenu(Menu_pa     ParentMenu,
06950                                                      int         InsertPos,
06951                                                      const char *SubMenuLabel);
06952                                                      
07090 Menu_pa TecUtilMenuInsertOption(Menu_pa                 ParentMenu,
07091                                                     int                     InsertPos,
07092                                                     const char             *OptionLabel,
07093                                                     MenuActivateCallback_pf ActivateCallback,
07094                                                     ArbParam_t              ActivateClientData);
07095 
07239 Menu_pa TecUtilMenuInsertToggle(Menu_pa                       ParentMenu,
07240                                                     int                           InsertPos,
07241                                                     const char                   *ToggleLabel,
07242                                                     MenuActivateCallback_pf       ActivateCallback,
07243                                                     ArbParam_t                    ActivateClientData,
07244                                                     MenuGetToggleStateCallback_pf GetToggleStateCallback,
07245                                                     ArbParam_t                    GetToggleStateClientData);
07246 
07318 Menu_pa TecUtilMenuInsertSeparator(Menu_pa ParentMenu,
07319                                                        int     InsertPos);
07320 
07375 void TecUtilMenuInsertStandard(Menu_pa        ParentMenu,
07376                                                    int            InsertPos,
07377                                                    StandardMenu_e StandardMenu);
07378 
07458 void TecUtilMenuRegisterSensitivityCallback(Menu_pa                       MenuItem,
07459                                                                 MenuGetSensitivityCallback_pf GetSensitivityCallback,
07460                                                                 ArbParam_t                    GetSensitivityClientData);
07461 
07519 void TecUtilMenuDelete(Menu_pa *MenuItemPtr); /*INOUT*/
07520 
07563 void TecUtilMenuClearAll(void);
07564 
07565 
07566 
07567 /****************************************************************************
07568  *          DataSet Converters and Loaders.                                 *
07569  *                                                                          *
07570  * A Converter is an add-on that connects to tecplot in a way such that      *
07571  * tecplot uses its own file/io dialogs to read the non-Tecplot data into   *
07572  * tecplot and the converter is a simple function that only knows how       *
07573  * to convert from its own data format into tecplot's binary format.        *
07574  *                                                                          *
07575  * Converters are registered with tecplot by calling:                       *
07576  *                                                                          *
07577  *              TecUtilImportAddConverter()                                 *
07578  *                                                                          *
07579  * An loader works like this:                                               *
07580  *     - TecUtilMenuAddOption() is called to register a callback            *
07581  *       (most often used to bring up a dialog) to the loader add-on        *
07582  *                                                                          *
07583  *     - The loader registers itself with tecplot by calling                *
07584  *       TecUtilImportAddLoader()                                           *
07585  *                                                                          *
07586  *     When a request is made to use the loader function:                   *
07587  *                                                                          *
07588  *        - The loader creates a new dataset and loads the data into        *
07589  *          tecplot by hand.                                                *
07590  *                                                                          *
07591  *        - The loader then calls TecUtilImportSetLoaderInstr()             *
07592  *          to assign the specific instructions needed to load the data     *
07593  *          into the current dataset. These instructions will be included   *
07594  *          in any layout files written out.                                *
07595  ****************************************************************************/
07669 Boolean_t TecUtilImportAddConverter(DataSetConverter_pf  ConverterCallback,
07670                                                         const char          *ConverterName,
07671                                                         const char          *FNameExtension);
07672 
07673 
07786 Boolean_t TecUtilImportAddLoader(DataSetLoader_pf                    LoaderCallback,
07787                                                      const char                         *DataSetLoaderName,
07788                                                      DynamicMenuCallback_pf              LoaderSelectedCallback,
07789                                                      DataSetLoaderInstructionOverride_pf InstructionOverrideCallback);
07790 
07791 
07835 Boolean_t TecUtilImportSetLoaderInstr(const char    *DataSetLoaderName,
07836                                                           StringList_pa  Instructions);
07837 
07838 
07839                                                                      
07898 void TecUtilImportWriteLoaderInstr(const char   *DataSetLoaderName,
07899                                                        StringList_pa Instructions);
07915 void TecUtilAddOnRegisterInfo(const char *OfficialName,
07916                                                   const char *Version,
07917                                                   const char *Author);
07918 
07919 
07989 AddOn_pa TecUtilAddOnRegister(int         TecplotBaseVersionNumber,
07990                                                   const char *OfficialName,
07991                                                   const char *Version,
07992                                                   const char *Author);
08062 Boolean_t TecUtilAddOnGetRegisteredInfo(const char  *OfficialName,
08063                                                             char       **Version, /*OUT*/
08064                                                             char       **Author); /*OUT*/
08065 
08066 
08067 
08068 
08109 void TecUtilDynamicLabelRegisterCallback(const char              *DynamicLabelName,
08110                                                              DynamicLabelCallback_pf  DynamicLabelCallback,
08111                                                              ArbParam_t               ClientData);
08112 
08113 
08186 Boolean_t TecUtilCurveRegisterExtCrvFit(const char                             *CurveFitName,
08187                                                             GetLinePlotDataPointsCallback_pf        GetLinePlotDataPointsCallback,
08188                                                             GetProbeValueCallback_pf                GetProbeValueCallback,
08189                                                             GetCurveInfoStringCallback_pf           GetCurveInfoStringCallback,
08190                                                             GetCurveSettingsCallback_pf             GetCurveSettingsCallback,                                  
08191                                                             GetAbbreviatedSettingsStringCallback_pf GetAbbreviatedSettingsStringCallback);
08192 
08193 
08230 void TecUtilDialogErrMsg(const char *Message);
08231 
08259 void TecUtilDataLoadBegin(void);
08260 
08293 void TecUtilDataLoadEnd(void);
08294 
08352 void TecUtilDataValueShare(EntIndex_t SourceZone,
08353                                                EntIndex_t DestZone,
08354                                                EntIndex_t Var);
08408 void TecUtilDataValueCopy(EntIndex_t SourceZone,
08409                                               EntIndex_t DestZone,
08410                                               EntIndex_t Var);
08411 
08467 Boolean_t TecUtilDataValueAlloc(EntIndex_t Zone,
08468                                                     EntIndex_t Var);
08469 
08493 Boolean_t TecUtilDataValueCanMemMapData(EntIndex_t     Zone,
08494                                                             EntIndex_t     Var,
08495                                                             MemMapOffset_t Offset,
08496                                                             Boolean_t      IsDataNativeByteOrder);
08521 Boolean_t TecUtilDataValueMemMapData(EntIndex_t     Zone,
08522                                                          EntIndex_t     Var,
08523                                                          int            FileDescriptor,
08524                                                          MemMapOffset_t Offset,
08525                                                          Boolean_t      IsDataNativeByteOrder);
08526 
08589 Boolean_t TecUtilDataValueAutoLOD(EntIndex_t            Zone,
08590                                                       EntIndex_t            Var,
08591                                                       DataValueStructure_e  DataValueStructure,
08592                                                       const char           *FileName,
08593                                                       FileOffset_t          Offset,
08594                                                       Int64_t               Stride,
08595                                                       Boolean_t             IsDataNativeByteOrder);
08596 
08639 ArbParam_t TecUtilDataValueGetClientData(FieldData_pa FieldData);
08640 
08886 Boolean_t TecUtilDataValueCustomLOD(EntIndex_t                Zone,
08887                                                         EntIndex_t                Var,
08888                                                         LoadOnDemandVarLoad_pf    VariableLoad,
08889                                                         LoadOnDemandVarUnload_pf  VariableUnload,
08890                                                         LoadOnDemandVarCleanup_pf VariableCleanup,
08891                                                         FieldValueGetFunction_pf  GetValueFunction,
08892                                                         FieldValueSetFunction_pf  SetValueFunction,
08893                                                         ArbParam_t                ClientData);
08894 
08935 Boolean_t TecUtilDataValueUnload(EntIndex_t Zone,
08936                                                      EntIndex_t Var);
08937 
08985 Boolean_t TecUtilDataValueBranchShared(EntIndex_t Zone,
08986                                                            EntIndex_t Var);
08987 
08988 
08989 
08990 
09037 void TecUtilDataConnectShare(EntIndex_t SourceZone,
09038                                                  EntIndex_t DestZone);
09039 
09040 
09041 
09042 
09043 
09044 
09078 Boolean_t TecUtilDataConnectBranchShared(EntIndex_t Zone);
09079 
09080 
09081 
09082 
09116 void TecUtilDataValueArraySetByRef(FieldData_pa  DestFieldData,
09117                                                        LgIndex_t     DestOffset,
09118                                                        LgIndex_t     DestCount,
09119                                                        void         *SourceValueArray);
09200 void TecUtilDataValueSetByRef(FieldData_pa FD,
09201                                                   LgIndex_t    PointIndex,
09202                                                   double       Value);
09203 
09296 void TecUtilDataValueSetMinMaxByRef(FieldData_pa FieldData,
09297                                                         double       MinValue,
09298                                                         double       MaxValue);
09391 void TecUtilDataValueSetMinMaxByZoneVar(EntIndex_t   Zone,
09392                                                             EntIndex_t   Var,
09393                                                             double       MinValue,
09394                                                             double       MaxValue);
09395 
09457 void TecUtilDataNodeSetByZone(EntIndex_t Zone,
09458                                                   LgIndex_t  Element,
09459                                                   LgIndex_t  Corner,
09460                                                   NodeMap_t  Node);
09461 
09503 void TecUtilDataNodeArraySetByRef(NodeMap_pa  DestNodeMap,
09504                                                       LgIndex_t   DestOffset,
09505                                                       LgIndex_t   DestCount,
09506                                                       NodeMap_t  *SourceNodeArray);
09507 
09585 void TecUtilDataNodeSetByRef(NodeMap_pa NM,
09586                                                  LgIndex_t  Element,
09587                                                  LgIndex_t  Corner,
09588                                                  NodeMap_t  Node);
09589 
09630 ArbParam_t TecUtilDataNodeGetClientData(NodeMap_pa NodeMap);
09631 
09683 Boolean_t TecUtilDataNodeAutoLOD(EntIndex_t   Zone,
09684                                                      const char*  FileName,
09685                                                      FileOffset_t Offset,
09686                                                      Boolean_t    IsDataNativeByteOrder);
09862 Boolean_t TecUtilDataNodeCustomLOD(EntIndex_t                    Zone,
09863                                                        LoadOnDemandNodeMapLoad_pf    LoadCallback,
09864                                                        LoadOnDemandNodeMapUnload_pf  UnloadCallback,
09865                                                        LoadOnDemandNodeMapCleanup_pf CleanupCallback,
09866                                                        ArbParam_t                    ClientData);
09913 Boolean_t TecUtilDataNodeAlloc(EntIndex_t Zone);
09914 
09944 void TecUtilLockOn(void);
09945 
09975 void TecUtilLockOff(void);
09976 
10005 void   TecUtilLockStart(AddOn_pa AddOn);
10006 
10035 void   TecUtilLockFinish(AddOn_pa AddOn);
10078 char * TecUtilLockGetCurrentOwnerName(void);
10079 
10128 void TecUtilStatusStartPercentDone(const char *PercentDoneText,
10129                                                        Boolean_t   ShowStopButton,
10130                                                        Boolean_t   ShowProgressBar);
10131 
10165 void TecUtilStatusSetPercentDoneText(const char *PercentDoneText);
10166 
10209 Boolean_t TecUtilStatusCheckPercentDone(int PercentDone);
10210 
10240 void TecUtilStatusFinishPercentDone(void);
10241 
10279 void TecUtilDialogLaunchPercentDone(const char *Label,
10280                                                         Boolean_t   ShowTheScale);
10317 void TecUtilDialogSetPercentDoneText(const char *Text);
10318 
10378 Boolean_t TecUtilDialogCheckPercentDone(int PercentDone);
10379 
10404 void      TecUtilDialogDropPercentDone(void);
10405 
10451 Boolean_t TecUtilMacroExecuteCommand(const char *Command);
10452 
10504 Boolean_t TecUtilMacroSetMacroVar(const char *MacroVar,
10505                                                       const char *ValueString);
10506 
10542 Boolean_t TecUtilInterruptCheck(void);
10543 
10584 void TecUtilInterrupt(void);
10585 
10586 
10629 void TecUtilGeomDelete(Geom_ID GID);
10672 void TecUtilTextDelete(Text_ID TID);
10673 
10718 Boolean_t TecUtilPickGeom(Geom_ID GID);
10762 Boolean_t TecUtilPickText(Text_ID TID);
10763 
10805 Boolean_t  TecUtilGeomIsValid(Geom_ID GID);
10839 Boolean_t  TecUtilTextIsValid(Text_ID TID);
10878 char * TecUtilStringConvOldFormatting(const char *OldString,
10879                                                           Font_e      BaseFont);
10918 char * TecUtilStringAlloc(int         MaxLength, /* <-activex> */
10919                                               const char *DebugInfo);
10951 void TecUtilStringDealloc(char **S); /*INOUT*/ /* <-activex> */
10952 
10953 
10954 /* STRING LIST FUNCTIONS */
11002 void TecUtilStringListClear(StringList_pa StringList);
11003 
11066 void TecUtilStringListRemoveStrings(StringList_pa StringList,
11067                                                         LgIndex_t     StringNumber,
11068                                                         LgIndex_t     Count);
11119 void TecUtilStringListRemoveString(StringList_pa StringList,
11120                                                        LgIndex_t     StringNumber);
11159 void TecUtilStringListDealloc(StringList_pa *StringList); /*INOUT*/
11160 
11209 StringList_pa TecUtilStringListAlloc(void);
11210 
11274 Boolean_t TecUtilStringListAppendString(StringList_pa StringList,
11275                                                             const char    *String);
11329 LgIndex_t TecUtilStringListGetCount(StringList_pa StringList);
11330 
11389 const char * TecUtilStringListGetRawStringPtr(StringList_pa StringList,
11390                                                                   LgIndex_t     StringNumber);
11438 char * TecUtilStringListGetString(StringList_pa StringList,
11439                                                       LgIndex_t     StringNumber);
11509 Boolean_t TecUtilStringListSetString(StringList_pa  StringList,
11510                                                          LgIndex_t      StringNumber,
11511                                                          const char    *String);
11579 Boolean_t TecUtilStringListInsertString(StringList_pa  StringList,
11580                                                             LgIndex_t      StringNumber,
11581                                                             const char    *String);
11646 StringList_pa TecUtilStringListCopy(StringList_pa StringList);
11647 
11720 Boolean_t