Go to the source code of this file.
Defines | |
#define | EXTERN extern |
Functions | |
ArgList_pa | TecUtilArgListAlloc (void) |
Allocate an argument list. More... | |
void | TecUtilArgListClear (ArgList_pa ArgList) |
Clear all arguments from an argument list. More... | |
Boolean_t | TecUtilArgListAppendInt (ArgList_pa ArgList, const char *Name, LgIndex_t Value) |
Append an integer parameter to an argument list. More... | |
Boolean_t | TecUtilArgListAppendArbParam (ArgList_pa ArgList, const char *Name, ArbParam_t Value) |
Append an ArbParam_t type parameter to an argument list. More... | |
Boolean_t | TecUtilArgListAppendArbParamPtr (ArgList_pa ArgList, const char *Name, ArbParam_t *Value) |
Appends an ArbParam_t pointer parameter to an argument list. More... | |
Boolean_t | TecUtilArgListAppendDouble (ArgList_pa ArgList, const char *Name, double Value) |
Append a double parameter to an argument list. More... | |
Boolean_t | TecUtilArgListAppendDoublePtr (ArgList_pa ArgList, const char *Name, double *Value) |
Appends a double pointer parameter to an argument list. More... | |
Boolean_t | TecUtilArgListAppendString (ArgList_pa ArgList, const char *Name, const char *Value) |
Append a string to an argument list. More... | |
Boolean_t | TecUtilArgListAppendArray (ArgList_pa ArgList, const char *Name, const void *Value) |
Appends a named array to the argument list. More... | |
Boolean_t | TecUtilArgListAppendSet (ArgList_pa ArgList, const char *Name, Set_pa Value) |
Append a named set to an argument list. More... | |
Boolean_t | TecUtilArgListAppendStringList (ArgList_pa ArgList, const char *Name, StringList_pa StringList) |
Append a named string list to an argument list. More... | |
Boolean_t | TecUtilArgListAppendFunction (ArgList_pa ArgList, const char *Name, const void *Value) |
Append a named function pointer to an argument list. More... | |
void | TecUtilArgListDealloc (ArgList_pa *ArgList) |
Deallocate an argument list. More... | |
Boolean_t | TecUtilColorMapRedistControlPts (void) |
Redistribute the control points for the currently active color map so they are evenly spaced across the color spectrum. More... | |
Boolean_t | TecUtilColorMapCopyStandard (ContourColorMap_e ColorMap) |
Preset either the user-defined color map or the raw user-defined color map to be a copy of one of the standard color maps. More... | |
Boolean_t | TecUtilColorMapResetToFactory (void) |
Redistribute the control points and reset the RGB values for the currently active color map. More... | |
Boolean_t | TecUtilRedraw (Boolean_t DoFullDrawing) |
Redraw the current frame. More... | |
Boolean_t | TecUtilRedrawAll (Boolean_t DoFullDrawing) |
Redraw all frames. More... | |
Boolean_t | TecUtilDoubleBuffer (DoubleBufferAction_e DoubleBufferAction) |
Implements a double buffer action as described below by the DoubleBufferAction parameter definitions. More... | |
Boolean_t | TecUtilDrawGraphics (Boolean_t DoDrawing) |
Turn on or off all graphics drawing. More... | |
Boolean_t | TecUtilQuit (void) |
Terminate the execution of the Tecplot program. More... | |
Boolean_t | TecUtilFrameCreateNew (Boolean_t UseSuppliedFrameSize, double XPos, double YPos, double Width, double Height) |
Creates a new frame. More... | |
Boolean_t | TecUtilFramePopByName (const char *Name) |
Pop a frame (specified by name) to the top. More... | |
Boolean_t | TecUtilFramePushByName (const char *Name) |
Push a frame (specified by name) to the bottom. More... | |
Boolean_t | TecUtilFramePopByUniqueID (UniqueID_t UniqueID) |
Pops a frame identified by a unique ID. More... | |
Boolean_t | TecUtilFramePushByUniqueID (UniqueID_t UniqueID) |
Pushes a frame identified by a unique ID. More... | |
Boolean_t | TecUtilFramePushTop (void) |
Push the top (active) frame to the bottom. More... | |
Boolean_t | TecUtilFramePush (int FrameNum) |
Push a frame to the bottom of the frame stack (i.e., it is given the frame number 1 and therefore drawn first). More... | |
Boolean_t | TecUtilFramePop (int FrameNum) |
Pop a frame to the top (that is, make it the active frame). More... | |
Boolean_t | TecUtilFramePopAtPosition (double X, double Y) |
Pop the frame on top at a specified position on the paper. More... | |
Boolean_t | TecUtilFrameDeleteTop (void) |
Delete the top (active) frame. More... | |
Boolean_t | TecUtilFrameFitAllToPaper (void) |
Resize all frames so that they fit inside the hardclip limits of the paper. More... | |
ColorIndex_t | TecUtilFrameGetBackgroundColor (void) |
This function gets the current background color of the frame. More... | |
Boolean_t | TecUtilFrameGetName (char **Name) |
Get the name of the current frame. More... | |
Boolean_t | TecUtilStyleSetBase (StyleBase_e StyleBase) |
Set the frame style defaults used by Tecplot when creating new frames. More... | |
Boolean_t | TecUtilZoneDelete (Set_pa ZoneList) |
Boolean_t | TecUtilDataSetDeleteZone (Set_pa ZoneList) |
Deletes the specified set of zones. More... | |
Boolean_t | TecUtilDataSetDeleteVar (Set_pa VarList) |
Deletes the specified set of variables. More... | |
Boolean_t | TecUtilReadDataSet (ReadDataOption_e ReadDataOption, Boolean_t ResetStyle, StringList_pa FileNamesOrInstructions, const char *DataSetReader, PlotType_e InitialPlotType, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeCustomLabels, Boolean_t IncludeData, Boolean_t CollapseZonesAndVars, Set_pa ZonesToRead, VarLoadMode_e VarLoadMode, Set_pa VarPositionList, StringList_pa VarNameList, LgIndex_t ISkip, LgIndex_t JSkip, LgIndex_t KSkip) |
Read one or more data files into Tecplot to form a new data set in the current frame. More... | |
Boolean_t | TecUtilDataSetReadX (ArgList_pa ArgList) |
Read one or more data files into Tecplot to form a new data set in the current frame. More... | |
Boolean_t | TecUtilDataSetWriteX (ArgList_pa ArgList) |
Write the specified components of the current frame's data set to a file. More... | |
Boolean_t | TecUtilWriteDataSet (const char *FName, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeCustomLabels, Boolean_t IncludeData, Set_pa ZonesToWrite, Set_pa VarsToWrite, Boolean_t WriteBinary, Boolean_t UsePointFormat, SmInteger_t AsciiPrecision) |
Write the data set attached to the current frame to a file. More... | |
Boolean_t | TecUtilCreateRectangularZone (LgIndex_t IMax, LgIndex_t JMax, LgIndex_t KMax, double XMin, double YMin, double ZMin, double XMax, double YMax, double ZMax, FieldDataType_e FieldDataType) |
Create a rectangular zone. More... | |
Boolean_t | TecUtilCreateCircularZone (LgIndex_t IMax, LgIndex_t JMax, LgIndex_t KMax, double XOrigin, double YOrigin, double Radius, double ZMin, double ZMax, FieldDataType_e FieldDataType) |
Create a circular (or cylindrical) IJ- or IJK-ordered zone. More... | |
Boolean_t | TecUtilCreateSimpleXYZone (LgIndex_t NumPoints, const double *XValues, const double *YValues, FieldDataType_e FieldDataType) |
Boolean_t | TecUtilCreateSimpleZone (LgIndex_t NumPoints, const double *V1Values, const double *V2Values, FieldDataType_e FieldDataType) |
Create a new zone by specifying only a list of XY pairs of data. More... | |
char * | TecUtilGetBasePath (const char *FName) |
Get the base path of a file name. More... | |
Boolean_t | TecUtilPublish (const char *FName, Boolean_t IncludeLayoutPackage, ImageSelection_e ImageSelection) |
Write out an html file and related image files. More... | |
Boolean_t | TecUtilNewLayout (void) |
Delete all frames and data sets (clear the current layout). More... | |
Boolean_t | TecUtilOpenLayout (const char *FName, StringList_pa AltInstructions, Boolean_t Append) |
Open and read in a new layout file. More... | |
Boolean_t | TecUtilSaveLayout (const char *FName, Boolean_t UseRelativePaths) |
Save the current layout to a file. More... | |
Boolean_t | TecUtilSaveLayoutX (ArgList_pa ArgList) |
Save the current layout to a file. More... | |
Boolean_t | TecUtilReadStylesheet (const char *FName, Boolean_t IncludePlotStyle, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeStreamPositions, Boolean_t IncludeContourLevels, Boolean_t MergeStyle, Boolean_t IncludeFrameSizeAndPosition) |
Read a stylesheet file into the current frame. More... | |
Boolean_t | TecUtilWriteStylesheetX (ArgList_pa ArgList) |
Write the style for the current frame to a file. More... | |
Boolean_t | TecUtilWriteStylesheet (const char *FName, Boolean_t IncludePlotStyle, Boolean_t IncludeText, Boolean_t IncludeGeom, Boolean_t IncludeStreamPositions, Boolean_t IncludeContourLevels, Boolean_t IncludeFactoryDefaults) |
Write the style for the current frame to a file. More... | |
Boolean_t | TecUtilReadColorMap (const char *FName) |
Load a color map file. More... | |
Boolean_t | TecUtilRawColorMap (int NumRawRGBValues, ColorIndex_t *RawRValues_Array, ColorIndex_t *RawGValues_Array, ColorIndex_t *RawBValues_Array) |
Assign the RGB values that define the Raw User-Defined color map. More... | |
Boolean_t | TecUtilWriteColorMap (const char *FName) |
Write the current color map to a file. More... | |
Boolean_t | TecUtilExport (Boolean_t Append) |
Export an image file from Tecplot. More... | |
Boolean_t | TecUtilWorkViewFitSelectFrames (void) |
Change the view in the workspace so the currently selected frames (that is, the frames with picked handles) are fit just inside the edges of the workspace. More... | |
Boolean_t | TecUtilWorkViewFitAllFrames (void) |
Change the view in the workspace so all frames are fit just inside the edges of the workspace. More... | |
Boolean_t | TecUtilWorkViewFitPaper (void) |
Change the view in the workspace so the entire paper is fit just inside the edges of the workspace. More... | |
Boolean_t | TecUtilWorkViewMaximize (void) |
Temporarily expand the workspace as large as possible. More... | |
Boolean_t | TecUtilWorkViewLastView (void) |
Return to the previous workspace view. More... | |
Boolean_t | TecUtilWorkViewZoom (double X1, double Y1, double X2, double Y2) |
Change the view into the workspace. More... | |
Boolean_t | TecUtilWorkViewTranslate (double X, double Y) |
Shift the view of the workspace. More... | |
Boolean_t | TecUtilViewPush (void) |
Instruct Tecplot to push the current view onto the view stack associated with the frame mode for the current frame. More... | |
Boolean_t | TecUtilViewPaste (void) |
Retrieve the view from the view paste buffer and assign it to the current frame. More... | |
Boolean_t | TecUtilViewCopy (void) |
Copy the view from the current frame to the view paste buffer. More... | |
Boolean_t | TecUtilViewLast (void) |
Retrieve the previous view from the view stack. More... | |
Boolean_t | TecUtilViewZoom (double X1, double Y1, double X2, double Y2) |
Change the view by "zooming" into the image. More... | |
Boolean_t | TecUtilViewTranslate (double X, double Y) |
Shift the image in the X- and/or Y-direction. More... | |
Boolean_t | TecUtilViewCenter (void) |
Center the data within the axis grid area. More... | |
Boolean_t | TecUtilViewScale (double Scale) |
Boolean_t | TecUtilViewSetMagnification (double Magnification) |
Scale (magnify) the view by a given value. More... | |
Boolean_t | TecUtilViewAxisFit (char Axis, short AxisNum) |
Reset the range on a specific axis so that it equals the minimum and maximum of the data being plotted. More... | |
Boolean_t | TecUtilViewDataFit (void) |
Fit the data being plotted within the axis grid area. More... | |
Boolean_t | TecUtilViewFit (void) |
Fit the data being plotted within the axis grid area. More... | |
Boolean_t | TecUtilViewNiceFit (void) |
Fit the data being plotted within the axis grid area leaving a determined border around the edge of the plot to make in more visually appealing. More... | |
Boolean_t | TecUtilViewMakeCurViewNice (void) |
Give a border to the current view. More... | |
Boolean_t | TecUtilViewAxisNiceFit (char Axis, short AxisNum) |
Reset the range on a specific axis so that it equals a little more than the minimum and maximum of the data being plotted allowing a small border to enhance visual appeal. More... | |
Boolean_t | TecUtilViewAxisMakeCurValsNice (char Axis, short AxisNum) |
Makes the curently viewed axis values visually appealing. More... | |
Boolean_t | TecUtilReset3DAxes (void) |
Reset the ranges on the 3-D axes. More... | |
Boolean_t | TecUtilReset3DScaleFactors (void) |
Recalculate the scale factors for the 3-D axes. More... | |
Boolean_t | TecUtilPrint (void) |
Print the current layout to a printer or send the print instructions to a file. More... | |
Boolean_t | TecUtilPickAtPosition (double X, double Y, Boolean_t CollectingObjects, Boolean_t DiggingForObjects) |
Pick an object at a specified location. More... | |
Boolean_t | TecUtilPickDeselectAll (void) |
Deselect all selected objects. More... | |
Boolean_t | TecUtilPickAddFrameByUniqueID (Boolean_t CollectingObjects, UniqueID_t UniqueID) |
Adds the frame identified by the unique identifier to the pick list. More... | |
Boolean_t | TecUtilPickAddZones (Boolean_t CollectingObjects, Set_pa ZoneSet) |
Adds the specified Line-maps to the pick object list. More... | |
Boolean_t | TecUtilPickAddXYMaps (Boolean_t CollectingObjects, Set_pa XYMapsSet) |
Boolean_t | TecUtilPickAddLineMaps (Boolean_t CollectingObjects, Set_pa LineMapSet) |
Adds the specified Line-maps to the pick object list. More... | |
Boolean_t | TecUtilPickAddAll (PickObjects_e ObjectType) |
Add all objects of a certain type to the pick list. More... | |
Boolean_t | TecUtilPickAddAllInRect (double X1, double Y1, double X2, double Y2, PickObjects_e ObjectType, const char *Filter) |
Add all objects defined within a specified rectangle to the pick list. More... | |
Boolean_t | TecUtilPickEdit (const char *Action) |
Perform a global edit operation on the currently picked objects. More... | |
Boolean_t | TecUtilPickCut (void) |
Copy all objects that are currently picked to the paste buffer and then delete them from the plot. More... | |
Boolean_t | TecUtilPickCopy (void) |
Copy all objects that are currently picked to the paste buffer. More... | |
Boolean_t | TecUtilPickClear (void) |
Clear (that is, delete) all objects that are currently picked. More... | |
Boolean_t | TecUtilPickPaste (void) |
Paste the currently picked objects from the paste buffer to the workspace. More... | |
Boolean_t | TecUtilPickShift (double DXPaper, double DYPaper, PointerStyle_e PointerStyle) |
Shift the currently picked objects. More... | |
Boolean_t | TecUtilPickMagnify (double MagFactor) |
Magnify all picked objects. More... | |
Boolean_t | TecUtilPickPush (void) |
Change the order in which objects are drawn by pushing the currently picked objects back. More... | |
Boolean_t | TecUtilPickPop (void) |
Change the order in which objects are drawn by popping the currently picked objects to the front. More... | |
Boolean_t | TecUtilPickSetMouseMode (MouseButtonMode_e MouseMode) |
Boolean_t | TecUtilXYMapCopy (EntIndex_t SourceMap, EntIndex_t DestMap) |
Boolean_t | TecUtilLineMapCopy (EntIndex_t SourceMap, EntIndex_t DestMap) |
Copy attributes from an existing Line-mapping to another. More... | |
Boolean_t | TecUtilXYMapCreate (void) |
Boolean_t | TecUtilLineMapCreate (void) |
Create a new Line-mapping. More... | |
Boolean_t | TecUtilXYMapDelete (Set_pa MapsToDelete) |
Boolean_t | TecUtilLineMapDelete (Set_pa MapsToDelete) |
Delete one or more Line-maps. More... | |
Boolean_t | TecUtilXYMapShiftToTop (Set_pa MapsToShift) |
Boolean_t | TecUtilLineMapShiftToTop (Set_pa MapsToShift) |
Shift a list of Line-maps to the top of the Line-map list. More... | |
Boolean_t | TecUtilXYMapShiftToBottom (Set_pa MapsToShift) |
Boolean_t | TecUtilLineMapShiftToBottom (Set_pa MapsToShift) |
Shift a list of Line-maps to the bottom of the Line-map list. More... | |
Boolean_t | TecUtilViewRotate (RotateAxis_e RotateAxis, double RotateAmountInDegrees) |
Boolean_t | TecUtilViewRotate3D (RotateAxis_e RotateAxis, double RotateAmountInDegrees, double VectorX, double VectorY, double VectorZ, RotateOriginLocation_e RotateOriginLocation) |
Do a 3-D rotation about a given axis. More... | |
Boolean_t | TecUtilReset3DOrigin (void) |
Reposition the rotation origin in 3-D to be at the centroid of the data. More... | |
Boolean_t | TecUtilSet3DEyeDistance (double EyeDistance) |
Sets the distance the viewer is from the plane that is parallel to the screen and passes through the 3-D rotation origin. More... | |
Boolean_t | TecUtilReset3DOriginX (ArgList_pa ArgList) |
Reposition the rotation origin in 3-D to the specified location. More... | |
Boolean_t | TecUtilResetVectorLength (void) |
Reset the length of the vectors. More... | |
Boolean_t | TecUtilContourLevelX (ArgList_pa ArgList) |
Modify the contour levels. More... | |
Boolean_t | TecUtilContourLevelAdd (int NumEntries, const double *RawData_Array, Boolean_t ShowTrace) |
Boolean_t | TecUtilContourLevelNew (int NumEntries, const double *RawData_Array, Boolean_t ShowTrace) |
Boolean_t | TecUtilContourLevelDeleteRange (double RangeMin, double RangeMax, Boolean_t ShowTrace) |
Boolean_t | TecUtilContourLevelReset (int NumEntries) |
Boolean_t | TecUtilContourLevelDelNearest (double Level, Boolean_t ShowTrace) |
Boolean_t | TecUtilContourLabelX (ArgList_pa ArgList) |
Manage labels in your plot. More... | |
Boolean_t | TecUtilContourLabelAdd (double X, double Y, double Z, Boolean_t IsAligned) |
Boolean_t | TecUtilContourLabelDeleteAll (void) |
Boolean_t | TecUtilStreamtraceAdd (int NumRakePoints, Streamtrace_e StreamType, StreamDir_e Direction, double StartXPos, double StartYPos, double StartZPos, double AltStartXPos, double AltStartYPos, double AltStartZPos) |
Add a single streamtrace or a rake of streamtraces to the current frame. More... | |
Boolean_t | TecUtilStreamtraceDeleteAll (void) |
Delete all streamtraces in the current frame. More... | |
Boolean_t | TecUtilStreamtraceDeleteRange (int Start, int End) |
Delete a range of streamtraces. More... | |
Boolean_t | TecUtilStreamtraceSetTermLine (int NumPoints, const double *XTermLinePts_Array, const double *YTermLinePts_Array) |
Set the position of the termination line for streamtraces. More... | |
Boolean_t | TecUtilStreamtraceResetDelta (void) |
Resets the time interval between stream markers. More... | |
int | TecUtilStreamtraceGetCount (void) |
Get the number of active streamtraces. More... | |
void | TecUtilStreamtraceGetPos (int StreamNumber, double *X, double *Y, double *Z) |
Get the starting position for a given streamtrace. More... | |
Boolean_t | TecUtilDataValueSetByZoneVar (EntIndex_t Zone, EntIndex_t Var, LgIndex_t PointIndex, double Value) |
Assign a value to a field variable at a specific position. More... | |
Boolean_t | TecUtilDataAlter (const char *Equation, Set_pa ZoneSet, LgIndex_t IMin, LgIndex_t IMax, LgIndex_t ISkip, LgIndex_t JMin, LgIndex_t JMax, LgIndex_t JSkip, LgIndex_t KMin, LgIndex_t KMax, LgIndex_t KSkip, FieldDataType_e DestDataType) |
Operates on a data set within Tecplot using FORTRAN-like equations. More... | |
Boolean_t | TecUtilSmooth (EntIndex_t Zone, EntIndex_t SmoothVar, LgIndex_t NumSmoothPasses, double SmoothWeight, BoundaryCondition_e SmoothBndryCond) |
Smooth data (that is, reduce the spikes) for selected variables in selected zones. More... | |
Boolean_t | TecUtilWriteCurveInfo (const char *FName, EntIndex_t XYMapNum, ProcessXYMode_e ProcessXYMode) |
Boolean_t | TecUtilCurveWriteInfo (const char *FileName, EntIndex_t LineMap, CurveInfoMode_e CurveInfoMode) |
Write out the coefficients or the calculated data points for the equation(s) used to draw the curve for a selected line-mapping. More... | |
Boolean_t | TecUtilZoneCopyX (ArgList_pa ArgList) |
Make a copy of a zone. More... | |
Boolean_t | TecUtilZoneCopy (EntIndex_t ZoneUsed, LgIndex_t IMin, LgIndex_t IMax, LgIndex_t ISkip, LgIndex_t JMin, LgIndex_t JMax, LgIndex_t JSkip, LgIndex_t KMin, LgIndex_t KMax, LgIndex_t KSkip) |
Make a copy of an existing zone. More... | |
Boolean_t | TecUtilCreateMirrorZones (Set_pa SourceZones, char MirrorVar) |
Create new zones that are mirror images of the source zones. More... | |
Boolean_t | TecUtilCreateStreamZones (Boolean_t ConcatenateStreams) |
Create one or more zones out of the currently defined streamtraces. More... | |
Boolean_t | TecUtilCreateIsoZones (void) |
Create finite element surface zones out of iso-surfaces in volume zones. More... | |
Boolean_t | TecUtilCreateSliceZones (void) |
Create surface zones out of all slices currently defined in volume zones. More... | |
Boolean_t | TecUtilCreateContourLineZones (void) |
Create zones from contour lines. More... | |
Boolean_t | TecUtilCreateContourLineZonesX (ArgList_pa ArgList) |
Create zones from contour lines. More... | |
Boolean_t | TecUtilCreateFEBoundary (EntIndex_t SourceZone, Boolean_t RemoveBlankedSurfaces) |
Zone boundaries for finite element data cannot be turned on or off using the boundary plot layer in Tecplot. More... | |
Boolean_t | TecUtilCreateSliceZone (double OriginX, double OriginY, double OriginZ, double NormalX, double NormalY, double NormalZ) |
Boolean_t | TecUtilCreateSliceZoneFromPlane (SliceSource_e SliceSource, double OriginX, double OriginY, double OriginZ, double NormalX, double NormalY, double NormalZ) |
Create a new zone as a slice through the currently active zones that match the specified slice source and are intersected by a slice plane having the specified origin and normal. More... | |
Boolean_t | TecUtilCreateSliceZoneFromPlneX (ArgList_pa ArgList) |
Create a zone from a slice taken from a 3D plot. More... | |
Boolean_t | TecUtilExtractFromPolyline (const double *PolylineXPts_Array, const double *PolylineYPts_Array, const double *PolylineZPts_Array, LgIndex_t NumPtsInPolyline, Boolean_t ExtractThroughVolume, Boolean_t ExtractOnlyPointsOnPolyline, Boolean_t IncludeDistanceVariable, LgIndex_t NumPtsToExtractAlongPolyline, Boolean_t ExtractToFile, const char *ExtractFName) |
Extract data from a 2-D or 3-D field plot. More... | |
Boolean_t | TecUtilExtractFromGeom (Boolean_t ExtractOnlyPointsOnPolyline, Boolean_t IncludeDistanceVariable, LgIndex_t NumPtsToExtractAlongPolyline, Boolean_t ExtractToFile, const char *ExtractFName) |
Extract data from a 2- or 3-D field plot. More... | |
Boolean_t | TecUtilPolarToRectangular (Set_pa ZoneSet) |
Boolean_t | TecUtilTransformCoordinatesX (ArgList_pa ArgList) |
Transform Coordinates. More... | |
Boolean_t | TecUtilRotate2D (Set_pa ZoneSet, double RotateAmountInDegrees, double XOrigin, double YOrigin) |
Boolean_t | TecUtilDataRotate2D (Set_pa ZoneSet, double RotateAmountInDegrees, double XOrigin, double YOrigin) |
Rotate field data in 2-D about any point. More... | |
Boolean_t | TecUtilAverageCellCenterData (Set_pa ZoneSet, Set_pa VarSet) |
Most plotting in Tecplot is based on using values at the corners (nodes) of each cell. More... | |
Boolean_t | TecUtilLinearInterpolate (Set_pa SourceZones, EntIndex_t DestZone, Set_pa VarList, double LinearInterpConst, LinearInterpMode_e LinearInterpMode) |
Interpolate selected variables from a set of source zones to a destination zone using linear interpolation. More... | |
Boolean_t | TecUtilInverseDistInterpolation (Set_pa SourceZones, EntIndex_t DestZone, Set_pa VarList, double InvDistExponent, double InvDistMinRadius, PtSelection_e InterpPtSelection, LgIndex_t InterpNPoints) |
Interpolate selected variables from one or more zones onto a destination zone using the inverse distance method. More... | |
Boolean_t | TecUtilKrig (Set_pa SourceZones, EntIndex_t DestZone, Set_pa VarList, double KrigRange, double KrigZeroValue, Drift_e KrigDrift, PtSelection_e InterpPtSelection, LgIndex_t InterpNPoints) |
Interpolate selected variables from a set of source zones to a destination zone using the kriging method. More... | |
Boolean_t | TecUtilTriangulate (Set_pa SourceZones, Boolean_t DoBoundary, Set_pa BoundaryZones, Boolean_t IncludeBoundaryPts, LgIndex_t *NumCoincidentPts, double TriangleKeepFactor) |
Create a new zone by forming triangles from data points in existing zones. More... | |
Boolean_t | TecUtilAnimateZonesX (ArgList_pa ArgList) |
Animate zones. More... | |
Boolean_t | TecUtilAnimateXYMapsX (ArgList_pa ArgList) |
Boolean_t | TecUtilAnimateLineMapsX (ArgList_pa ArgList) |
Animate Line-mapping. More... | |
Boolean_t | TecUtilAnimateContourLevelsX (ArgList_pa ArgList) |
Animate contour levels. More... | |
Boolean_t | TecUtilAnimateIJKPlanesX (ArgList_pa ArgList) |
Animate I-, J-, or K-planes. More... | |
Boolean_t | TecUtilAnimateIJKBlankingX (ArgList_pa ArgList) |
Animate IJK-blanking. More... | |
Boolean_t | TecUtilAnimateStreamX (ArgList_pa ArgList) |
Animate streamtraces. More... | |
Boolean_t | TecUtilAnimateSlicesX (ArgList_pa ArgList) |
Animates slices. More... | |
Boolean_t | TecUtilAnimateZones (EntIndex_t StartZone, EntIndex_t EndZone, EntIndex_t ZoneSkip, Boolean_t CreateMovieFile, const char *MovieFName) |
Produce an animation showing one zone at a time. More... | |
Boolean_t | TecUtilAnimateXYMaps (EntIndex_t StartMap, EntIndex_t EndMap, EntIndex_t MapSkip, Boolean_t CreateMovieFile, const char *MovieFName) |
Boolean_t | TecUtilAnimateContourLevels (SmInteger_t StartLevel, SmInteger_t EndLevel, SmInteger_t LevelSkip, Boolean_t CreateMovieFile, const char *MovieFName) |
Produce an animation of a contour line plot by showing a single level at a time. More... | |
Boolean_t | TecUtilAnimateIJKPlanes (char IJOrK, LgIndex_t StartIndex, LgIndex_t EndIndex, LgIndex_t IndexSkip, Boolean_t CreateMovieFile, const char *MovieFName) |
Produce an animation that cycles through I-, J-, or K-planes in an IJK-ordered data set. More... | |
Boolean_t | TecUtilAnimateIJKBlanking (double StartIMinFract, double StartJMinFract, double StartKMinFract, double StartIMaxFract, double StartJMaxFract, double StartKMaxFract, double EndIMinFract, double EndJMinFract, double EndKMinFract, double EndIMaxFract, double EndJMaxFract, double EndKMaxFract, int NumSteps, Boolean_t CreateMovieFile, const char *MovieFName) |
Produce an animation of different IJK-blankings in your plot. More... | |
Boolean_t | TecUtilAnimateStream (int NumStepsPerCycle, int NumCycles, Boolean_t CreateMovieFile, const char *MovieFName) |
Produce an animation of stream markers or dashes, moving along the currently defined streamtrace paths. More... | |
Boolean_t | TecUtilAnimateSlices (SmInteger_t StartSlice, SmInteger_t EndSlice, SmInteger_t NumSlices, Boolean_t CreateMovieFile, const char *MovieFName) |
Animates the currently defined 3-D slices. More... | |
Boolean_t | TecUtilDelay (LgIndex_t Seconds) |
Delay Tecplot execution for a specified time. More... | |
Boolean_t | TecUtilMacroRunFunction (const char *QuickMacroName, const char *MacroParameters) |
Run a macro function. More... | |
Boolean_t | TecUtilDataSetSetTitle (const char *DataSetTitle) |
Set the title for the current data set. More... | |
Boolean_t | TecUtilVarRename (EntIndex_t VarNum, const char *VarName) |
Rename a data set variable in Tecplot. More... | |
Boolean_t | TecUtilZoneRename (EntIndex_t Zone, const char *ZoneName) |
Rename a data set zone in Tecplot. More... | |
Boolean_t | TecUtilSystem (const char *Command, Boolean_t Wait) |
Instruct Tecplot to submit and execute an operating system specific command. More... | |
Boolean_t | TecUtilMacroPanelAddTitle (const char *Title) |
Add a title to a page in the Quick Macro Panel. More... | |
Boolean_t | TecUtilDialogLaunch (Dialog_e DialogToLaunch) |
Launch a Tecplot interface dialog. More... | |
Boolean_t | TecUtilDialogDrop (Dialog_e DialogToDrop) |
Drop a Tecplot interface dialog. More... | |
Boolean_t | TecUtilMacroRunFile (const char *FName) |
Run a macro file. More... | |
void | TecUtilAddOnAllowUnload (AddOn_pa AddOnID, Boolean_t DoAllowUnload) |
Enable (or disable) unloading of an addon on Tecplot exit. More... | |
Boolean_t | TecUtilAddOnLoad (const char *LibName, const char *InitFunctionName, LibraryType_e AddOnType) |
Load an addon into Tecplot. More... | |
Boolean_t | TecUtilExportIsRecording (void) |
Checks to see if Tecplot is currently recording an animation. More... | |
Boolean_t | TecUtilExportFinish (void) |
This function assembles all of the exported animation frames into the final animation file. More... | |
Boolean_t | TecUtilExportStart (void) |
This functions starts a new animation and exports the first frame. More... | |
Boolean_t | TecUtilExportNextFrame (void) |
Export the next frame of a movie animation. More... | |
void | TecUtilExportCancel (void) |
Cancel a movie export which is in progress. More... | |
void | TecUtilThreeDViewGetViewerAngle (double *PsiAngle, double *ThetaAngle, double *AlphaAngle) |
Queries the 3-D viewer angles. More... | |
void | TecUtilThreeDViewGetViewerPos (double *XPos, double *YPos, double *ZPos) |
Queries the 3-D viewer angles. More... | |
void | TecUtilThreeDViewGetProjection (double *FieldOfView, double *ViewWidth, Boolean_t *IsInPerspective) |
Queries the 3-D view attributes. More... | |
void | TecUtilConvert3DPositionToGrid (double XPosition, double YPosition, double ZPosition, double *XGridPosition, double *YGridPosition, double *ZGridPosition) |
Converts from 3-D world coordinates to Tecplot's 3-D grid coordinates. More... | |
double | TecUtilThreeDViewGetNearZPlane (void) |
Returns the Z-value below which you can no longer trust any values of TecUtilConvert3DPositionToGrid(). More... | |
double | TecUtil3DViewGetNearZPlane (void) |
void | TecUtilSetupTransformations (void) |
Initializes transformation information so that coordinate conversion functions can be used. More... | |
void | TecUtilFrameLightweightPopStart (void) |
Initialize lightweight frame pop. More... | |
Boolean_t | TecUtilFrameLightweightPopNext (void) |
Pop the next frame. More... | |
void | TecUtilFrameLightweightPopEnd (void) |
Ends a sequence of lightweight frame pops. More... | |
Boolean_t | TecUtilImageRGBBitmapCreate (BitDumpRegion_e Region) |
Call this function to initialize the export state if you are exporting using the RGB functions. More... | |
Boolean_t | TecUtilImageIndexedBitmapCreate (BitDumpRegion_e Region, short *RedColorTable_Array, short *GreenColorTable_Array, short *BlueColorTable_Array) |
Call this function to initialize the export state if you are exporting using the index functions. More... | |
void | TecUtilImageBitmapDestroy (void) |
Destroy the bitmap buffer. More... | |
Boolean_t | TecUtilImageGetDimensions (short *Width, short *Height) |
Gets the image dimensions. More... | |
Boolean_t | TecUtilImageRGBGetScanLine (short ScanLine, short *Red_Array, short *Green_Array, short *Blue_Array) |
Gets the RGB values of a scan line. More... | |
Boolean_t | TecUtilImageIndexedGetScanLine (short ScanLine, short *RGBIndex_Array) |
Gets the color table indices for a scan line. More... | |
void | TecUtilImageGetColorTable (Byte_t *Red_Array, Byte_t *Green_Array, Byte_t *Blue_Array) |
Get the color table, that is, the palette, of a color-reduced image. More... | |
Boolean_t | TecUtilImageBitmapCreateX (ArgList_pa ArgList) |
Create a true color or color-reduced bitmap of a specified width. More... |
|
|
|
|
|
Enable (or disable) unloading of an addon on Tecplot exit.
SUBROUTINE TecUtilAddOnAllowUnload( Do not unload the addon.
TecUtilAddOnAllowUnload(AddonID,FALSE); |
|
Load an addon into Tecplot.
INTEGER*4 FUNCTION TecUtilAddOnLoad( To load the addon cstream use:
if (!TecTuilAddOnLoad("cstream", NULL, LibraryType_V7Standard)) { / * failed to load cstream addon * / } |
|
Produce an animation of a contour line plot by showing a single level at a time. The animation varies according to the currently defined contour levels.
INTEGER*4 FUNCTION TecUtilAnimateContourLevels( Animate contour levels 1-10:
TecUtilAnimateContourLevels(1,10,1,FALSE,(char *)NULL); |
|
Animate contour levels.
INTEGER*4 FUNCTION TecUtilAnimateContourLevelsX(ArgListPtr) Animate contour levels 1-10. Write the results to an AVI file named animc.avi.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc() TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t)ExportFormat_AVI); TecUtilArgListAppendInt(ArgList, SV_FNAME, "animc.avi"); TecUtilArgListAppendInt(ArgList, SV_START, 1); TecUtilArgListAppendInt(ArgList, SV_END, 10); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); IsOk = TecUtilAnimateContourLevelsX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Produce an animation of different IJK-blankings in your plot. The animation starts at one IJK-blanking setting and marches through intermediate steps to a second setting.
INTEGER*4 FUNCTION TecUtilAnimateIJKBlanking( Produce an animation showing a band of I-planes traversing the entire data field using six steps:
TecUtilAnimateIJKBlanking(0.1,0.0,0.0, 1.0,1.0,1.0, 1.0,0.0,0.0, 1.0,1.0,1.0, 6, FALSE, (char *)NULL); |
|
Animate IJK-blanking.
INTEGER*4 FUNCTION TecUtilAnimateIJKBlankingX(ArgListPtr) Animate IJK-blanking starting with fractions 0, 0.1, 0.1 (the defaults) for the minimum fractions, 1.0, 1.0, 1.0 for the maximum fractions. End with 0.7, 0.7, 0.7 for the minimum fractions and 0.75, 0.75, 0.75 for the maximum fractions. Do animation in ten steps.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t)ExportFormat_RM); TecUtilArgListAppendInt (ArgList, SV_FName, "IJKBlanking.rm"); TecUtilArgListAppendDouble(ArgList, SV_IMAXFRACT, 1.0); TecUtilArgListAppendDouble(ArgList, SV_JMAXFRACT, 1.0); TecUtilArgListAppendDouble(ArgList, SV_KMAXFRACT, 1.0); TecUtilArgListAppendDouble(ArgList, SV_IMINFRACT2, 0.7); TecUtilArgListAppendDouble(ArgList, SV_JMINFRACT2, 0.7); TecUtilArgListAppendDouble(ArgList, SV_KMINFRACT2, 0.7); TecUtilArgListAppendDouble(ArgList, SV_IMAXFRACT2, 0.75); TecUtilArgListAppendDouble(ArgList, SV_JMAXFRACT2, 0.75); TecUtilArgListAppendDouble(ArgList, SV_KMAXFRACT2, 0.75); TecUtilArgListAppendInt(ArgList, SV_NUMSTEPS, 10); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); TecUtilAnimateIJKBlankingX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Produce an animation that cycles through I-, J-, or K-planes in an IJK-ordered data set.
INTEGER*4 FUNCTION TecUtilAnimateIJKPlanes( Produce an animation that shows every other J-plane from J=1 to J=11:
TecUtilAnimateIJKPlanes('J', 1, / * Start at J=1 * / 11, / * End at J=11 * / 2, / * Skip every other J-Plane * / FALSE, (char *)NULL); |
|
Animate I-, J-, or K-planes.
INTEGER*4 FUNCTION TecUtilAnimateIJKPlanesX(ArgListPtr) Animate J-planes 5-10.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t, ExportFormat_AVI); TecUtilArgListAppendInt (ArgList, SV_FNAME, "IJKPlanes.avi"); TecUtilArgListAppendInt(ArgList, SV_START, 5); TecUtilArgListAppendInt(ArgList, SV_END, 10); TecUtilArgListAppendInt(ArgList, SV_SKIP, 1); TecUtilArgListAppendInt(ArgList, SV_PLANES, (LgIndex_t)'J'); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); TecUtilAnimateIJKPlanesX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Animate Line-mapping.
INTEGER*4 FUNCTION TecUtilAnimateLineMapsX(ArgListPtr) Animate Line-maps 5-10. Write the results to an AVI file named Animxy.avi.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t, ExportFormat_AVI); TecUtilArgListAppendInt (ArgList, SV_FNAME, "Animxy.avi"); TecUtilArgListAppendInt(ArgList, SV_START, 5); TecUtilArgListAppendInt(ArgList, SV_END, 10); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); IsOk = TecUtilAnimateLineMapsX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Animates the currently defined 3-D slices.
INTEGER*4 FUNCTION TecUtilAnimateSlices( Animate 50 slices, using the currently defined Slice 1 and Slice 2 positions as the beginning and end of the animation. Send the animation to a movie file.
SmInteger_t NumSlices = 50; TecUtilAnimateSlices(1, NumSlices, NumSlices, TRUE, "SliceAnimation.rm"); |
|
Animates slices.
INTEGER*4 FUNCTION TecUtilAnimateSlicesX(ArgListPtr) Animate 50 slices, using the currently defined Slice 1 and Slice 2 positions as the beginning and end of the animation. Send the animation to a movie file.Boolean_t IsOk = TRUE;
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t) ExportFormat_AVI); TecUtilArgListAppendInt (ArgList, SV_FNAME, "AnimateSlice.avi"); TecUtilArgListAppendInt(ArgList, SV_START, 1); TecUtilArgListAppendInt(ArgList, SV_END, 50); TecUtilArgListAppendInt(ArgList, SV_NUMSLICES, 50); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); IsOk = TecUtilAnimateSlicesX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Produce an animation of stream markers or dashes, moving along the currently defined streamtrace paths.
INTEGER*4 FUNCTION TecUtilAnimateStream( Animate streamtraces for three cycles with each cycle using 20 steps:
TecUtilAnimateStream(20,3,FALSE,(char *)NULL); |
|
Animate streamtraces.
INTEGER*4 FUNCTION TecUtilAnimateStreamX(ArgListPtr) Make an animation with two cycles and ten steps per cycle. Create an AVI movie file.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t, ExportFormat_AVI); TecUtilArgListAppendInt (ArgList, SV_FNAME, "Stream.avi"); TecUtilArgListAppendInt(ArgList, SV_NUMCYCLES, 2); TecUtilArgListAppendInt(ArgList, SV_STEPSPERCYCLE, 10); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); TecUtilAnimateStreamX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
|
|
|
|
Produce an animation showing one zone at a time.
INTEGER*4 FUNCTION TecUtilAnimateZones( Create an animation showing (in sequence) zones 2, 4, 6, 8, and 10:
TecUtilAnimateZones(2, 10, 2, FALSE, NULL); |
|
Animate zones.
INTEGER*4 FUNCTION TecUtilAnimateZonesX(ArgListPtr) Animate zones 1-10. Write the results to an AVI file named Animzones.avi.
ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_EXPORTFORMAT, (LgIndex_t) ExportFormat_AVI); TecUtilArgListAppendInt (ArgList, SV_FNAME, "Animzones.avi."); TecUtilArgListAppendInt(ArgList, SV_START, 1); TecUtilArgListAppendInt(ArgList, SV_END, 10); TecUtilArgListAppendInt(ArgList, SV_CREATEMOVIEFILE, TRUE); IsOk = TecUtilAnimateZonesX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Allocate an argument list. Argument lists are used with all of the "X" (extended) functions in Tecplot.
SUBROUTINE TecUtilArgListAlloc(ResultPtr) |
|
Append an ArbParam_t type parameter to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendArbParam( |
|
Appends an ArbParam_t pointer parameter to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendArbParamPtr( |
|
Appends a named array to the argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendArray( |
|
Append a double parameter to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendDouble( |
|
Appends a double pointer parameter to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendDoublePtr( See TecUtilStyleGetLowLevelX for a complete example. |
|
Append a named function pointer to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendFunction( |
|
Append an integer parameter to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendInt( |
|
Append a named set to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendSet( |
|
Append a string to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendString( |
|
Append a named string list to an argument list.
INTEGER*4 FUNCTION TecUtilArgListAppendStringList( |
|
Clear all arguments from an argument list.
SUBROUTINE TecUtilArgListClear(ArgListPtr) |
|
Deallocate an argument list.
SUBROUTINE TecUtilArgListDealloc(ArgListPtr) |
|
Most plotting in Tecplot is based on using values at the corners (nodes) of each cell.
If you have some field values that are cell-centered then you need a way to interpolate those values to cell corners. TecUtilAverageCellCenterData is used to interpolate cell centered data in IJ- or IJK-ordered datasets from the cell-center to the nodes. This same objective can be accomplished by using one of the interpolation options in Tecplot but that is usually more involved and requires more processing time. In preparation for using this function, you must:
If your objective is only to view a flooded contour plot where each cell is filled with a single color representing the cell-centered value, then do steps 1 and 2 above and set the contour plot type to Corner. Only call this routine if the current frame is in 2D or 3D frame mode.
INTEGER*4 FUNCTION TecUtilAverageCellCenterData( Average the cell-centered values for variables 4, 7, 8, and 9 in zones 1-3:
if (TecUtilFrameGetMode() == Frame_TwoD || TecUtilFrameGetMode() == Frame_ThreeD) { Set_pa ZoneSet; Set_pa VarSet; Boolean_t IsOk = FALSE; ZoneSet = TecUtilSetAlloc(TRUE); VarSet = TecUtilSetAlloc(TRUE); if (ZoneSet && VarSet) { TecUtilSetAddMember(ZoneSet,1,TRUE); TecUtilSetAddMember(ZoneSet,2,TRUE); TecUtilSetAddMember(ZoneSet,3,TRUE); TecUtilSetAddMember(VarSet,4,TRUE); TecUtilSetAddMember(VarSet,7,TRUE); TecUtilSetAddMember(VarSet,8,TRUE); TecUtilSetAddMember(VarSet,9,TRUE); IsOk = TecUtilAverageCellCenterData(ZoneSet,VarSet); TecUtilSetDealloc(&ZoneSet); TecUtilSetDealloc(&VarSet); } } |
|
Preset either the user-defined color map or the raw user-defined color map to be a copy of one of the standard color maps. Tecplot must currently be using either the user-defined color map or the raw user-defined color map in order to use the function.
INTEGER*4 FUNCTION TecUtilColorMapCopyStandard(ColorMap) Reset the user-defined color map to be a copy of the modern color map.
|
|
Redistribute the control points for the currently active color map so they are evenly spaced across the color spectrum. This is equivalent to clicking Redistribute Control Points in the Workspace/Color Map dialog. Note that this does not change the RGB values assigned at each control point.
INTEGER*4 FUNCTION TecUtilColorMapRedistControlPts() |
|
Redistribute the control points and reset the RGB values for the currently active color map. This is equivalent to clicking Reset on the Workspace/ColorMap dialog.
INTEGER*4 FUNCTION TecUtilColorMapResetToFactory() |
|
|
|
|
|
Manage labels in your plot.
INTEGER*4 FUNCTION TecUtilContourLabelX(ArgListPtr) Add a contour label at position (0.5, 0.25) in a 2-D plot. Make it align itself to the nearest contour line.
ArgList_pa ArgList; TecUtilLockStart(AddOnID) ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_LABELOP, ComtourLabelAction_Add); TecUtilArgListAppendDouble(ArgList, SV_X, 2); TecUtilArgListAppendDouble(ArgList, SV_Y, 2); TecUtilArgListAppendDouble(ArgList, SV_Z, 2); TecUtilArgListAppendInt(ArgList, SV_ISALIGNED, TRUE); TecUtilContourLabelX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
|
|
|
|
|
|
|
|
|
|
Modify the contour levels.
INTEGER*4 FUNCTION TecUtilContourLevelX(ArgListPtr) Add contour levels 0.1, 0.2, and 0.3 to the current set of contour levels for contour group 2:
Boolean_t IsOk = TRUE; ArgList_pa ArgList; double levels[3] = {0.1, 0.2, 0.3}; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt (ArgList, SV_LEVELOP, (LgIndex_t) ContourLevelAction_Add); TecUtilArgListAppendInt (ArgList, SV_CONTOURGROUP, 2); TecUtilArgListAppendInt(ArgList, SV_NUMVALUES, 3); TecUtilArgListAppendArray(ArgList, SV_RAWDATA, (void *)levels); IsOk = TecUtilContourLevelX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Converts from 3-D world coordinates to Tecplot's 3-D grid coordinates. Note that these 3-D grid coordinates are only to be used for zoom and 2-D grid mode text and geometries in 3-D. Converted grid coordinates should be used immediately. This transformation may change in future versions of Tecplot. You must call TecUtilSetupTransformations() before calling this function, although TecUtilSetupTransformations() need only be called once for each sequence of calls to TecUtilConvert3DPositionToGrid().
SUBROUTINE TecUtilConvert3DPositionToGrid( Convert from 3-D world coordinates to Tecplot's 3-D grid coordinates.
{ double ZPlaneFloor; double X,Y,Z; TecUtilLockStart(AddOnID); TecUtilSetupTransformations(); ZPlaneFloor = TecUtil3DViewGetNearZPlane(); TecUtilConvert3DPositionToGrid(1.0,1.0,ZPlaneFloor,&X,&Y,&Z); TecUtilLockFinish(AddOnID); } |
|
Create a circular (or cylindrical) IJ- or IJK-ordered zone. If no data set exists when this command is executed, a data set is created with variables X, Y (and Z, if KMAX>1). If a data set exists prior to this command, the non-coordinate variables for the zone created are initialized to zero.
INTEGER*4 FUNCTION TecUtilCreateCircularZone( Create a circular 10 by 20 IJ-ordered zone centered at (5, 5) with a radius of two:
Boolean_t IsOk; IsOk = TecUtilCreateCircularZone(10,20,1, 5.0,5.0,2.0, 0.0,0.0, FieldDataType_Float); IsOk = TecUtilCreateCircularZone(5,6,8, 4.0,4.0,3.0, 0.0,7.0, FieldDataType_Float); Create a cylindrical 5 by 6 by 8 IJK-ordered zone with the bottom centered at (4, 4, 0) and the top centered at (4, 4, 7) and a radius of three:
IsOk = TecUtilCreateCircularZone(5,6,8, 4.0,4.0,3.0, 0.0,7.0, FieldDataType_Float); |
|
Create zones from contour lines. Contour lines will only come from those zones with a contour style set to contour lines or lines and flood. One zone will be made from each contour level. The resulting zones are of type FE-Triangle.
INTEGER*4 FUNCTION TecUtilCreateContourLineZones() |
|
Create zones from contour lines.
INTEGER*4 FUNCTION TecUtilCreateContourLineZonesX(ArgListPtr) ArgList_pa ArgList;
TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_CONTLINECREATEMODE, (LgIndex_t)ContLineCreateMode_OneZonePerContourLevel); TecUtilCreateContourLineZonesX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Zone boundaries for finite element data cannot be turned on or off using the boundary plot layer in Tecplot. You can, however, create a separate zone which is the boundary of a finite-element zone. This new zone can then be turned on or off. One requirement for this function to work correctly is that adjacent cells must share the same node points along their common boundary.
INTEGER*4 FUNCTION TecUtilCreateFEBoundary( Create a separate zone which is the boundary of the first zone:
TecUtilCreateFEBoundary(1,TRUE); / * zone 1 must be finite element * / |
|
Create finite element surface zones out of iso-surfaces in volume zones. One zone will be made for each contour level.
INTEGER*4 FUNCTION TecUtilCreateIsoZones() |
|
Create new zones that are mirror images of the source zones.
INTEGER*4 FUNCTION TecUtilCreateMirrorZones( Create two mirror zones about the X-axis:
Set_pa set = TecUtilSetAlloc(FALSE); if (set) { TecUtilSetAddMember(set,1,FALSE); / * mirror zones 1 and 2 * / TecUtilSetAddMember(set,2,FALSE); TecUtilCreateMirrorZones(set,'X'); TecUtilSetDealloc(&set); } |
|
Create a rectangular zone. If no data set exists when this command is executed, a data set is created with variables X, Y (and Z, if KMAX>1). If a data set exists prior to this command, the non-coordinate variables for the zone created are initialized to zero.
INTEGER*4 FUNCTION TecUtilCreateRectangularZone( Create a 16 by 8 by 2 zone that is specified from zero to one in all directions:
Boolean_t ISOK; ISOK = TecUtilCreateRectangularZone(16, / * imax * / 8, / * jmax * / 2, / * kmax * / 0,0,0, / * x,y,z min * / 1,1,1, / * x,y,z max * / FieldDataType_Float); FORTRAN EXAMPLE: Create 10x10x10 zone:
IErr = TecUtilCreateRectangularZone(10,10,10, & 0.0D0,0.0D0,0.0D0, & 1.0D0,1.0D0,1.0D0, & |
|
|
|
Create a new zone by specifying only a list of XY pairs of data. If other zones exist prior to using this function and there are more than two variables, then the additional variables are also created and set to zero.
INTEGER*4 FUNCTION TecUtilCreateSimpleZone( Create a zone containing three points: (0.0, 1.0), (1.0, 1.1), and (2.0, 1.3):
double xarray[3] = {0.0, 1.0, 2.0}; double yarray[3] = {1.0, 1.1, 1.3); Boolean_t IsOk; IsOk = TecUtilCreateSimpleZone(3, xarray, yarray, FieldDataType_Float); |
|
|
|
Create a new zone as a slice through the currently active zones that match the specified slice source and are intersected by a slice plane having the specified origin and normal.
INTEGER*4 FUNCTION TecUtilCreateSliceZoneFromPlane( Slice 3-D volume zones with a the plane X=2.5:
TecUtilCreateSliceZoneFromPlane(SliceSource_VolumeZones, 2.5, 0., 0., 1., 0., 0.); |
|
Create a zone from a slice taken from a 3D plot.
INTEGER*4 FUNCTION TecUtilCreateSliceZoneFromPlneX(ArgListPtr) ArgList_pa ArgList;
TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_SLICESOURCE, (LgIndex_t)SliceSource_SurfaceZones); TecUtilArgListAppendInt(ArgList, SV_FORCEEXTRACTIONTOSINGLEZONE, (LgIndex_t)TRUE); TecUtilArgListAppendDouble(ArgList, SV_ORIGINX,0.0); TecUtilArgListAppendDouble(ArgList, SV_ORIGINY,0.0); TecUtilArgListAppendDouble(ArgList, SV_ORIGINZ,0.0); TecUtilArgListAppendDouble(ArgList, SV_NORMALX,0.9); TecUtilArgListAppendDouble(ArgList, SV_NORMALY,0.9); TecUtilArgListAppendDouble(ArgList, SV_NORMALZ,0.9); TecUtilCreateSliceZoneFromPlneX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Create surface zones out of all slices currently defined in volume zones. One zone is made for each defined slice.
INTEGER*4 FUNCTION TecUtilCreateSliceZones() |
|
Create one or more zones out of the currently defined streamtraces. The new zones have the same number of variables per data point as the other zones in the data set with all non-coordinate variables interpolated at the positions along the streamtrace.
INTEGER*4 FUNCTION TecUtilCreateStreamZones(ConcatenateStreams) |
|
Write out the coefficients or the calculated data points for the equation(s) used to draw the curve for a selected line-mapping.
INTEGER*4 FUNCTION TecUtilCurveWriteInfo( Write out the coefficients for line-mapping number 3 to the file map3.out:
Boolean_t IsOk = TRUE; IsOk = TecUtilCurveWriteInfo("map3.out", 3,CurveInfoMode_Coefficients); |
|
Operates on a data set within Tecplot using FORTRAN-like equations. See Section 8.2, "Data Alteration through Equations," in the Tecplot User's Manual for more information on using equations in Tecplot.
INTEGER*4 FUNCTION TecUtilDataAlter( Add 2 to X in zones 1 and 3. Operate only data points where J is greater than or equal to three and less than or equal to ten:
if (TecUtilDataSetIsAvailable()) { Set_pa ZoneSet; Boolean_t IsOk = FALSE; ZoneSet = TecUtilSetAlloc(TRUE); if (ZoneSet) { TecUtilSetAddMember(ZoneSet,1); TecUtilSetAddMember(ZoneSet,3); IsOk = TecUtilDataAlter("X = X + 2", ZoneSet, 1,0,1, / * All I-Values * / 3,10,1 / * 3 <= J <= 10 * / 1,0,1, / * All K Values * / FieldDataType_Float); TecUtilSetDealloc(&ZoneSet); } } |
|
Rotate field data in 2-D about any point.
INTEGER*4 FUNCTION TecUtilDataRotate2D( |
|
Deletes the specified set of variables.
INTEGER*4 FUNCTION TecUtilDataSetDeleteVar(VarListPtr) |
|
Deletes the specified set of zones.
INTEGER*4 FUNCTION TecUtilDataSetDeleteZone(ZoneListPtr) |
|
Read one or more data files into Tecplot to form a new data set in the current frame.
INTEGER*4 FUNCTION TecUtilDataSetReadX(ArgListPtr) Read in a dataset. Note that some arglist entries are shown here using their default values as an example only as they normally would not have to be provided. char tstring[500]; ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); strcpy (tstring,"."); #ifdef MSWIN strcat (tstring, "\\"); #else strcat (tstring, "/"); #endif strcat (tstring, "d5.plk"); TecUtilArgListAppendInt(ArgList, SV_READATAOPTION, ReadDataOption_NewData); TecUtilArgListAppendInt(ArgList, SV_RESETSTYLE, TRUE); TecUtilArgListAppendStringList(ArgList,SV_FILENAMESORINSTRUCTIONS, tstring); TecUtilArgListAppendInt(ArgList, SV_INITIALPLOTFIRSTZONEONLY,FALSE); TecUtilArgListAppendInt(ArgList, SV_INITAILPLOTTYPE,PlotType_Automatic); TecUtilArgListAppendInt(ArgList, SV_INCUDETEXT, TRUE); TecUtilArgListAppendInt(ArgList, SV_INCLUDEGEOM, TRUE); TecUtilArgListAppendInt(ArgList, SV_INCLUDECUSTOMLABLES, TRUE); TecUtilArgListAppendInt(ArgList, SV_INCLUDEDATA, TRUE); TecUtilArgListAppendInt(ArgList, SV_COLLAPSEZONESANDVARS, FALSE); TecUtilArgListAppendInt(ArgList, SV_ZONELIST, NULL); TecUtilArgListAppendInt(ArgList, SV_VARLOADMODE, VarLoadMode_ByPosition); TecUtilArgListAppendArray(ArgList, SV_VARPOSITIONLIST,NULL); TecUtilArgListAppendStringList(ArgList,SV_VARNAMELIST, NULL); TecUtilArgListAppendInt(ArgList, SV_ISKIP, 1); TecUtilArgListAppendInt(ArgList, SV_JSKIP, 1); TecUtilArgListAppendInt(ArgList, SV_KSKIP, 1); TecUtilDataSetReadX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Set the title for the current data set.
INTEGER*4 FUNCTION TecUtilDataSetSetTitle(DataSetTitle) Set the current frame's data set title to be "Tecplot Data Set #1":
TecUtilDataSetSetTitle("Tecplot Data Set #1"); |
|
Write the specified components of the current frame's data set to a file.
INTEGER*4 FUNCTION TecUtilDataSetWriteX(ArgListPtr) |
|
Assign a value to a field variable at a specific position. This function does not require you to obtain the handle to the field data as does TecUtilDataValueSetByRef, however this function is not very efficient. Use TecUtilDataValueSetByRef if you are setting multiple values in the same zone. If the zone referenced is IJ- or IJK-ordered then the position is calculated by treating the two- or three-dimensional array as a one-dimensional array. TecUtilStateChanged need not be called after changing data in this way since Tecplot will handle that for you.
INTEGER*4 FUNCTION TecUtilDataValueSetByZoneVar( Set the first value of the second variable of zone 5 to be 0.0.
TecUtilDataValueSetByZoneVar(5, 2, 1, 0.0); |
|
Delay Tecplot execution for a specified time.
INTEGER*4 FUNCTION TecUtilDelay(Seconds) |
|
Drop a Tecplot interface dialog.
INTEGER*4 FUNCTION TecUtilDialogDrop(DialogToDrop) Drop the Color Map dialog:
|
|
Launch a Tecplot interface dialog.
INTEGER*4 FUNCTION TecUtilDialogLaunch(DialogToLaunch) Launch the Color Map dialog: |
|
Implements a double buffer action as described below by the DoubleBufferAction parameter definitions.
INTEGER*4 FUNCTION TecUtilDoubleBuffer(DoubleBufferAction) |
|
Turn on or off all graphics drawing.
INTEGER*4 FUNCTION TecUtilDrawGraphics(DoDrawing) |
|
Export an image file from Tecplot. See TecUtilExportSetup for details on settup the exported image type, file name and so forth.
INTEGER*4 FUNCTION TecUtilExport(Append) |
|
Cancel a movie export which is in progress. This function is only valid after you have called TecUtilExportStart() but before you have called TecUtilExportFinish(). It ensures that any resources used by the animation are properly released and that no partial files are created or left on the user's drive.
SUBROUTINE TecUtilExportCancel() |
|
This function assembles all of the exported animation frames into the final animation file. Note that the final *.avi or *.rm file is not created until you call this function. This function will assert if there is no current animation.
INTEGER*4 FUNCTION TecUtilExportFinish() |
|
Checks to see if Tecplot is currently recording an animation.
INTEGER*4 FUNCTION TecUtilExportIsRecording() |
|
Export the next frame of a movie animation.
INTEGER*4 FUNCTION TecUtilExportNextFrame() |
|
This functions starts a new animation and exports the first frame. Use TecUtilExportIsRecording to make sure an export session is not in progress before calling this function.
INTEGER*4 FUNCTION TecUtilExportStart()
This example makes use of the following export functions:
This example may be used as a template when creating an animation routine. { int ii; Boolean_t IsOk; TecUtilLockStart(AddOnID); / * Make sure there is no current export session before starting a new one. * / if ( TecUtilExportIsRecording() ) { TecUtilDialogErrMsg("An export session is alread in progress."); IsOk = FALSE; } else { / * Setup the export format and the file name. * / TecUtilExportSetup(SV_EXPORTFNAME, NULL, 0.0, (ArbParam_t)"export.avi"); TecUtilExportSetup(SV_EXPORTFORMAT, NULL, 0.0, (ArbParam_t)ExportFormat_AVI); / * Start the export session. * / IsOk = TecUtilExportStart(); } if ( IsOk ) { for (ii=0; ii<4; ii++) { / * Rotate the plot around the PSI axis by 5 degrees. * / IsOk = TecUtilViewRotate3D(RotateAxis_Psi, 5.0, 0.0, 0.0, 0.0, RotateOriginLocation_DefinedOrigin); / * Export the new image. * / if ( IsOk ) { IsOk = TecUtilExportNextFrame(); } / * * If the rotation or the exporting of the next frame * was not sucessful, abandon the export session. * / if ( !IsOk ) { TecUtilExportCancel(); break; } } } / * * If everything was successful, finish the export session. * / if ( IsOk ) IsOk = TecUtilExportFinish(); if ( !IsOk ) TecUtilDialogErrMsg("Error exporting, file may not be complete."); TecUtilLockFinish(AddOnID); } |
|
Extract data from a 2- or 3-D field plot. The locations at which to extract the data come from a polyline geometry that must be picked prior to issuing this command.
INTEGER*4 FUNCTION TecUtilExtractFromGeom( Extract 20 points from along the currently picked geometry. Send the result to a file called "extract.dat":
TecUtilExtractFromGeom(FALSE,FALSE,20,TRUE,"extract.dat"); |
|
Extract data from a 2-D or 3-D field plot.
INTEGER*4 FUNCTION TecUtilExtractFromPolyline( Extract ten points from specific locations in a field plot. Create a zone with the extracted data:
/ * raw data * / double X[10] = { 0, 1, 2, 3, 3, 4, 4, 3, 4, 5 }; double Y[10] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }; double Z[10] = { 4, 3, 2, 5, 3, 1, 2, 3, 4, 3 }; TecUtilExtractFromPolyline(X,Y,Z,10, TRUE,TRUE,FALSE,10,FALSE,NULL); |
|
Creates a new frame.
INTEGER*4 FUNCTION TecUtilFrameCreateNew( Create two new frames:
// let Tecplot position the frame Boolean_t IsOk1 = TecUtilFrameCreateNew(FALSE,0,0,0,0); // use an absolute position Boolean_t IsOk2 = TecUtilFrameCreateNew(TRUE, 1,1,7,7); |
|
Delete the top (active) frame. If there is only one frame when this is called, a new empty frame is automatically created after this command is executed. (Thus, you can never have a workspace without at least one frame.)
INTEGER*4 FUNCTION TecUtilFrameDeleteTop() |
|
Resize all frames so that they fit inside the hardclip limits of the paper.
INTEGER*4 FUNCTION TecUtilFrameFitAllToPaper() |
|
This function gets the current background color of the frame.
INTEGER*4 FUNCTION TecUtilFrameGetBackgroundColor() |
|
Get the name of the current frame.
INTEGER*4 FUNCTION TecUtilFrameGetName( Get the name of the current frame:
char *name = NULL; if ( TecUtilFrameGetName(&name) ) { / * do something * / TecUtilStringDealloc(&name); } |
|
Ends a sequence of lightweight frame pops. See TecUtilLightweightPopStart() for more information on lightweight frame popping.
SUBROUTINE TecUtilFrameLightweightPopEnd() Set the name of all frames to Hi Mom.
{ TecUtilLockStart(AddOnID); TecUtilFrameLightweightPopStart(); do { TecUtilFrameSetName("Hi Mom"); } while ( TecUtilFrameLightweightPopNext() ); TecUtilFrameLightweightPopEnd(); / * Don't redraw until TecUtilFrameLightweightPopEnd() is called * / TecUtilRedraw(TRUE); TecUtilLockFinish(AddOnID); } |
|
Pop the next frame. See TecUtilLightweightPopStart() for more information on lightweight frame popping.
INTEGER*4 FUNCTION TecUtilFrameLightweightPopNext() Set the name of all frames to Hi Mom.
{ TecUtilLockStart(AddOnID); TecUtilFrameLightweightPopStart(); do { TecUtilFrameSetName("Hi Mom"); } while ( TecUtilFrameLightweightPopNext() ); TecUtilFrameLightweightPopEnd(); / * Don't redraw until TecUtilFrameLightweightPopEnd() is called * / TecUtilRedraw(TRUE); TecUtilLockFinish(AddOnID); } |
|
Initialize lightweight frame pop. Lightweight frame pops have much less overhead compared to TecUtilFramePop(), but you are more restricted in what you can do after each pop. Thus this function can be used when: 1. Speed is important 2. You plan to cycle through and pop all of the frames 3. You will not do anything which will cause a redraw of the frame after the frame pop. Call this function before calling TecUtilFrameLightweightPopNext().
SUBROUTINE TecUtilFrameLightweightPopStart() Set the name of all frames to Hi Mom.
{ TecUtilLockStart(AddOnID); TecUtilFrameLightweightPopStart(); do { TecUtilFrameSetName("Hi Mom"); } while ( TecUtilFrameLightweightPopNext() ); TecUtilFrameLightweightPopEnd(); / * Don't redraw until TecUtilFrameLightweightPopEnd() is called * / TecUtilRedraw(TRUE); TecUtilLockFinish(AddOnID); } |
|
Pop a frame to the top (that is, make it the active frame).
INTEGER*4 FUNCTION TecUtilFramePop(FrameNum) Pop the frame underneath the current frame assuming that there are at least two frames.
TecUtilFramePop(TecUtilFrameGetCount() - 1); |
|
Pop the frame on top at a specified position on the paper.
INTEGER*4 FUNCTION TecUtilFramePopAtPosition( Pop the frame currently visible at one inch from the left, two inches from the right of the paper, and make that frame the current frame:
TecUtilFramePopAtPosition(1.0, 2.0); |
|
Pop a frame (specified by name) to the top.
INTEGER*4 FUNCTION TecUtilFramePopByName(Name) Pop the frame with the name "Frame 001", and make that frame the current frame:
TecUtilFramePopByName("Frame 001"); |
|
Pops a frame identified by a unique ID.
INTEGER*4 FUNCTION TecUtilFramePopByUniqueID(UniqueID) Pop the current frame using a unique id.
{ UniqueID_t id; TecUtilLockStart(AddOnID); id = TecUtilFrameGetUniqueID(); TecUtilFramePopByUniqueID(id); TecUtilLockFinish(AddOnID); } |
|
Push a frame to the bottom of the frame stack (i.e., it is given the frame number 1 and therefore drawn first). Note: This function requires Tecplot Version 7.5-0-6 or newer.
INTEGER*4 FUNCTION TecUtilFramePush(FrameNum) Assuming that there are at least two frames, push the frame underlying the top frame to the bottom of the frame stack.
TecUtilFramePush(TecUtilFrameGetCount() - 1); |
|
Push a frame (specified by name) to the bottom.
INTEGER*4 FUNCTION TecUtilFramePushByName(Name) Push the frame with the name "Frame 001" to the bottom, and make the frame under that frame the current frame:
TecUtilFramePushByName("Frame 001"); |
|
Pushes a frame identified by a unique ID.
INTEGER*4 FUNCTION TecUtilFramePushByUniqueID(UniqueID) Push the current frame using a unique id
{ UniqueID_t id; TecUtilLockStart(AddOnID); id = TecUtilFrameGetUniqueID(); TecUtilFramePushByUniqueID(id); TecUtilLockFinish(AddOnID); } |
|
Push the top (active) frame to the bottom.
INTEGER*4 FUNCTION TecUtilFramePushTop() |
|
Get the base path of a file name. This function allocates space for and creates a new string of the base path.
SUBROUTINE TecUtilGetBasePath( Get the start up directory and the base path of the current layout file name:
char *FName = TecUtilGetCurLayoutFName(); if (FName) { char *StartUpDir = TecUtilGetBasePath(NULL); char *BasePath = TecUtilGetBasePath(FName); / * BasePath is something like "C:\TEC75\DEMO\LAY\" * / if (BasePath) { . . TecUtilStringDealloc(&BasePath); } TecUtilStringDealloc(&FName); if (StartUpDir) TecUtilStringDealloc(&StartUpDir); } |
|
Create a true color or color-reduced bitmap of a specified width.
INTEGER*4 FUNCTION TecUtilImageBitmapCreateX(ArgListPtr) ArgList_pa ArgList;
TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList,SV_CONVERTTO256COLORS,FALSE); / * Create a true color image. * / TecUtilArgListAppendInt(ArgList,SV_IMAGEWIDTH,1000); / * The image will be rendered with a width of 1000 pixels. * / TecUtilArgListAppendInt(ArgList,SV_BITDUMPREGION,(LgIndex_t)BitDumRegion_WorkArea); TecUtilImageBitmapCreateX(ArgList); / * Export the image. * / TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Destroy the bitmap buffer.
SUBROUTINE TecUtilImageBitmapDestroy() |
|
Get the color table, that is, the palette, of a color-reduced image. You must call either TecUtilImageIndexedBitmapCreate() or TecUtilImageBitmapCreateX() before calling this function. The caller of this function must allocate three arrays of at least 256 bytes and pass them to this function.
SUBROUTINE TecUtilImageGetColorTable(
{ Byte_t Red[256]; Byte_t Green[256]; Byte_t Blue[256]; short ColorTable[256]; / * Must be at least 256 * / TecUtilLockStart(AddOnID); TecUtilImageBitmapCreateX(NULL); / * Will create a 256-color image. * / TecUtilImageGetColorTable(Red,Green,Blue); / * Export the image. * / TecUtilImageBitmapDestroy(); TecUtilLockFinish(AddOnID); } |
|
Gets the image dimensions. You must call TecUtilImageRGBBitmapCreate before using this function.
INTEGER*4 FUNCTION TecUtilImageGetDimensions( Create an indexed bitmap and get the dimensions.
{ short Width,Height; short ColorTable[256]; / * Must be at least 256 * / TecUtilLockStart(AddOnID); if (TecUtilImageIndexedBitmapCreate( BitDumpRegion_CurrentFrame, ColorTable)) { TecUtilImageGetDimensions(&Width,&Height); / * Dimensions are now in the Width and Height variables * / TecUtilImageBitmapDestroy(); / * Through with the bitmap * / } TecUtilLockFinish(AddOnID); } |
|
Call this function to initialize the export state if you are exporting using the index functions. Must be called before calling TecUtilImageIndexedGetScanLine and TecUtilImageGetDimensions.
INTEGER*4 FUNCTION TecUtilImageIndexedBitmapCreate( Create an indexed bitmap.
{ short RedColorTable[256]; short BlueColorTable[256]; short GreenColorTable[256]; TecUtilLockStart(AddOnID); if (TecUtilImageIndexedBitmapCreate( BitDumpRegion_CurrentFrame, RedColorTable, GreenColorTable, BlueColorTable)) { / * Bitmap has been created * / TecUtilImageBitmapDestroy(); / * When you're finished with it * / } TecUtilLockFinish(AddOnID); } |
|
Gets the color table indices for a scan line. The calling application must allocate/free the RGBIndex array and ensure that it has enough space.
INTEGER*4 FUNCTION TecUtilImageIndexedGetScanLine( Get the color table indices for the first scan line line.
{ short Width,Height; short *RGBIndex = NULL; short ColorTableR[256]; / * Must be at least 256 * / short ColorTableG[256]; short ColorTableB[256]; TecUtilLockStart(AddOnID); if (TecUtilImageIndexedBitmapCreate( BitDumpRegion_CurrentFrame, ColorTableR) ColorTableG) ColorTableB) { TecUtilImageGetDimensions(&Width,&Height); RGBIndex = (short*) malloc(Width * sizeof(short)); TecUtilImageIndexedGetScanLine(1 / * scan lines are 1-based * /, RGBIndex); TecUtilImageBitmapDestroy(); } TecUtilLockFinish(AddOnID); } |
|
Call this function to initialize the export state if you are exporting using the RGB functions. Must be called before calling TecUtilImageRGBGetScanLine and TecUtilImageGetDimensions.
INTEGER*4 FUNCTION TecUtilImageRGBBitmapCreate(Region) Create an RGB (24-bit) bitmap.
{ TecUtilLockStart(AddOnID); if (TecUtilImageRGBBitmapCreate(BitDumpRegion_CurrentFrame)) { / * Do the export * / TecUtilImageBitmapDestroy(); } TecUtilLockFinish(AddOnID); } See the Example for TecUtilImageRGBBitmapCreate().
|
|
Gets the RGB values of a scan line. The calling application must allocate/free the arrays and ensure that they have enough space.
INTEGER*4 FUNCTION TecUtilImageRGBGetScanLine( Get the first scan line.
{ / * 24-bit color * / short *Red; short *Green; short *Blue; short Width,Height; TecUtilLockStart(AddOnID); if (TecUtilImageRGBBitmapCreate(BitDumpRegion_CurrentFrame)) { TecUtilImageGetDimensions(&Width,&Height); Red = (short*) malloc(Width * sizeof(short)); Green = (short*) malloc(Width * sizeof(short)); Blue = (short*) malloc(Width * sizeof(short)); TecUtilImageRGBGetScanLine(1,Red,Green,Blue); TecUtilImageBitmapDestroy(); } TecUtilLockFinish(AddOnID); } |
|
Interpolate selected variables from one or more zones onto a destination zone using the inverse distance method. See Section 8.8.1, "Inverse-Distance Interpolation," in the Tecplot User's Manual for more information about inverse distance interpolation and its available options.
INTEGER*4 FUNCTION TecUtilInverseDistInterpolation( Interpolate all of the variables (except those assigned to the axes) from zones 1-3 to zone 4 using inverse-distance.
Boolean_t IsOk; Set_pa Zones = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(Zones, 1, TRUE); TecUtilSetAddMember(Zones, 2, TRUE); TecUtilSetAddMember(Zones, 3, TRUE); IsOk = TecUtilInverseDistInterpolation( Zones, 4, (Set_pa)NULL, 3.5, 0.0, PtSelection_OctantN, 8); TecUtilSetDealloc(&Zones); |
|
Interpolate selected variables from a set of source zones to a destination zone using the kriging method. See Section 8.8.2, "Kriging," in the Tecplot User's Manual for more information about kriging and its available options.
INTEGER*4 FUNCTION TecUtilKrig( Interpolate all of the variables (except those assigned to the axes) from zones 1-3 to zone 4 using kriging:
Boolean_t IsOk; Set_pa Zones = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(Zones, 1, TRUE); TecUtilSetAddMember(Zones, 2, TRUE); TecUtilSetAddMember(Zones, 3, TRUE); IsOk = TecUtilKrig( Zones, 4, (Set_pa)NULL, 0.3, 0.0, Drift_Linear, PtSelection_OctantN, 8); TecUtilSetDealloc(&Zones); |
|
Interpolate selected variables from a set of source zones to a destination zone using linear interpolation. The source zones cannot be I-ordered. Values assigned to the destination zone are equivalent to the results of using the Probe tool in Tecplot. See Section 8.8.3, "Linear Interpolation," in the Tecplot User's Manual for more information about linear interpolation and its available options.
INTEGER*4 FUNCTION TecUtilLinearInterpolate( Interpolate all of the variables (except those assigned to the axes) from zones 1-3 to zone 4 using linear interpolation:
Boolean_t IsOk; Set_pa Zones = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(Zones, 1, TRUE); TecUtilSetAddMember(Zones, 2, TRUE); TecUtilSetAddMember(Zones, 3, TRUE); IsOk = TecUtilLinearInterpolate( Zones, 4, (Set_pa)NULL, 0.0, LinearInterpMode_SetToConst); TecUtilSetDealloc(&Zones); |
|
Copy attributes from an existing Line-mapping to another.
INTEGER*4 FUNCTION TecUtilLineMapCopy( Duplicate the first Line-map:
Boolean_t IsOk = TecUtilLineMapCopy(1,2); if (!IsOk) { / * function NOT successful * / } |
|
Create a new Line-mapping.
INTEGER*4 FUNCTION TecUtilLineMapCreate() |
|
Delete one or more Line-maps.
INTEGER*4 FUNCTION TecUtilLineMapDelete(MapsToDeletePtr) Delete maps 1 and 3:
Set_pa set = TecUtilSetAlloc(FALSE); if (set) { TecUtilSetAddMember(set,1,TRUE); TecUtilSetAddMember(set,3,TRUE); TecUtilLineMapDelete(set); TecUtilSetDealloc(&set); } |
|
Shift a list of Line-maps to the bottom of the Line-map list. This in effect causes the selected Line-maps to be drawn last.
INTEGER*4 FUNCTION TecUtilLineMapShiftToBottom(MapsToShiftPtr) Shift Line-maps 2 and 4 to the bottom:
Set_pa set = TecUtilSetAlloc(FALSE); TecUtilSetAddMember(set,2,FALSE); TecUtilSetAddMember(set,4,FALSE); TecUtilLineMapShiftToBottom(set); TecUtilSetDealloc(&set); |
|
Shift a list of Line-maps to the top of the Line-map list. This in effect causes the selected Line-maps to be drawn first.
INTEGER*4 FUNCTION TecUtilLineMapShiftToTop(MapsToShiftPtr) Shift Line-maps 2 and 4 to the top:
Set_pa set = TecUtilSetAlloc(FALSE); TecUtilSetAddMember(set,2,FALSE); TecUtilSetAddMember(set,4,FALSE); TecUtilLineMapShiftToBottom(set); TecUtilSetDealloc(&set); |
|
Add a title to a page in the Quick Macro Panel.
INTEGER*4 FUNCTION TecUtilMacroPanelAddTitle(Title) Add the title "Flow Options" to the next macro panel:
TecUtilMacroPanelAddTitle("Flow Options"); |
|
Run a macro file. See the Tecplot Reference Manual for details about Tecplot macro files.
INTEGER*4 FUNCTION TecUtilMacroRunFile(FName) Load and run the macro file mymacro.mcr:
TecUtilMacroRunFile("mymacro.mcr"); |
|
Run a macro function. See the Tecplot Reference Manual for details about Tecplot macro functions.
INTEGER*4 FUNCTION TecUtilMacroRunFunction( Run a macro function called "Calculate" which takes no parameters and another macro function called "Display" which takes the name of a layout file and an integer as parameters:
TecUtilMacroRunFunction("Calculate", (char *)NULL); TecUtilMacroRunFunction("Display", "(\"contour.lay\", 2)"); |
|
Delete all frames and data sets (clear the current layout). A blank default frame will be created for you.
INTEGER*4 FUNCTION TecUtilNewLayout() Clear the current layout:
Boolean_t IsOk = TecUtilNewLayout(); |
|
Open and read in a new layout file.
INTEGER*4 FUNCTION TecUtilOpenLayout( Open a layout file called "experiment.lay." Then, append a layout called "calculate.lay," overriding the first data file referenced in that layout with a file called "newdata.plt":
StringList_pa AltInst = TecUtilStringListAlloc(); TecUtilStringListAppendString(AltInst, "newdata.plt"); TecUtilOpenLayout("experiment.lay", (StringList_pa)NULL, FALSE); TecUtilOpenLayout("calculate.lay", AltInst, TRUE); TecUtilStringListDealloc(&AltInst); |
|
Add all objects of a certain type to the pick list. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.
INTEGER*4 FUNCTION TecUtilPickAddAll(ObjectType) Select all text and geometries in the current frame:
Boolean_t TextsExist, GeomsExist; TecUtilPickDeselectAll(); TextsExist = TecUtilPickAddAll(PickObject_Text); GeomsExist = TecUtilPickAddAll(PickObject_Geom); |
|
Add all objects defined within a specified rectangle to the pick list. The rectangle is defined by the two corner points (X1, Y1) and (X2, Y2) in inches relative to the top left edge of the paper. An optional filter can be defined which specifies more details about which objects to select. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.
INTEGER*4 FUNCTION TecUtilPickAddAllInRect( In the current frame, within the rectangle bounded by (1.5, 1.5) and (7.5, 8.0), select red text, geometries with a dashed line pattern, and all contour labels:
Boolean_t RedTextsExist, DashedGeomsExist, ContLabelsExist; RedTextsExist = TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0, PickObject_Text, "COLORFILTER = RED"); DashedGeomsExist = TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0, PickObject_Geom, "LINEPATTERNFILTER = DASHED"); ContLabelsExist = TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0, PickObject_ContourLabel, NULL); |
|
Adds the frame identified by the unique identifier to the pick list. Each Tecplot frame is assigned a unique ID that can be obtained for the current frame by calling TecUtilFrameGetUniqueID.
INTEGER*4 FUNCTION TecUtilPickAddFrameByUniqueID( Add the current frame to a new pick list.
{ UniqueID_t FrameID; Boolean_t Picked; TecUtilLockStart(AddOnID); FrameID = TecUtilFrameGetUniqueID(); Picked = TecUtilPickAddFrameByUniqueID(FALSE, FrameID); TecUtilLockFinish(AddOnID); } |
|
Adds the specified Line-maps to the pick object list. In addition, you can control whether the Line-maps are added to the list of already picked objects or if the pick object list is cleared prior to adding them.
INTEGER*4 FUNCTION TecUtilPickAddLineMaps( Pick Line-maps 1 and 3
Set_pa LineMapSet; LineMapSet = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(LineMapSet,1,TRUE); TecUtilSetAddMember(LineMapSet,3,TRUE); TecUtilPickAddLineMaps(TRUE,LineMapSet); TecUtilSetDealloc(&LineMapSet); |
|
|
|
Adds the specified Line-maps to the pick object list. In addition, you can control whether the Line-maps are added to the list of already picked objects or if the pick object list is cleared prior to adding them.
INTEGER*4 FUNCTION TecUtilPickAddZones( Pick zones 1 and 3
Set_pa ZoneSet; ZoneSet = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(ZoneSet,1,TRUE); TecUtilSetAddMember(ZoneSet,3,TRUE); TecUtilPickAddZones(TRUE,ZoneSet); TecUtilSetDealloc(&ZoneSet); |
|
Pick an object at a specified location. The location is defined as the (X,Y) location in inches relative to the top-left edge of the paper. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.
INTEGER*4 FUNCTION TecUtilPickAtPosition( Select the object at the location (1.5, 3.2). Then, select the object underneath that object instead. Add the object at (5.5, 5.4) to the list of picked objects:
Boolean_t IsOk; IsOk = TecUtilPickAtPosition(1.5, 3.2, FALSE, FALSE); IsOk = TecUtilPickAtPosition(1.5, 3.2, FALSE, TRUE); IsOk = TecUtilPickAtPosition(5.5, 5.4, TRUE, FALSE); |
|
Clear (that is, delete) all objects that are currently picked. These objects cannot be retrieved.
INTEGER*4 FUNCTION TecUtilPickClear() |
|
Copy all objects that are currently picked to the paste buffer.
INTEGER*4 FUNCTION TecUtilPickCopy() |
|
Copy all objects that are currently picked to the paste buffer and then delete them from the plot.
INTEGER*4 FUNCTION TecUtilPickCut() |
|
Deselect all selected objects. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.
INTEGER*4 FUNCTION TecUtilPickDeselectAll() |
|
Perform a global edit operation on the currently picked objects. Only one edit operation is allowed per call to TecUtilPickEdit. Objects are edited only if the supplied parameter is relevant. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.
INTEGER*4 FUNCTION TecUtilPickEdit(Action) Set the color for all picked objects to yellow. Set the contour type for all picked zones to be "Flood". TecUtilPickEdit("COLOR = YELLOW"); TecUtilPickEdit("CONTOUR {COUNTOURTYPE = FLOOD}");
|
|
Magnify all picked objects. The first object picked will remain in place; the other picked objects will move proportionally as the image is magnified. Only frames, text, and geometries are allowed to be magnified.
INTEGER*4 FUNCTION TecUtilPickMagnify(MagFactor) Double the size of all picked objects.
Boolean_t IsOk = TecUtilPickMagnify(2.0); |
|
Paste the currently picked objects from the paste buffer to the workspace.
INTEGER*4 FUNCTION TecUtilPickPaste() |
|
Change the order in which objects are drawn by popping the currently picked objects to the front. Only frames, text, geometries, and the grid area for 2-D plots are allowed to be popped.
INTEGER*4 FUNCTION TecUtilPickPop() |
|
Change the order in which objects are drawn by pushing the currently picked objects back. Only frames, text, geometries, and the grid area for 2-D plots are allowed to be pushed.
INTEGER*4 FUNCTION TecUtilPickPush() |
|
|
|
Shift the currently picked objects. Objects are shifted relative to their starting position. X and Y shift amounts are in paper units (inches). If snapping is in effect then it is applied after shifting in X and Y.
INTEGER*4 FUNCTION TecUtilPickShift( Select all frames and resize their upper-left corners to be 2.5 inches to the right and 3.5 inches down from their previous location. Then, select all text in the current frame and move them 1.5 inches to the left and 0.25 inches up from their previous locations: TecUtilPickSetMouseMode(Mouse_Select); if (TecUtilPickAddAll(PickObject_Frame)) TecUtilPickShift(2.5, 3.5, PointerStyle_UpperLeftBracket); TecUtilPickDeselectAll(); if (TecUtilPickAddAll(PickObject_Text)) TecUtilPickShift(-1.5, -0.25, PointerStyle_AllDirections); |
|
|
|
Print the current layout to a printer or send the print instructions to a file. Use the TecUtilPrintSetup function to configure printing.
INTEGER*4 FUNCTION TecUtilPrint() Setup to print to a grayscale PostScript file called "print.ps" with black flooding appearing as a light gray and then do the printing:
TecUtilPrintSetup("PALETTE", NULL, 0.0, (ArbParam_t)Palette_Monochrome); TecUtilPrintSetup("DRIVER", NULL, 0.0, (ArbParam_t)PD_PS); TecUtilPrintSetup("PRINTFNAME", NULL, 0.0, (ArbParam_t)"print.ps"); TecUtilPrintSetup("MONOFLOODMAP", "BLACKSHADE", 90.0, (ArbParam_t)0); TecUtilPrint(); |
|
Write out an html file and related image files. The resulting html file, when viewed will show the current tecplot session.
INTEGER*4 FUNCTION TecUtilPublish( Write out a publish file to mydoc.htm. Include the package file and include a separate image per frame.
TecUtilPublish("mydoc.htm", TRUE, ImageSelection_OnePerFrame); |
|
Terminate the execution of the Tecplot program. Note that program control does return to your application.Calling TecUtilQuit merely sends a suggestion to Tecplot to quit. Other addons may block the actual termination of Tecplot (See TecUtilQuitAddQueryCallback). Even if Tecplot does decide to quit, it will still occur at a later time. The only code that follows a call to TecUtilQuit should be one or more calls to TecUtilLockFinish.
INTEGER*4 FUNCTION TecUtilQuit() Exit Tecplot:
TecUtilLockStart(AddOnID); TecUtilQuit(); TecUtilLockFinish(AddOnID); |
|
Assign the RGB values that define the Raw User-Defined color map. This does not set the color map to use the Raw User-Defined color map. Use TecUtilColorMapSetBase to assign the color map.
INTEGER*4 FUNCTION TecUtilRawColorMap( Define the Raw User-Defined color map to be five RGB values: blue, cyan, green, yellow, and red and assign Tecplot to use the Raw User-Defined color map.
ColorIndex_t RValues[5]; ColorIndex_t GValues[5] ColorIndex_t BValues[5]; RValues[0] = 0; GValues[0] = 0; BValues[0] = 255; RValues[1] = 0; GValues[1] = 255; BValues[1] = 255; RValues[2] = 0; GValues[2] = 255; BValues[2] = 0; RValues[3] = 255; GValues[3] = 255; BValues[3] = 0; RValues[4] = 255; GValues[4] = 0; BValues[4] = 0; TecUtilRawColorMap(5, RValues, GValues, BValues); TecUtilColorMapSetBase(ColorMap_RawUserDef); |
|
Load a color map file.
INTEGER*4 FUNCTION TecUtilReadColorMap(FName) Load the color map file temp.map.
TecUtilReadColorMap("temp.map"); |
|
Read one or more data files into Tecplot to form a new data set in the current frame.
INTEGER*4 FUNCTION TecUtilReadDataSet( Good: Var names currently in Tecplot = "A" "B" "C" VarNameList is appended to read = "A" "B\nR" "C" "D" Bad: Var names currently in Tecplot = "A" "B" "C" VarNameList is appended to read "A" "C" "B" "D" In the good example the integrity of the original data is always maintained, that is, the new VarNameList works for the original data as well as the new data. Variable 2 can be either "B" or "R". In the bad example, the new VarNameList states that variable 2 must contain "C" but "C" has already been assigned to variable 3 with the original data. Keep in mind that once variables are in Tecplot all style assignements are made based on variable position and not by name. Thus the variable positioning is important.
StringList_pa FileNames, VarNames; FileNames = TecUtilStringListAlloc(); TecUtilStringListAppendString(FileNames, "file1.plt"); TecUtilStringListAppendString(FileNames, "file2.plt"); VarNames = TecUtilStringListAlloc(); TecUtilStringListAppendString(VarNames, "X"); TecUtilStringListAppendString(VarNames, "Y"); TecUtilStringListAppendString(VarNames, "P\nPress"); IsOk = TecUtilReadDataSet(ReadDataOption_NewData, TRUE, FileNames, "TECPLOT", PlotType_Automatic, TRUE, TRUE, TRUE, TRUE, FALSE, (Set_pa)NULL, VarLoadMode_ByName, (Set_pa)NULL, VarNames, 1, 1, 1)) TecUtilStringListDealloc(&FileNames); TecUtilStringListDealloc(&VarNames); Read a data set consisting of file1.plt and file2.plt. Load the variables named "X", "Y", and either "P" or "Press."
StringList_pa FileNames, VarNames; FileNames = TecUtilStringListAlloc(); TecUtilStringListAppendString(FileNames, "file1.plt"); TecUtilStringListAppendString(FileNames, "file2.plt"); VarNames = TecUtilStringListAlloc(); TecUtilStringListAppendString(VarNames, "X"); TecUtilStringListAppendString(VarNames, "Y"); TecUtilStringListAppendString(VarNames, "P\nPress"); IsOk = TecUtilReadDataSet(ReadDataOption_NewData, TRUE, FileNames, "TECPLOT", PlotType_Automatic, TRUE, TRUE, TRUE, TRUE, FALSE, (Set_pa)NULL, VarLoadMode_ByName, (Set_pa)NULL, VarNames, 1, 1, 1)) TecUtilStringListDealloc(&FileNames); TecUtilStringListDealloc(&VarNames); |
|
Read a stylesheet file into the current frame.
INTEGER*4 FUNCTION TecUtilReadStylesheet( Load in the stylesheet file1.sty, choosing to reset the style of the current frame back to factory defaults first. Next, load only text and geometries from the stylesheet file2.sty, adding them to the current style:
|
|
Redraw the current frame.
INTEGER*4 FUNCTION TecUtilRedraw(DoFullDrawing) Do a complete redraw of the current frame:
|
|
Redraw all frames.
INTEGER*4 FUNCTION TecUtilRedrawAll(DoFullDrawing) Do a complete redraw of all frames:
|
|
Reset the ranges on the 3-D axes. The current frame mode must be 3D to use this function.
INTEGER*4 FUNCTION TecUtilReset3DAxes() |
|
Reposition the rotation origin in 3-D to be at the centroid of the data. The current frame must be in 3D mode to use this function.
INTEGER*4 FUNCTION TecUtilReset3DOrigin() |
|
Reposition the rotation origin in 3-D to the specified location. The current frame must be in 3D frame mode to use this function.
INTEGER*4 FUNCTION TecUtilReset3DOriginX(ArgListPtr) Reset the origin location to the center of the current view.
Boolean_t IsOk = TRUE; ArgList_pa ArgList; TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_ORIGINRESETLOCATION, OriginResetLocation_ViewCenter); IsOk = TecUtilReset3DOriginX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilLockFinish(AddOnID); |
|
Recalculate the scale factors for the 3-D axes. Aspect ratio limits are taken into account. The current frame must be in 3D frame mode to use this function.
INTEGER*4 FUNCTION TecUtilReset3DScaleFactors() |
|
Reset the length of the vectors. Tecplot will find the vector with the largest magnitude and set the scaling factor so it will appear on the screen using the default length as specified in the configuration file with the $!FRAMESETUP VECTDEFLEN macro command. The current frame must be in 3D frame mode to use this function.
INTEGER*4 FUNCTION TecUtilResetVectorLength() |
|
|
|
Save the current layout to a file. You must supply the file name.
INTEGER*4 FUNCTION TecUtilSaveLayout( Save a layout file called temp.lay, using absolute paths:
Boolean_t IsOk = TecUtilSaveLayout("temp.lay", FALSE); |
|
Save the current layout to a file.
INTEGER*4 FUNCTION TecUtilSaveLayoutX(ArgListPtr) Save a layout package named temp.lpk, without a preview image:
TecUtilArgListClear(ArgList); TecUtilArgListAppendString(ArgList, SV_FNAME, "temp.lpk"); TecUtilArgListAppendInt(ArgList, SV_INCLUDEDATA, TRUE); TecUtilArgListAppendInt(ArgList, SV_INCLUDEPREVIEW, FALSE); IsOk = TecUtilSaveLayoutX(ArgList); Save a layout named temp.lay using relative path names:
TecUtilArgListClear(ArgList); TecUtilArgListAppendString(ArgList, SV_FNAME, "temp.lpk"); TecUtilArgListAppendInt(ArgList, SV_USERELATIVEPATHS, TRUE); TecUtilArgListAppendInt(ArgList, SV_INCLUDEPREVIEW, FALSE); IsOk = TecUtilSaveLayoutX(ArgList); |
|
Sets the distance the viewer is from the plane that is parallel to the screen and passes through the 3-D rotation origin.
INTEGER*4 FUNCTION TecUtilSet3DEyeDistance(EyeDistance) |
|
Initializes transformation information so that coordinate conversion functions can be used. This function must be called before any sequence of calls to TecUtilConvert3DPositionToGrid().
SUBROUTINE TecUtilSetupTransformations() Convert from 3-D world coordinates to Tecplot's 3-D grid coordinates.
{ double ZPlaneFloor; double X,Y,Z; TecUtilLockStart(AddOnID); TecUtilSetupTransformations(); ZPlaneFloor = TecUtil3DViewGetNearZPlane(); TecUtilConvert3DPositionToGrid(1.0,1.0,ZPlaneFloor,&X,&Y,&Z); TecUtilLockFinish(AddOnID); } |
|
Smooth data (that is, reduce the spikes) for selected variables in selected zones.
INTEGER*4 FUNCTION TecUtilSmooth( Perform one smoothing pass on variable 3 in zone 2:
TecUtilSmooth(2, 3, 1, 0.8, BoundaryCondition_Fixed); |
|
Add a single streamtrace or a rake of streamtraces to the current frame. The frame must be a 2-D or 3-D field plot.
INTEGER*4 FUNCTION TecUtilStreamtraceAdd( Add a single 2-D line streamtrace to the current frame:
Boolean_t IsOk = FALSE; double Xp = 0.0; double Yp = 0.0; Xp = 10.0; Yp = 15.0; IsOk = TecUtilStreamtraceAdd(1, Streamtrace_TwoDLine, StreamDir_Forward, Xp, Yp, 0.0, 0.0, 0.0, 0.0); if (IsOk) { / * do more processing * / . . . } |
|
Delete all streamtraces in the current frame. Streamtraces are numbered sequentially.
INTEGER*4 FUNCTION TecUtilStreamtraceDeleteAll() |
|
Delete a range of streamtraces. Streamtraces are numbered sequentially in the order they were created.
INTEGER*4 FUNCTION TecUtilStreamtraceDeleteRange( Delete streamtraces 1 through 5.
Boolean_t IsOk = FALSE; IsOk = TecUtilStreamtraceDeleteRange(1, 5); if (IsOk) { / * do more processing * / . . . } |
|
Get the number of active streamtraces.
INTEGER*4 FUNCTION TecUtilStreamtraceGetCount() |
|
Get the starting position for a given streamtrace.
SUBROUTINE TecUtilStreamtraceGetPos( Get the position of streamtrace number 3.
double X,Y,Z; TecUtilStreamtraceGetPos(3,&X,&Y,&Z); |
|
Resets the time interval between stream markers.
INTEGER*4 FUNCTION TecUtilStreamtraceResetDelta() |
|
Set the position of the termination line for streamtraces.
INTEGER*4 FUNCTION TecUtilStreamtraceSetTermLine( Define a line for terminating streamtraces.
Boolean_t IsOk = FALSE; double Xp[2]; double Yp[2]; Xp[0] = 0.0; Yp[0] = 0.0; Xp[1] = 5.0; Yp[1] = 8.0; IsOk = TecUtilStreamtraceSetTermLine(2, Xp, Yp); if (IsOk) { / * do more processing * / . . . } |
|
Set the frame style defaults used by Tecplot when creating new frames. During normal operation, Tecplot bases the style of a new frame on the factory defaults plus any changes assigned in the Tecplot configuration file. Layout files and stylesheet files, however, rely on Tecplot basing new frames only on the factory defaults. This command is typically not used by the casual user.
INTEGER*4 FUNCTION TecUtilStyleSetBase(StyleBase) Instruct Tecplot to create all future frames based upon the factory defaults, ignoring any modifications specified in the user's tecplot.cfg file.
|
|
Instruct Tecplot to submit and execute an operating system specific command.
INTEGER*4 FUNCTION TecUtilSystem( Use the polygrid utility supplied with Tecplot to translate a PolyGrid file to a Tecplot ASCII input data file.
TecUtilSystem("polygrid < sphere.pol > sphere.dat", TRUE); |
|
Returns the Z-value below which you can no longer trust any values of TecUtilConvert3DPositionToGrid().
REAL*8 FUNCTION TecUtilThreeDViewGetNearZPlane() Convert from 3-D world coordinates to Tecplot's 3-D grid coordinates.
{ double ZPlaneFloor; double X,Y,Z; TecUtilLockStart(AddOnID); TecUtilSetupTransformations(); ZPlaneFloor = TecUtilThreeDViewGetNearZPlane(); TecUtilConvert3DPositionToGrid(1.0,1.0,ZPlaneFloor,&X,&Y,&Z); TecUtilLockFinish(AddOnID); } |
|
Queries the 3-D view attributes.
SUBROUTINE TecUtilThreeDViewGetProjection( Query the 3-D view attributes.
{ double FieldOfView,WidthWidth; Boolean_t IsInPerspective; TecUtilLockStart(AddOnID); TecUtilThreeDViewGetProjection(&FieldOfView, &ViewWidth, &IsInPerspective); TecUtilLockFinish(AddOnID); } |
|
Queries the 3-D viewer angles.
SUBROUTINE TecUtilThreeDViewGetViewerAngle( Query the 3-D view angles.
{ double P,T,A; TecUtilLockStart(AddOnID); TecUtilThreeDViewGetAngle(&P,&T,&A); TecUtilLockFinish(AddOnID); } |
|
Queries the 3-D viewer angles.
SUBROUTINE TecUtilThreeDViewGetViewerPos( Query the 3-D viewer position.
{ double XPos,YPos,ZPos; TecUtilLockStart(AddOnID); TecUtilThreeDViewGetViewerPos(&XPos,&YPos,&ZPos); TecUtilLockFinish(AddOnID); } |
|
Transform Coordinates.
INTEGER*4 FUNCTION TecUtilTransformCoordinatesX(ArgListPtr) Transform spherical coordinate variables (varibles 1, 2 and 3) to rectangular (cartesian) coordinate variables.
ArgList_pa ArgList; Set_pa ZoneSet = TecUtilSetAlloc(TRUE); TecUtilSetAddMember(ZoneSet, 1, TRUE); TecUtilLockStart(AddOnID); ArgList = TecUtilArgListAlloc(); TecUtilArgListAppendInt(ArgList, SV_THETAVAR, (LgIndex_t)1); TecUtilArgListAppendInt(ArgList, SV_RVAR, (LgIndex_t)2); TecUtilArgListAppendInt(ArgList, SV_PSIVAR, (LgIndex_t)3); TecUtilArgListAppendInt(ArgList, SV_XVAR, (LgIndex_t)4); TecUtilArgListAppendInt(ArgList, SV_YVAR, (LgIndex_t)5); TecUtilArgListAppendInt(ArgList, SV_ZVAR, (LgIndex_t)6); TecUtilArgListAppendSet(ArgList, SV_ZONESET, ZoneSet); TecUtilArgListAppendInt(ArgList, SV_ANGLESPEC, (LgIndex_t)ThetaMode_Arbitrary); TecUtilArgListAppendInt(ArgList, SV_TRANSFORMATION, (LgIndex_t)Transform_SphericalToRect); TecUtilTransformCoordinatesX(ArgList); TecUtilArgListDealloc(&ArgList); TecUtilSetDealloc(&ZoneSet); TecUtilLockFinish(AddOnID); |
|
Create a new zone by forming triangles from data points in existing zones.
INTEGER*4 FUNCTION TecUtilTriangulate( Create a zone by triangulating data points from zones 1 and 2:
LgIndex_t NumCoincidentPts; Set_pa set = TecUtilSetAlloc(FALSE); TecUtilSetAddMember(set,1,FALSE); TecUtilSetAddMember(set,2,FALSE); TecUtilTriangulate(set,FALSE,NULL,FALSE,&NumCoincidentPts,0.25); TecUtilSetDealloc(&set); |
|
Rename a data set variable in Tecplot.
INTEGER*4 FUNCTION TecUtilVarRename( Rename the first variable (assumed to be enabled for this example):
TecUtilVarRename(1,"NewNameForVariable1"); |
|
Reset the range on a specific axis so that it equals the minimum and maximum of the data being plotted. If the axis dependency is not independent then this action may also affect the range on another axis.
INTEGER*4 FUNCTION TecUtilViewAxisFit( Reset the range on the Y-axis to fit the data being plotted:
TecUtilViewAxisFit('Y',1); |
|
Makes the curently viewed axis values visually appealing.
INTEGER*4 FUNCTION TecUtilViewAxisMakeCurValsNice( |
|
Reset the range on a specific axis so that it equals a little more than the minimum and maximum of the data being plotted allowing a small border to enhance visual appeal. If the axis dependency is not independent then this action may also affect the range on another axis.
INTEGER*4 FUNCTION TecUtilViewAxisNiceFit( |
|
Center the data within the axis grid area.
INTEGER*4 FUNCTION TecUtilViewCenter() |
|
Copy the view from the current frame to the view paste buffer. This view can later be pasted into any frame that uses the same frame mode as the current frame. See also TecUtilViewPaste;
INTEGER*4 FUNCTION TecUtilViewCopy() |
|
Fit the data being plotted within the axis grid area. This does not take into consideration text or geometries.
INTEGER*4 FUNCTION TecUtilViewDataFit() |
|
Fit the data being plotted within the axis grid area. This also takes into consideration text and geometries that are plotted using the grid coordinate system.
INTEGER*4 FUNCTION TecUtilViewFit() |
|
Retrieve the previous view from the view stack. Each frame mode within each frame maintains its own view stack.
INTEGER*4 FUNCTION TecUtilViewLast() |
|
Give a border to the current view.
INTEGER*4 FUNCTION TecUtilViewMakeCurViewNice() |
|
Fit the data being plotted within the axis grid area leaving a determined border around the edge of the plot to make in more visually appealing. This also takes into consideration text and geometries that are plotted using the grid coordinate system.
INTEGER*4 FUNCTION TecUtilViewNiceFit() |
|
Retrieve the view from the view paste buffer and assign it to the current frame.
INTEGER*4 FUNCTION TecUtilViewPaste() |
|
Instruct Tecplot to push the current view onto the view stack associated with the frame mode for the current frame. A view will not be pushed if the current view is the same as the top view on the stack. Functions TecUtilViewAxisFit, TecUtilViewCenter, TecUtilViewDataFit, TecUtilViewFit, and TecUtilViewZoom automatically push a view onto the stack. Tecplot automatically pushes the current view onto the stack when a $!Redraw command (or TecUtilRedraw) is issued and the current view is different from the top view on the view stack. Note: Views pushed with this command are only retrieved using TecUtilViewLast
INTEGER*4 FUNCTION TecUtilViewPush() |
|
|
|
Do a 3-D rotation about a given axis.
INTEGER*4 FUNCTION TecUtilViewRotate3D( Rotate about the Psi-Axis by 25 degrees at the currently defined rotation origin.
TecUtilViewRotate3D(RotateAxis_Psi, 25.0, 0.0, 0.0, 0.0, RotateOriginLocation_DefinedOrigin); |
|
|
|
Scale (magnify) the view by a given value. Set the magnification factor for the current view relative to a view where the data fit to full frame size.
INTEGER*4 FUNCTION TecUtilViewSetMagnification(Magnification) Scale the view to ten percent of the size at which the data would fit the full frame:
TecUtilViewSetMagnification(0.10); |
|
Shift the image in the X- and/or Y-direction. The amount translated is in frame units.
INTEGER*4 FUNCTION TecUtilViewTranslate( Translate the view ten percent of the frame width to the right:
TecUtilViewTranslate(10.0,0.0); |
|
Change the view by "zooming" into the image. Tecplot will adjust the ranges on the axis to view the region defined by the rectangle with corners at (X1, Y1) and (X2, Y2). X1, Y1, X2, and Y2 are defined in the units of the X- and Y-axis (that is, grid coordinates).
INTEGER*4 FUNCTION TecUtilViewZoom( Zoom so the rectangular region with corners at (1, 0) and (7, 9) are in view:
TecUtilViewZoom(1.0,0.0,7.0,9.0); |
|
Change the view in the workspace so all frames are fit just inside the edges of the workspace.
INTEGER*4 FUNCTION TecUtilWorkViewFitAllFrames() |
|
Change the view in the workspace so the entire paper is fit just inside the edges of the workspace.
INTEGER*4 FUNCTION TecUtilWorkViewFitPaper() |
|
Change the view in the workspace so the currently selected frames (that is, the frames with picked handles) are fit just inside the edges of the workspace.
INTEGER*4 FUNCTION TecUtilWorkViewFitSelectFrames() |
|
Return to the previous workspace view.
INTEGER*4 FUNCTION TecUtilWorkViewLastView() |
|
Temporarily expand the workspace as large as possible. In the Motif version of Tecplot, the maximized workspace occupies the entire Tecplot process window. In the Windows version, the maximized workspace expands to fill the entire screen.
INTEGER*4 FUNCTION TecUtilWorkViewMaximize() |
|
Shift the view of the workspace. This has no effect on the local view within any frame in your layout.
INTEGER*4 FUNCTION TecUtilWorkViewTranslate( Shift the workspace view to the left by two inches (as measured by the workspace ruler):
TecUtilWorkViewTranslate(-2.0,0.0); |
|
Change the view into the workspace. This has no effect on the local view within any frame in your layout.
INTEGER*4 FUNCTION TecUtilWorkViewZoom( Make the region in the lower left corner of an 8.5 by 11 paper viewable in the work area. The paper is in portrait orientation:
TecUtilWorkViewZoom(0.0,5.5,4.25,9.75); |
|
Write the current color map to a file.
INTEGER*4 FUNCTION TecUtilWriteColorMap(FName) Write the current color map to a file. Mycolors.map is the file name:
TecUtilWriteColorMap("mycolors.map"); |
|
|
|
Write the data set attached to the current frame to a file.
INTEGER*4 FUNCTION TecUtilWriteDataSet( Write out only zone 3 to a file called zone3.plt:
Set_pa set = TecUtilSetAlloc(FALSE); TecUtilSetAddMember(set,3,FALSE); TecUtilWriteDataSet("zone3.plt",FALSE,FALSE,FALSE,TRUE,set,NULL, TRUE,FALSE,0); TecUtilSetDealloc(&set); |
|
Write the style for the current frame to a file.
INTEGER*4 FUNCTION TecUtilWriteStylesheet( Write the style for the current frame to the file f1.sty:
|
|
Write the style for the current frame to a file.
INTEGER*4 FUNCTION TecUtilWriteStylesheetX(ArgListPtr) Save a stylesheet "temp.sty" with no text objects included:
TecUtilArgListClear(ArgList); TecUtilArgListAppendString(ArgList,SV_FNAME,"temp.sty"); TecUtilArgListAppendString(ArgList,SV_INCLUDETEXT,FALSE); IsOk = TecUtilWriteStyleSheetX(ArgList); |
|
|
|
|
|
|
|
|
|
|
|
Make a copy of an existing zone. You can assign index ranges to create a new zone which is a sub-set of the source zone.
INTEGER*4 FUNCTION TecUtilZoneCopy( Duplicate zone 3:
Boolean_t IsOK = TecUtilZoneCopy(3,1,0,1,1,0,1,1,0,1); |
|
Make a copy of a zone.
INTEGER*4 FUNCTION TecUtilZoneCopyX(ArgListPtr) |
|
|
|
Rename a data set zone in Tecplot.
INTEGER*4 FUNCTION TecUtilZoneRename( Rename the first zone:
TecUtilZoneRename(1,"New Zone Name"); |