Main Page   File List   Globals  

TECUTILO.h

Go to the documentation of this file.
00001 
00004 #if defined EXTERN
00005 #undef EXTERN
00006 #endif
00007 #if defined TECUTILOMODULE
00008 #define EXTERN
00009 #else
00010 #define EXTERN extern
00011 #endif
00012 
00013 /*{{<windows_only> TecUtilInterfaceWinAddPreMsgFn PreTranslateMessage_pf </windows_only> }}*/
00014 
00015 #ifdef MSWIN 
00016 /* Add new Windows-only functions here */
00046 Boolean_t TecUtilInterfaceWinAddPreMsgFn(PreTranslateMessage_pf PreTranslateMessageProc);
00047 #endif
00048 
00049 
00050 
00051 
00052 /*{{<exclude_fglue> 
00053                     TecUtilTimerAddCallback AddOnTimerCallback_pf 
00054                     TecUtilDataSetAddVar
00055                     TecUtilInterfaceGetMotifHandles
00056                     TecUtilStringAlloc 
00057                     TecUtilStringListGetRawStringPtr
00058                     TecUtilDataSetAddZone
00059                     TecUtilStateChangeAddCallback 
00060                     TecUtilStateChangeSetMode 
00061                     StateChangeAddOnCallback_pf
00062                     StateChangeAddOnCallbackV2_pf
00063 
00064   </exclude_fglue> }}*/
00065 
00121 Boolean_t   TecUtilTimerAddCallback(UInt32_t               Interval,
00122                                                         ArbParam_t             ClientData,
00123                                                         AddOnTimerCallback_pf  TimerCallback);
00124 
00202 Boolean_t TecUtilOnIdleQueueAddCallback(OnIdleCallback_pf Callback,
00203                                                             ArbParam_t        ClientData);
00204 
00253 Boolean_t TecUtilDialogGetFolderName(const char *Title,
00254                                                          char **FolderName);
00255 
00321 Boolean_t TecUtilDialogGetFileName (SelectFileOption_e   DialogOption,
00322                                                         char               **FileName,
00323                                                         const char          *FileTypeName,
00324                                                         const char          *DefaultFileName,
00325                                                         const char          *DefaultFilter);
00402 Boolean_t TecUtilDialogGetFileNames (SelectFileOption_e   DialogOption,
00403                                                          StringList_pa       *FileNames,
00404                                                          const char          *FileTypeName,
00405                                                          StringList_pa       DefaultFileNames,
00406                                                          const char          *DefaultFilter);
00407 
00408 
00442 Boolean_t TecUtilFileDownloadURL(const char  *SourceURL,
00443                                                      const char  *LocalDestinationFile,
00444                                                      Boolean_t    IsAscii,
00445                                                      Boolean_t    ConfirmOverwrite);
00478 Boolean_t TecUtilFileUploadURL(const char *LocalSourceFile,
00479                                                    const char *DestinationURL,
00480                                                    Boolean_t   IsAscii,
00481                                                    Boolean_t   ConfirmOverwrite);
00497 Boolean_t TecUtilFileIsURL(const char *URLFName);
00498 
00519 void TecUtilArrayDealloc(void **Array);
00520 
00538 MouseButtonMode_e TecUtilMouseGetCurrentMode(void);
00539 
00555 Boolean_t TecUtilMouseIsValidMode(MouseButtonMode_e MouseMode);
00556 
00588 Boolean_t TecUtilMouseSetMode(MouseButtonMode_e MouseMode);
00589 
00590 
00591 
00592 
00598 void TecUtilSidebarAutoSensitivity(Boolean_t DoAuto);
00599 
00600 
00601 
00607 void TecUtilSidebarSetSensitivity(MouseButtonMode_e MouseMode,
00608                                                       Boolean_t         IsSensitive);
00609 
00610 
00611 
00612 
00727 Boolean_t TecUtilProbeInstallCallback(ProbeDestination_pf ProbeDestination,
00728                                                           const char         *InformationLineText);
00743 void TecUtilProbeAllowCOBs(void);
00744 
00745 
00746 
00752 double TecUtilProbeXYGetIndValue(void);
00753 
00754 
00755 
00768 double TecUtilProbeLinePlotGetIndValue(void);
00769 
00770 
00776 Boolean_t TecUtilProbeXYGetDepValue(EntIndex_t MapNum,
00777                                                         double    *DepValue);
00803 Boolean_t TecUtilProbeLinePlotGetDepValue(EntIndex_t MapNum,
00804                                                               double    *DepValue);
00805 
00806 
00807 
00813 EntIndex_t TecUtilProbeXYGetSourceMap(void);
00814 
00815 
00816 
00830 EntIndex_t TecUtilProbeLinePlotGetSourceMap(void);
00844 LgIndex_t TecUtilProbeGetPointIndex(void);
00858 CZType_e TecUtilProbeFieldGetCZType(void);
00875 double TecUtilProbeFieldGetValue(EntIndex_t VarNum);
00888 EntIndex_t TecUtilProbeFieldGetZone(void);
00901 IJKPlanes_e TecUtilProbeFieldGetPlane(void);
00917 LgIndex_t  TecUtilProbeFieldGetFaceCell(void);
00933 LgIndex_t  TecUtilProbeFieldGetCell(void);
00934 
00935 
00936 
00979 Boolean_t TecUtilExtractInstallCallback(ExtractDestination_pf ExtractDestination,
00980                                                             const char           *InformationLineText);
00981 
00982 
00983 
00984 
01029 Boolean_t TecUtilDataSetCreate(const char    *DataSetTitle,
01030                                                    StringList_pa VarNames,
01031                                                    Boolean_t     ResetStyle);
01032 
01033 #if defined COMPILE_BUT_HIDE_FROM_DOC
01034 Boolean_t TecUtilOEMDataSetCreate(const char    *LoaderName,
01035                                                       const char    *DataSetTitle,
01036                                                       StringList_pa VarNames,
01037                                                       Boolean_t     ResetStyle);
01038 #endif
01039 
01040 
01041 
01042 
01043 
01044 
01067 VarLoadMode_e TecUtilDataSetGetVarLoadMode(void);
01068 
01094 void TecUtilZoneSetBuildZoneOptInfo(EntIndex_t Zone,
01095                                                         Boolean_t  BuildZoneOptInfo);
01096 
01156 Boolean_t TecUtilDataSetAddZone(const char      *Name,
01157                                                     LgIndex_t        IMax,
01158                                                     LgIndex_t        JMax,
01159                                                     LgIndex_t        KMax,
01160                                                     ZoneType_e       ZoneType,
01161                                                     FieldDataType_e *VarDataType_Array);
01162 
01163 
01164 
01165 
01512 Boolean_t TecUtilDataSetAddZoneX(ArgList_pa ArgList);
01513 
01514 
01515 
01516 
01517 
01518 
01519 
01697 Boolean_t TecUtilDataSetAddVarX(ArgList_pa ArgList);
01698 
01699 
01700 
01701 
01702 
01740 Boolean_t TecUtilZoneRealloc(EntIndex_t Zone,
01741                                                  LgIndex_t  NewIMaxOrNumDataPoints,
01742                                                  LgIndex_t  NewJMaxOrNumElements,
01743                                                  LgIndex_t  NewKMax);
01744 
01745 
01781 Boolean_t TecUtilDataSetAddVar(const char *VarName,
01782                                                    FieldDataType_e *FieldDataType_Array);
01783  
01784 
01810 Boolean_t TecUtilQuitAddQueryCallback(MopupQueryAddOnCallback_pf QuitQueryCallback);
01811 
01834 Boolean_t TecUtilStateChangeSetMode(StateChangeAddOnCallback_pf Callback,
01835                                                         StateChangeMode_e           Mode);
01836 
01932 Boolean_t TecUtilStateChangeAddCallback(StateChangeAddOnCallback_pf StateChangeCallback); /* <-fglue> */
01933 
02029 void TecUtilStateChanged(StateChange_e StateChange,
02030                                              ArbParam_t    CallData);
02031 
02032 
02033 
02034 
02035 
02157 Boolean_t TecUtilStateChangeAddCallbackX(ArgList_pa ArgList);
02158 
02185 Boolean_t TecUtilStateChangeGetIndex(LgIndex_t *Index);
02214 Boolean_t TecUtilStateChangeGetArbEnum(LgIndex_t *ArbEnum);
02255 Boolean_t TecUtilStateChangeGetZoneSet(Set_pa *ZoneSet);
02283 Boolean_t TecUtilStateChangeGetVarSet(Set_pa *VarSet);
02314 Boolean_t TecUtilStateChangeGetZone(EntIndex_t *Zone);
02342 Boolean_t TecUtilStateChangeGetStyleParam(int          Param,
02343                                                               const char **StyleParam);
02344 
02345 
02465 void TecUtilStateChangedX(ArgList_pa ArgList);
02466 
02467 
02468 
02469 
02537 Boolean_t TecUtilMacroAddCommandCallback(const char                  *AddOnIDString,
02538                                                              MacroCommandAddOnCallback_pf MacroCommandCallback);
02539 
02540 
02567 Boolean_t TecUtilMacroRecordAddOnCommand(const char *AddOnIDString,
02568                                                              const char *Command);
02569 
02570 
02618 Boolean_t TecUtilMacroRecordAddOnComRaw(const char *AddOnIDString,
02619                                                             const char *Command,
02620                                                             const char *RawData);
02621 
02648 Boolean_t TecUtilMacroRecordRawCommand(const char *Command);
02649 
02650 
02677 Boolean_t TecUtilDataSetAddJournalCommand(const char *AddOnIDString,
02678                                                               const char *Instructions,
02679                                                               const char *RawData);
02680 
02697 Boolean_t TecUtilDataSetAddRawJournalCom(const char *Command);
02698 
02699 
02705 Boolean_t TecUtilDataSetAddPostConvInstr(const char *AddOnIDString,
02706                                                              const char *Instructions,
02707                                                              const char *RawData);
02708 
02709 
02710 
02711 #if defined COMPILE_BUT_HIDE_FROM_DOC
02712 void TecUtilDataSetPostReadFinished(Boolean_t IsReadOk);
02713 #endif
02714 
02715 
02716 
02717 #if defined COMPILE_BUT_HIDE_FROM_DOC
02718 Boolean_t TecUtilConvAddPostReadCallback(const char                   *ConverterIDString,
02719                                                              ConverterPostReadCallback_pf ConverterPostReadCallback);
02720 #endif
02721 
02722 
02723 
02745 void TecUtilDataSetSuspendMarking(Boolean_t DoSuspend);
02746 
02747 
02807 void TecUtilDispatchWorkAreaEvent(int       I,
02808                                                       int       J,
02809                                                       int       ButtonOrKey,
02810                                                       Event_e   Event,
02811                                                       Boolean_t IsShifted,
02812                                                       Boolean_t IsAlted,
02813                                                       Boolean_t IsControlled);
02814 
02837 void TecUtilMenuClearAll(void);
02838 
02907 Boolean_t TecUtilMenuAddOption(const char            *MenuPath,
02908                                                    const char            *MenuLabel,
02909                                                    char                   Mnemonic,
02910                                                    DynamicMenuCallback_pf MenuOptionCallback);
02911 
02927 Boolean_t TecUtilMenuAddSeparator(const char *MenuPath);
02928 
02929 
02934 Boolean_t TecUtilMenuSetSensitivity(const char *MenuPath,
02935                                                         const char *MenuLabel,
02936                                                         Boolean_t   IsSensitive);
02937 
02938 /****************************************************************************
02939  *          DataSet Converters and Loaders.                                 *
02940  *                                                                          *
02941  * A Converter is an addon that connects to tecplot in a way such that      *
02942  * tecplot uses it's own file/io dialogs to read the non-Tecplot data into  *
02943  * tecplot and the converter is a simple function that only knows how       *
02944  * to convert from it's own data format into tecplot's binary format.       *
02945  *                                                                          *
02946  * Converters are registered with tecplot by calling:                       *
02947  *                                                                          *
02948  *              TecUtilImportAddConverter                                   *
02949  *                                                                          *
02950  * An loader works like this:                                               *
02951  *     - TecUtilMenuAddOption is called to register a callback              *
02952  *       (most often used to bring up a dialog) to the loader addon         *
02953  *                                                                          *
02954  *     - The loader registers itself with tecplot by calling                *
02955  *       TecUtilImportAddLoader                                             *
02956  *                                                                          *
02957  *     When a request is made to use the loader function:                   *
02958  *                                                                          *
02959  *        - The loader creates a new dataset and loads the data into        *
02960  *          tecplot by hand.                                                *
02961  *                                                                          *
02962  *        - The loader then calls TecUtilImportSetLoaderInstr               *
02963  *          to assign the specific instructions needed to load the data     *
02964  *          into the current dataset.   These instructions will be included *
02965  *          in any layout files written out.                                *
02966  ****************************************************************************/
03025 Boolean_t TecUtilImportAddConverter(DataSetConverter_pf ConverterCallback,
03026                                                           const char         *ConverterName,
03027                                                           const char         *FNameExtension);
03028 
03029 
03124 Boolean_t TecUtilImportAddLoader(DataSetLoader_pf                    LoaderCallback,
03125                                                       const char                         *DataSetLoaderName,
03126                                                       DynamicMenuCallback_pf              LoaderSelectedCallback,
03127                                                       DataSetLoaderInstructionOverride_pf InstructionOverrideCallback);
03128 
03129 
03153 Boolean_t TecUtilImportSetLoaderInstr(const char    *DataSetLoaderName,
03154                                                           StringList_pa Instructions);
03155 
03156 
03157                                                                      
03197 void TecUtilImportWriteLoaderInstr(const char   *DataSetLoaderName,
03198                                                         StringList_pa Instructions);
03204 void TecUtilAddOnRegisterInfo(const char *OfficialName,
03205                                                   const char *Version,
03206                                                   const char *Author);
03207 
03208 
03262 AddOn_pa TecUtilAddOnRegister(int         TecplotVersionNumber,
03263                                                   const char *OfficialName,
03264                                                   const char *Version,
03265                                                   const char *Author);
03313 Boolean_t TecUtilAddOnGetRegisteredInfo(const char *OfficialName,
03314                                                     char **Version,
03315                                                     char **Author);
03316 
03317 
03318 #if defined COMPILE_BUT_HIDE_FROM_DOC
03319 void TecUtilAddOnRegForeignLibLoader(const char          *ForeignLibID, 
03320                                                          ForeignLibLoader_pf ForeignLibLoader, 
03321                                                          ArbParam_t          ClientData);
03322 #endif
03323 
03324 
03325 /* 
03326  *  Extended Curve Fit Registration
03327  */
03328 
03385 Boolean_t TecUtilCurveRegisterExtCrvFit(const char   *CurveFitName,
03386                                   GetLinePlotDataPointsCallback_pf        GetLinePlotDataPointsCallback,
03387                                   GetProbeValueCallback_pf                GetProbeValueCallback,
03388                                   GetCurveInfoStringCallback_pf           GetCurveInfoStringCallback,
03389                                   GetCurveSettingsCallback_pf             GetCurveSettingsCallback,                                  
03390                                   GetAbbreviatedSettingsStringCallback_pf GetAbbreviatedSettingsStringCallback);
03391 
03392 
03414 void TecUtilDialogErrMsg(const char *Message);
03415 
03416 
03417 
03450 void      TecUtilDataValueShare(EntIndex_t SourceZone,
03451                                                     EntIndex_t DestZone,
03452                                                     EntIndex_t Var);
03486 Boolean_t TecUtilDataValueAlloc(EntIndex_t Zone,
03487                                                     EntIndex_t Var);
03523 Boolean_t TecUtilDataValueCanMemMapData(EntIndex_t     Zone,
03524                                                             EntIndex_t     Var,
03525                                                             MemMapOffset_t Offset,
03526                                                             Boolean_t      IsNativeByteOrder);
03559 Boolean_t TecUtilDataValueMemMapData(EntIndex_t     Zone,
03560                                                          EntIndex_t     Var,
03561                                                          int            FileDescriptor,
03562                                                          MemMapOffset_t Offset,
03563                                                          Boolean_t      IsNativeByteOrder);
03592 Boolean_t TecUtilDataValueBranchShared(EntIndex_t Zone,
03593                                                            EntIndex_t Var);
03616 void      TecUtilDataConnectShare(EntIndex_t SourceZone,
03617                                                       EntIndex_t DestZone);
03633 Boolean_t TecUtilDataConnectBranchShared(EntIndex_t Zone);
03634 
03635 
03636 
03637 
03654 void TecUtilDataValueArraySetByRef(FieldData_pa  DestFieldData,
03655                                                        LgIndex_t     DestOffset,
03656                                                        LgIndex_t     DestCount,
03657                                                        void         *SourceValueArray);
03711 void TecUtilDataValueSetByRef(FieldData_pa FD,
03712                                               LgIndex_t    PointIndex,
03713                                               double       Value);
03714 
03754 void TecUtilDataNodeSetByZone(EntIndex_t Zone,
03755                                                        LgIndex_t  Element,
03756                                                        LgIndex_t  Corner,
03757                                                        LgIndex_t  Node);
03758 
03810 void TecUtilDataNodeSetByRef(NodeMap_pa  NM,
03811                                              LgIndex_t   Element,
03812                                              LgIndex_t   Corner,
03813                                              LgIndex_t   Node);
03814 
03834 void TecUtilLockOn(void);
03835 
03836 
03837 
03838 
03859 void TecUtilLockOff(void);
03860 
03861 
03862 
03880 void   TecUtilLockStart(AddOn_pa AddOn);
03897 void   TecUtilLockFinish(AddOn_pa AddOn);
03924 char * TecUtilLockGetCurrentOwnerName(void);
03925 
03952 void      TecUtilStatusStartPercentDone(const char *PercentDoneText,
03953                                                             Boolean_t   ShowStopButton,
03954                                                             Boolean_t   ShowProgressBar);
03970 void      TecUtilStatusSetPercentDoneText(const char *PercentDoneText);
03986 Boolean_t TecUtilStatusCheckPercentDone(int PercentDone);
03998 void      TecUtilStatusFinishPercentDone(void);
03999 
04021 void      TecUtilDialogLaunchPercentDone(const char     *Label,
04022                                                          Boolean_t ShowTheScale);
04041 void      TecUtilDialogSetPercentDoneText(const char *Text);
04079 Boolean_t TecUtilDialogCheckPercentDone(int PercentDone);
04091 void      TecUtilDialogDropPercentDone(void);
04092 
04120 Boolean_t TecUtilMacroExecuteCommand(const char *Command);
04153 Boolean_t TecUtilMacroSetMacroVar(const char *MacroVar,
04154                                                       const char *ValueString);
04155 
04182 void TecUtilInterrupt(void);
04183 
04184 
04212 void TecUtilGeomDelete(Geom_ID GID);
04240 void TecUtilTextDelete(Text_ID TID);
04241 
04268 Boolean_t TecUtilPickGeom(Geom_ID GID);
04294 Boolean_t TecUtilPickText(Text_ID TID);
04295 
04319 Boolean_t  TecUtilGeomIsValid(Geom_ID GID);
04335 Boolean_t  TecUtilTextIsValid(Text_ID TID);
04361 char * TecUtilStringConvOldFormatting(const char *OldString,
04362                                                           Font_e      BaseFont);
04389 char *     TecUtilStringAlloc(int   MaxLength, /* <-activex> */
04390                                                   const char *DebugInfo);
04411 void       TecUtilStringDealloc(char **S); /* <-activex> */
04412 
04413 
04414 /* STRING LIST FUNCTIONS */
04450 void          TecUtilStringListClear(StringList_pa StringList);
04498 void          TecUtilStringListRemoveStrings(StringList_pa StringList,
04499                                                                  LgIndex_t     StringNumber,
04500                                                                  LgIndex_t     Count);
04539 void          TecUtilStringListRemoveString(StringList_pa StringList,
04540                                                                 LgIndex_t     StringNumber);
04567 void          TecUtilStringListDealloc(StringList_pa *StringList);
04601 StringList_pa TecUtilStringListAlloc(void);
04650 Boolean_t     TecUtilStringListAppendString(StringList_pa StringList,
04651                                                                 const char    *String);
04690 LgIndex_t     TecUtilStringListGetCount(StringList_pa StringList);
04739 char *        TecUtilStringListGetRawStringPtr(StringList_pa StringList,
04740                                                                    LgIndex_t     StringNumber);
04771 char *        TecUtilStringListGetString(StringList_pa StringList,
04772                                                               LgIndex_t     StringNumber);
04824 Boolean_t     TecUtilStringListSetString(StringList_pa StringList,
04825                                                              LgIndex_t     StringNumber,
04826                                                              const char    *String);
04878 Boolean_t     TecUtilStringListInsertString(StringList_pa StringList,
04879                                                                 LgIndex_t     StringNumber,
04880                                                                 const char    *String);
04927 StringList_pa TecUtilStringListCopy(StringList_pa StringList);
04983 Boolean_t     TecUtilStringListAppend(StringList_pa Target,
04984                                                           StringList_pa Source);
05037 char *        TecUtilStringListToNLString(StringList_pa StringList);
05091 StringList_pa TecUtilStringListFromNLString(const char *String);
05092 
05093 
05094 /* * SET FUNCTIONS * */
05095 
05125 Set_pa     TecUtilSetAlloc(Boolean_t ShowErr);
05142 void       TecUtilSetDealloc(Set_pa *Set);
05185 Boolean_t  TecUtilSetCopy(Set_pa    DstSet,
05186                                               Set_pa    SrcSet,
05187                                               Boolean_t ShowErr);
05214 void       TecUtilSetClear(Set_pa Set);
05252 Boolean_t  TecUtilSetAddMember(Set_pa     Set,
05253                                                SetIndex_t Member,
05254                                                Boolean_t  ShowErr);
05277 void       TecUtilSetRemoveMember(Set_pa     Set,
05278                                                     SetIndex_t Member);
05312 Boolean_t  TecUtilSetIsMember(Set_pa     Set,
05313                                             SetIndex_t Member);
05338 Boolean_t  TecUtilSetIsEmpty(Set_pa Set);
05355 SetIndex_t TecUtilSetGetMemberCount(Set_pa Set);
05389 Boolean_t  TecUtilSetIsEqual(Set_pa Set1,
05390                                                 Set_pa Set2);
05431 SetIndex_t TecUtilSetGetMember(Set_pa     Set,
05432                                                    SetIndex_t Position);
05468 SetIndex_t TecUtilSetGetPosition(Set_pa     Set,
05469                                                      SetIndex_t Member);
05511 SetIndex_t TecUtilSetGetNextMember(Set_pa     Set,
05512                                                        SetIndex_t Member);
05513 #define TecUtilSetForEachMember(Member, Set) \
05514             for (Member = TecUtilSetGetNextMember(Set, TECUTILSETNOTMEMBER); \
05515                  Member != TECUTILSETNOTMEMBER; \
05516                  Member = TecUtilSetGetNextMember(Set, Member))
05517 
05566 double TecUtilConvertXPosition(CoordSys_e  OldCoordSys,
05567                                                    CoordSys_e  NewCoordSys,
05568                                                    double      OldX);
05610 double TecUtilConvertXDimension(CoordSys_e  OldCoordSys,
05611                                                     CoordSys_e  NewCoordSys,
05612                                                     double      OldDimension);
05641 double TecUtilConvertYPosition(CoordSys_e  OldCoordSys,
05642                                                    CoordSys_e  NewCoordSys,
05643                                                    double      OldY);
05672 double TecUtilConvertYDimension(CoordSys_e  OldCoordSys,
05673                                                     CoordSys_e  NewCoordSys,
05674                                                     double      OldDimension);
05713 double TecUtilConvertUnits(Units_e OldUnits,
05714                                                Units_e NewUnits,
05715                                                double  OldSize);
05716 
05717 
05718 #if defined COMPILE_BUT_HIDE_FROM_DOC
05719 /* Deprecated or Function that should not be otherwise documented. */
05720 Boolean_t TecUtilReadBinaryData(Boolean_t       GetHeaderInfoOnly, /* <-activex> */
05721                                                     const char     *FName,
05722                                                     short          *IVersion,
05723                                                     char          **DataSetTitle,
05724                                                     EntIndex_t     *NumZones,
05725                                                     EntIndex_t     *NumVars,
05726                                                     StringList_pa  *VarNames,
05727                                                     StringList_pa  *ZoneNames,
05728                                                     LgIndex_t     **NumPtsI,
05729                                                     LgIndex_t     **NumPtsJ,
05730                                                     LgIndex_t     **NumPtsK,
05731                                                     ZoneType_e    **ZoneType,
05732                                                     StringList_pa  *UserRec,
05733                                                     Boolean_t       RawDataspaceAllocated,
05734                                                     NodeMap_t    ***NodeMap, 
05735                                                     double       ***VDataBase);
05736 #endif
05737 
05784 LgIndex_t TecUtilTecIni(const char  *Title,
05785                                             const char  *Variables,
05786                                             const char  *FName,
05787                                             const char  *ScratchDir,
05788                                             LgIndex_t   *Debug,
05789                                             LgIndex_t   *VIsDouble);
05790 
05847 LgIndex_t TecUtilTecZne(const char  *ZoneTitle,
05848                                             LgIndex_t   *IMx,
05849                                             LgIndex_t   *JMx,
05850                                             LgIndex_t   *KMx,
05851                                             const char  *ZFormat,
05852                                             const char  *DupList);
05853 
06136 LgIndex_t TecUtilTecZneX(ArgList_pa ArgList);
06137 
06181 LgIndex_t TecUtilTecDat(LgIndex_t *N,
06182                                             void      *FieldData_Array,
06183                                             LgIndex_t *IsDouble);
06184 
06202 LgIndex_t TecUtilTecNod(LgIndex_t *NData_Array);
06203 
06216 LgIndex_t TecUtilTecEnd(void);
06217 
06234 LgIndex_t TecUtilTecLab(const char *S);
06235 
06260 LgIndex_t TecUtilTecUsr(const char *S);
06261 
06278 LgIndex_t TecUtilTecFil(LgIndex_t *F);
06279 
06397 LgIndex_t TecUtilTecTxt(double    *XPos,
06398                                             double    *YPos,
06399                                             LgIndex_t *PosCoordMode,
06400                                             LgIndex_t *AttachToZone,
06401                                             LgIndex_t *Zone,
06402                                             LgIndex_t *Font,
06403                                             LgIndex_t *FontHeightUnits,
06404                                             double    *FontHeight,
06405                                             LgIndex_t *BoxType,
06406                                             double    *BoxMargin,
06407                                             double    *BoxLineThickness,
06408                                             LgIndex_t *BoxColor,
06409                                             LgIndex_t *BoxFillColor,
06410                                             double    *Angle,
06411                                             LgIndex_t *Anchor,
06412                                             double    *LineSpacing,
06413                                             LgIndex_t *TextColor,
06414                                             LgIndex_t *Scope,
06415                                             const char*Text,
06416                                             const char*MacroFunctionCommand);
06417 
06964 LgIndex_t TecUtilTecTxtX(ArgList_pa ArgList);
06965 
07104 LgIndex_t TecUtilTecGeo(double    *XPos,
07105                                             double    *YPos,
07106                                             double    *ZPos,
07107                                             LgIndex_t *PosCoordMode,
07108                                             LgIndex_t *AttachToZone,
07109                                             LgIndex_t *Zone,
07110                                             LgIndex_t *Color,
07111                                             LgIndex_t *FillColor,
07112                                             LgIndex_t *IsFilled,
07113                                             LgIndex_t *GeomType,
07114                                             LgIndex_t *LinePattern,
07115                                             double    *PatternLength,
07116                                             double    *LineThickness,
07117                                             LgIndex_t *NumEllipsePts,
07118                                             LgIndex_t *ArrowheadStyle,
07119                                             LgIndex_t *ArrowheadAttachment,
07120                                             double    *ArrowheadSize,
07121                                             double    *ArrowheadAngle,
07122                                             LgIndex_t *Scope,
07123                                             LgIndex_t *NumSegments,
07124                                             LgIndex_t *NumSegPts,
07125                                             float     *XGeomData,
07126                                             float     *YGeomData,
07127                                             float     *ZGeomData,
07128                                             const char*MacroFunctionCommand);
07129 
07772 LgIndex_t TecUtilTecGeoX(ArgList_pa ArgList);
07773 
07795 LgIndex_t TecUtilTecAux(char *Name,
07796                                             char *Value);
07797 
07819 LgIndex_t TecUtilTecZAux(char *Name,
07820                                              char *Value);
07821 
07839 LgIndex_t TecUtilTecFace(LgIndex_t *FaceConnections);
07840 
07841 
07842 /* Text and Geom Functions */
07843 
07861 Clipping_e    TecUtilTextGetClipping(Text_ID TID);
07920 void          TecUtilTextGetAnchorPos(Text_ID TID,
07921                                                           double  *XOrThetaPos,
07922                                                           double  *YOrRPos,
07923                                                           double  *ZPos);
07924 
07930 void          TecUtilTextGetXYPos (Text_ID  TID,
07931                                                        double  *XPos,
07932                                                        double  *YPos);
07948 CoordSys_e    TecUtilTextGetPositionCoordSys (Text_ID TID);
07966 EntIndex_t    TecUtilTextGetZoneOrMap (Text_ID TID);
07984 Boolean_t     TecUtilTextIsAttached (Text_ID TID);
08001 ColorIndex_t  TecUtilTextGetColor (Text_ID TID);
08019 Font_e        TecUtilTextGetFont (Text_ID TID);
08035 double        TecUtilTextGetHeight (Text_ID TID);
08052 Units_e       TecUtilTextGetSizeUnits (Text_ID TID);
08068 TextBox_e     TecUtilTextBoxGetType (Text_ID TID);
08084 double        TecUtilTextBoxGetMargin (Text_ID TID);
08100 double        TecUtilTextBoxGetLineThickness (Text_ID TID);
08116 ColorIndex_t  TecUtilTextBoxGetColor (Text_ID TID);
08132 ColorIndex_t  TecUtilTextBoxGetFillColor (Text_ID TID);
08148 double        TecUtilTextGetAngle (Text_ID TID);
08166 TextAnchor_e  TecUtilTextGetAnchor (Text_ID TID);
08184 double        TecUtilTextGetLineSpacing (Text_ID TID);
08202 Scope_e       TecUtilTextGetScope (Text_ID TID);
08203 
08204 
08205 
08253 Boolean_t     TecUtilTextGetMacroFunctionCmd (Text_ID   TID,
08254                                                                   char    **MacroFunctionCommand);
08313 Boolean_t     TecUtilTextGetString (Text_ID   TID,
08314                                                         char    **TextString);
08335 Text_ID       TecUtilTextGetNext (Text_ID TID);
08357 Text_ID       TecUtilTextGetPrev (Text_ID TID);
08358 
08382 Clipping_e    TecUtilGeomGetClipping(Geom_ID GID);
08429 void          TecUtilGeomGetAnchorPos(Geom_ID  GID,
08430                                                           double  *XOrThetaPos,
08431                                                           double  *YOrRPos,
08432                                                           double  *ZPos);
08433 
08461 void          TecUtilGeomImageSetUseRatio(Geom_ID GID,
08462                                                               Boolean_t MaintainAspectRatio);
08463 
08464 
08470 void          TecUtilGeomGetXYZAnchorPos(Geom_ID  GID,
08471                                                              double  *XPos,
08472                                                              double  *YPos,
08473                                                              double  *ZPos);
08495 EntIndex_t    TecUtilGeomGetZoneOrMap (Geom_ID GID);
08524 Boolean_t     TecUtilGeomIsAttached (Geom_ID GID);
08541 ColorIndex_t  TecUtilGeomGetColor (Geom_ID GID);
08559 ColorIndex_t  TecUtilGeomGetFillColor (Geom_ID GID);
08575 Boolean_t     TecUtilGeomGetIsFilled (Geom_ID GID);
08592 GeomForm_e    TecUtilGeomGetType (Geom_ID GID);
08610 LinePattern_e TecUtilGeomGetLinePattern (Geom_ID GID);
08626 double        TecUtilGeomGetPatternLength (Geom_ID GID);
08642 double        TecUtilGeomGetLineThickness (Geom_ID GID);
08658 SmInteger_t   TecUtilGeomEllipseGetNumPoints (Geom_ID GID);
08675 ArrowheadStyle_e        TecUtilGeomArrowheadGetStyle (Geom_ID GID);
08693 ArrowheadAttachment_e   TecUtilGeomArrowheadGetAttach (Geom_ID GID);
08709 double        TecUtilGeomArrowheadGetSize (Geom_ID GID);
08725 double        TecUtilGeomArrowheadGetAngle (Geom_ID GID);
08743 Scope_e       TecUtilGeomGetScope (Geom_ID GID);
08759 CoordSys_e    TecUtilGeomGetPositionCoordSys (Geom_ID GID);
08782 ImageResizeFilter_e TecUtilGeomImageGetResizeFilter (Geom_ID GID);
08810 void          TecUtilGeomImageSetResizeFilter(Geom_ID GID,
08811                                                                   ImageResizeFilter_e ResizeFilter);
08843 void TecUtilGeomImageGetFileName(Geom_ID GID,
08844                                                      char **FileName);
08845 
08875 void TecUtilGeomImageSetWidth(Geom_ID GID,
08876                                                  double Width);
08877 
08907 void TecUtilGeomImageSetHeight(Geom_ID GID,
08908                                                  double Height);
08909 
08944 void TecUtilGeomImageGetSize(Geom_ID GID,
08945                                                  double *Width,
08946                                                  double *Height);
08947 
08970 void TecUtilGeomImageResetAspectRatio(Geom_ID GID);
08971 
08972 #if defined COMPILE_BUT_HIDE_FROM_DOC
08973 Boolean_t TecUtilGeomImageGetImage(Geom_ID         GID,
08974                                                        ScreenDim_t    *Width,
08975                                                        ScreenDim_t    *Height,
08976                                                        Byte_t **RGBData);
08977 #endif
08978 
09003 Boolean_t TecUtilGeomGetMacroFunctionCmd (Geom_ID   GID,
09004                                                               char    **MacroFunctionCmd);
09005 
09051 Geom_ID TecUtilGeomImageCreate(const char *FName,
09052                                                    double CornerXOrTheta,
09053                                                    double CornerYOrR,
09054                                                    double Size);
09055 
09056 
09057 
09088 Geom_ID       TecUtilGeomGetNext (Geom_ID GID);
09120 Geom_ID       TecUtilGeomGetPrev (Geom_ID GID);
09121 
09153 void       TecUtilTextSetClipping(Text_ID    TID,
09154                                                       Clipping_e Clipping);
09189 void       TecUtilTextSetAnchorPos(Text_ID TID,
09190                                                        double  XOrThetaPos,
09191                                                        double  YOrRPos,
09192                                                        double  ZPos);
09198 void       TecUtilTextSetXYPos (Text_ID TID,
09199                                                     double XPos,
09200                                                     double YPos);
09256 void       TecUtilTextSetCoordSysAndUnits (Text_ID TID,
09257                                                                CoordSys_e PositionCoordSys,
09258                                                                Units_e    HeightUnits);
09282 void       TecUtilTextSetZoneOrMap (Text_ID TID,
09283                                                         EntIndex_t ZoneOrMap);
09307 void       TecUtilTextSetAttached (Text_ID TID,
09308                                                        Boolean_t Attached);
09331 void       TecUtilTextSetColor (Text_ID TID,
09332                                                     ColorIndex_t Color);
09356 void       TecUtilTextSetFont (Text_ID TID,
09357                                                    Font_e Font);
09380 void       TecUtilTextSetHeight (Text_ID TID,
09381                                                      double Height);
09412 void       TecUtilTextBoxSetType (Text_ID TID,
09413                                                       TextBox_e TextBoxType);
09445 void       TecUtilTextBoxSetMargin (Text_ID TID,
09446                                                         double Margin);
09468 void       TecUtilTextBoxSetLineThickness (Text_ID TID,
09469                                                                double LineThickness);
09502 void       TecUtilTextBoxSetColor (Text_ID TID,
09503                                                        ColorIndex_t BoxColor);
09536 void       TecUtilTextBoxSetFillColor (Text_ID TID,
09537                                                            ColorIndex_t BoxFillColor);
09559 void       TecUtilTextSetAngle (Text_ID TID,
09560                                                     double Angle);
09584 void       TecUtilTextSetAnchor (Text_ID TID,
09585                                                      TextAnchor_e Anchor);
09609 void       TecUtilTextSetLineSpacing (Text_ID TID,
09610                                                           double LineSpacing);
09634 void       TecUtilTextSetScope (Text_ID TID,
09635                                                     Scope_e Scope);
09657 Boolean_t  TecUtilTextSetMacroFunctionCmd (Text_ID TID,
09658                                                                const char *Command);
09680 Boolean_t  TecUtilTextSetString (Text_ID TID,
09681                                                      const char *TextString);
09682 
09712 void       TecUtilGeomSetClipping(Geom_ID    GID,
09713                                                       Clipping_e Clipping);
09756 void       TecUtilGeomSetAnchorPos(Geom_ID GID,
09757                                                        double  XPos,
09758                                                        double  YPos,
09759                                                        double  ZPos);
09765 void       TecUtilGeomSetXYZAnchorPos(Geom_ID GID,
09766                                                           double  XPos,
09767                                                           double  YPos,
09768                                                           double  ZPos);
09788 void       TecUtilGeomSetZoneOrMap (Geom_ID GID,
09789                                                         EntIndex_t ZoneOrMap);
09817 void       TecUtilGeomSetAttached (Geom_ID GID,
09818                                                        Boolean_t Attached);
09846 void       TecUtilGeomSetColor (Geom_ID GID,
09847                                                      ColorIndex_t Color);
09878 void       TecUtilGeomSetFillColor (Geom_ID GID,
09879                                                          ColorIndex_t FillColor);
09899 void       TecUtilGeomSetIsFilled (Geom_ID GID,
09900                                                        Boolean_t IsFilled);
09928 void       TecUtilGeomSetLinePattern (Geom_ID GID,
09929                                                           LinePattern_e LinePattern);
09960 void       TecUtilGeomSetPatternLength (Geom_ID GID,
09961                                                             double PatternLength);
09988 void       TecUtilGeomSetLineThickness (Geom_ID GID,
09989                                                             double LineThickness);
10016 void       TecUtilGeomEllipseSetNumPoints (Geom_ID GID,
10017                                                             SmInteger_t NumEllipsePts);
10046 void       TecUtilGeomArrowheadSetStyle (Geom_ID GID,
10047                                                              ArrowheadStyle_e ArrowheadStyle);
10075 void       TecUtilGeomArrowheadSetAttach (Geom_ID GID,
10076                                                               ArrowheadAttachment_e ArrowheadAttachment);
10104 void       TecUtilGeomArrowheadSetSize (Geom_ID  GID,
10105                                                             double   ArrowheadSize);
10133 void       TecUtilGeomArrowheadSetAngle (Geom_ID  GID,
10134                                                              double   ArrowheadAngle);
10135 
10157 void       TecUtilGeomSetDrawOrder(Geom_ID GID,
10158                                                        DrawOrder_e DrawOrder);
10159 
10181 Boolean_t   TecUtilGeomImageGetUseRatio(Geom_ID GID);
10182 
10204 DrawOrder_e TecUtilGeomGetDrawOrder(Geom_ID GID);
10205 
10225 void       TecUtilGeomSetScope (Geom_ID  GID,
10226                                                     Scope_e  Scope);
10257 void       TecUtilGeomSetPositionCoordSys (Geom_ID    GID,
10258                                                                CoordSys_e CoordSys);
10286 Boolean_t  TecUtilGeomSetMacroFunctionCmd (Geom_ID  GID,
10287                                                                const char    *Command);
10300 void       TecUtilDropOpeningBanner (void);
10301 
10302 
10303 /* Geometry/text convenience functions */
10304 
10361 Text_ID TecUtilTextCreate(CoordSys_e  PositionCoordSys,
10362                                               double      PosX, 
10363                                               double      PosY,
10364                                               Units_e     HeightUnits,
10365                                               double      Height,
10366                                               const char *Text);
10367 
10411 Text_ID TecUtilText3DCreate(double      PosX, 
10412                                                 double      PosY,
10413                                                 double      PosZ,
10414                                                 Units_e     HeightUnits,
10415                                                 double      Height,
10416                                                 const char *Text);
10417 
10461 Geom_ID TecUtilGeomSquareCreate(CoordSys_e PositionCoordSys,
10462                                                     double     CornerX,
10463                                                     double     CornerY,
10464                                                     double     Size);
10465 
10510 Geom_ID TecUtilGeomCircleCreate(CoordSys_e PositionCoordSys,
10511                                                     double     CenterX,
10512                                                     double     CenterY,
10513                                                     double     Radius);
10514 
10563 Geom_ID TecUtilGeomRectangleCreate(CoordSys_e PositionCoordSys,
10564                                                        double     CornerX, 
10565                                                        double     CornerY, 
10566                                                        double     Width, 
10567                                                        double     Height);
10568 
10617 Geom_ID TecUtilGeomEllipseCreate(CoordSys_e PositionCoordSys,
10618                                                      double     CenterX, 
10619                                                      double     CenterY, 
10620                                                      double     HAxis, 
10621                                                      double     VAxis);
10622 
10673 Geom_ID TecUtilGeom2DPolylineCreate(CoordSys_e PositionCoordSys,
10674                                                         double    *PtsX_Array,
10675                                                         double    *PtsY_Array,
10676                                                         LgIndex_t  NumPts);
10677 
10726 Geom_ID TecUtilGeom3DPolylineCreate(double   *PtsX_Array,
10727                                                         double   *PtsY_Array,
10728                                                         double   *PtsZ_Array,
10729                                                         LgIndex_t NumPts);
10775 Geom_ID TecUtilGeom2DMPolyCreate(CoordSys_e PositionCoordSys,
10776                                                      LgIndex_t  NumPolys,
10777                                                      LgIndex_t  *NumPointsInPolylines_Array);
10778 
10826 Geom_ID TecUtilGeom3DMPolyCreate(LgIndex_t NumPolys,
10827                                                      LgIndex_t *NumPointsInPolylines_Array);
10883 Geom_ID TecUtilGeomArcCreate(CoordSys_e PositionCoordSys,
10884                                                  double     CenterX, 
10885                                                  double     CenterY, 
10886                                                  double     Radius, 
10887                                                  double     StartAngle, 
10888                                                  double     EndAngle);
10889 
10939 Geom_ID TecUtilGeom2DLineSegmentCreate(CoordSys_e PositionCoordSys,
10940                                                            double     X1, 
10941                                                            double     Y1, 
10942                                                            double     X2, 
10943                                                            double     Y2);
10944 
10998 Geom_ID TecUtilGeom3DLineSegmentCreate(double X1, 
10999                                                            double Y1, 
11000                                                            double Z1, 
11001                                                            double X2, 
11002                                                            double Y2, 
11003                                                            double Z2);
11026 LgIndex_t TecUtilGeomMPolyGetPolylineCnt(Geom_ID GID);
11042 LgIndex_t TecUtilGeomPolyGetPointCount(Geom_ID GID);
11071 LgIndex_t TecUtilGeomMPolyGetPointCount(Geom_ID   GID,
11072                                                             LgIndex_t PolyNum);
11119 void TecUtilGeom2DMPolyGetPoint(Geom_ID   GID,
11120                                                     LgIndex_t PolyNum,
11121                                                     LgIndex_t PointIndex,
11122                                                     double    *X,
11123                                                     double    *Y);
11164 void TecUtilGeom2DPolylineGetPoint(Geom_ID   GID,
11165                                                        LgIndex_t PointIndex,
11166                                                        double    *X,
11167                                                        double    *Y);
11213 void TecUtilGeom2DMPolySetPoint(Geom_ID   GID,
11214                                                     LgIndex_t PolyNum,
11215                                                     LgIndex_t PointIndex,
11216                                                     double    X,
11217                                                     double    Y);
11259 void TecUtilGeom2DPolylineSetPoint(Geom_ID   GID,
11260                                                        LgIndex_t PointIndex,
11261                                                        double    X,
11262                                                        double    Y);
11297 void TecUtilGeom2DMPolySetPolyline(Geom_ID   GID,
11298                                                        LgIndex_t PolyNum,
11299                                                        double    *X_Array,
11300                                                        double    *Y_Array);
11352 void TecUtilGeom3DMPolyGetPoint(Geom_ID   GID,
11353                                                     LgIndex_t PolyNum,
11354                                                     LgIndex_t PointIndex,
11355                                                     double    *X,
11356                                                     double    *Y,
11357                                                     double    *Z);
11403 void TecUtilGeom3DPolylineGetPoint(Geom_ID   GID,
11404                                                        LgIndex_t PointIndex,
11405                                                        double    *X,
11406                                                        double    *Y,
11407                                                        double    *Z);
11459 void TecUtilGeom3DMPolySetPoint(Geom_ID   GID,
11460                                                     LgIndex_t PolyNum,
11461                                                     LgIndex_t PointIndex,
11462                                                     double    X,
11463                                                     double    Y,
11464                                                     double    Z);
11510 void TecUtilGeom3DPolylineSetPoint(Geom_ID   GID,
11511                                                        LgIndex_t PointIndex,
11512                                                        double    X,
11513                                                        double    Y,
11514                                                        double    Z);
11555 void TecUtilGeom3DMPolySetPolyline(Geom_ID   GID,
11556                                                        LgIndex_t PolyNum,
11557                                                        double    *X_Array,
11558                                                        double    *Y_Array,
11559                                                        double    *Z_Array);
11575 double TecUtilGeomCircleGetRadius(Geom_ID GID);
11604 void TecUtilGeomCircleSetRadius(Geom_ID GID,
11605                                                     double  Radius);
11628 double TecUtilGeomSquareGetSize(Geom_ID GID);
11657 void TecUtilGeomSquareSetSize(Geom_ID GID,
11658                                                   double  Size);
11693 void TecUtilGeomRectangleGetSize(Geom_ID GID,
11694                                                      double  *Width,
11695                                                      double  *Height);
11729 void TecUtilGeomRectangleSetSize(Geom_ID GID,
11730                                                      double  Width,
11731                                                      double  Height);
11766 void TecUtilGeomEllipseGetSize(Geom_ID GID,
11767                                                    double  *HAxis,
11768                                                    double  *VAxis);
11802 void TecUtilGeomEllipseSetSize(Geom_ID GID,
11803                                                    double  HAxis,
11804                                                    double  VAxis);
11805 
11806 
11823 char * TecUtilGetCurLayoutFName(void);
11824 
11825 /* CORE SOURCE CODE REMOVED */
11826 
11827 
11886 void TecUtilHelp(const char *HelpFileOrURL,
11887                                      Boolean_t   GoToID,
11888                                      int         HelpID);
11889 
11890 
11891 
11920 Boolean_t TecUtilDataSetLockOn(const char *LockString);
11936 Boolean_t TecUtilDataSetLockOff(const char *LockString);
11957 Boolean_t TecUtilDataSetIsLocked(char **LockString);
11958 
11999 void TecUtilPleaseWait(const char *WaitMessage,
12000                                            Boolean_t   DoWait);
12001 
12002 #if defined COMPILE_BUT_HIDE_FROM_DOC
12003 void TecUtilUndoStateBegin(UndoStateCategory_e Category);
12004 
12005 void TecUtilUndoStateEnd(Boolean_t DoInvalidate,
12006                                              Boolean_t DoCommit);
12007 #endif
12008 
12014 Boolean_t TecUtilUndoCanUndo(void);
12021 Boolean_t TecUtilUndoDoUndo(void);

Generated on Tue May 18 14:14:10 2004 for Tecplot by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002