Functions | |
| Boolean_t | TecUtilFrameCreateNew (Boolean_t UseSuppliedFrameSize, double XPos, double YPos, double Width, double Height) |
| Creates a new frame. | |
| Boolean_t | TecUtilFramePopByName (const char *Name) |
| | |
| Boolean_t | TecUtilFramePushByName (const char *Name) |
| | |
| Boolean_t | TecUtilFramePopByUniqueID (UniqueID_t UniqueID) |
| | |
| Boolean_t | TecUtilFramePushByUniqueID (UniqueID_t UniqueID) |
| | |
| Boolean_t | TecUtilFramePushTop (void) |
| | |
| Boolean_t | TecUtilFramePush (int FrameNum) |
| | |
| Boolean_t | TecUtilFramePop (int FrameNum) |
| | |
| Boolean_t | TecUtilFramePopAtPosition (double X, double Y) |
| Pop the frame on top at a specified position on the paper. | |
| Boolean_t | TecUtilFrameDeleteTop (void) |
| | |
| Boolean_t | TecUtilFrameActivateTop (void) |
| Activate the top frame. | |
| Boolean_t | TecUtilFrameActivateByName (const char *Name) |
| Activate a frame (specified by name). | |
| Boolean_t | TecUtilFrameActivateByNumber (int FrameNum) |
| Activate a frame. | |
| Boolean_t | TecUtilFrameActivateByUniqueID (UniqueID_t UniqueID) |
| Activates a frame identified by a unique ID. | |
| Boolean_t | TecUtilFrameActivateAtPosition (double X, double Y) |
| Activate the frame on top at a specified position on the paper. | |
| Boolean_t | TecUtilFrameDeleteActive (void) |
| Delete the active frame. | |
| Boolean_t | TecUtilFrameMoveToTopByName (const char *Name) |
| Pop a frame (specified by name) to the top, but do not activate it. | |
| Boolean_t | TecUtilFrameMoveToTopByNumber (int FrameNum) |
| Pop a frame to the top, but do not make it the active frame. | |
| Boolean_t | TecUtilFrameMoveToTopByUniqueID (UniqueID_t UniqueID) |
| Pops a frame identified by a unique ID, but does not activate the frame. | |
| Boolean_t | TecUtilFrameMoveToBottomByName (const char *Name) |
| Push a frame (specified by name) to the bottom. | |
| Boolean_t | TecUtilFrameMoveToBottomByNumber (int FrameNum) |
| Push a frame to the bottom of the frame stack. | |
| Boolean_t | TecUtilFrameMoveToBottomByUniqueID (UniqueID_t UniqueID) |
| Pushes a frame identified by a unique ID. | |
| Boolean_t | TecUtilFrameFitAllToPaper (void) |
| Resize all frames so that they fit inside the hardclip limits of the paper. | |
| ColorIndex_t | TecUtilFrameGetBackgroundColor (void) |
| This function gets the current background color of the frame. | |
| SetValueReturnCode_e | TecUtilFrameSetBackgroundColor (ColorIndex_t color) |
| Sets the frame background color to the specified color and surveys all basic color assignments in Tecplot 360, converting the all basic colors using the following rules to achieve the best contrast: 1. | |
| Boolean_t | TecUtilFrameGetName (char **Name) |
| Get the name of the current frame. | |
| void | TecUtilFrameLightweightPopStart (void) |
| | |
| Boolean_t | TecUtilFrameLightweightPopNext (void) |
| | |
| void | TecUtilFrameLightweightPopEnd (void) |
| | |
| void | TecUtilFrameLightweightLoopStart (void) |
| Initialize lightweight frame activation loop. | |
| Boolean_t | TecUtilFrameLightweightLoopNext (void) |
| Activate the next frame. | |
| void | TecUtilFrameLightweightLoopEnd (void) |
| Ends a sequence of lightweight frame activations. | |
| ArbParam_t | TecUtilFrameGetLinking (const char *Attribute) |
| | |
| ArbParam_t | TecUtilLinkingGetValue (const char *Attribute, const char *SubAttribute) |
| Gets frame linking attributes. | |
| int | TecUtilFrameGetCount (void) |
| Get a count of the number of frames currently defined. | |
| FrameMode_e | TecUtilFrameGetMode (void) |
| | |
| PlotType_e | TecUtilFrameGetPlotType (void) |
| Get the plot type of the current frame. | |
| void | TecUtilGetBoundingBoxOfAllFrames (double *X1, double *Y1, double *X2, double *Y2) |
| Get dimension of the bounding box surrounding all frames in CoordSys_Paper units. | |
| UniqueID_t | TecUtilFrameGetUniqueID (void) |
| Gets the unique ID for the current frame. | |
| void | TecUtilFrameGetPosAndSize (double *X, double *Y, double *Width, double *Height) |
| Get the position and size of a frame. | |
| SetValueReturnCode_e | TecUtilFrameSetPosAndSize (double X, double Y, double Width, double Height) |
| Sets the position and size of the current frame. | |
| SetValueReturnCode_e | TecUtilFrameSetMode (FrameMode_e NewFrameMode) |
| | |
| SetValueReturnCode_e | TecUtilFrameSetPlotType (PlotType_e NewPlotType) |
| Set the current frame's plot type. | |
| Boolean_t | TecUtilFrameSetDataSet (UniqueID_t sourceDataSetID, UniqueID_t targetFrameID) |
| Assigns the specified dataset to a target frame. | |
| SetValueReturnCode_e | TecUtilFrameSetName (const char *Name) |
| Set the name for the current frame. | |
| SetValueReturnCode_e | TecUtilFrameSetLinking (const char *Attribute, ArbParam_t IValue) |
| | |
| SetValueReturnCode_e | TecUtilLinkingSetValue (const char *Attribute, const char *SubAttribute, ArbParam_t IValue) |
| Convenience function for setting a frame linking attribute. | |
| Boolean_t TecUtilFrameActivateAtPosition | ( | double | X, | |
| double | Y | |||
| ) |
Activate the frame on top at a specified position on the paper.
| X | X-Coordinates to specify a position on the paper of the frame to be activated. X is in inches from the left edge of the paper. | |
| Y | Y-Coordinates to specify a position on the paper of the frame to be activated. Y is in inches from the top edge of the paper. |
INTEGER*4 FUNCTION TecUtilFrameActivateAtPosition( & X, & Y) REAL*8 X REAL*8 Y
Python Syntax:
Results = TecUtil.FrameActivateAtPosition(X, Y)
Input:
X double
Y double
Output:
Results[0] ReturnVal boolean
Activate 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:
TecUtilFrameActivateAtPosition(1.0, 2.0);
| Boolean_t TecUtilFrameActivateByName | ( | const char * | Name | ) |
Activate a frame (specified by name).
| Name | Name of the frame to activate. Use TecUtilFrameGetName() to get the name of the current frame. |
INTEGER*4 FUNCTION TecUtilFrameActivateByName(Name) CHARACTER*(*) Name
Python Syntax:
Results = TecUtil.FrameActivateByName(Name)
Input:
Name string
Output:
Results[0] ReturnVal boolean
Activate the frame with the name "Frame 001":
TecUtilFrameActivateByName("Frame 001");
| Boolean_t TecUtilFrameActivateByNumber | ( | int | FrameNum | ) |
| FrameNum | Frame to be activated. Frames are numbered 1 to numframes with frame 1 drawn first and the highest numbered frame drawn last when RedrawAll is executed. See TecUtilFrameGetCount() to get the number of frames currently defined. |
INTEGER*4 FUNCTION TecUtilFrameActivateByNumber(FrameNum) INTEGER*4 FrameNum
Python Syntax:
Results = TecUtil.FrameActivateByNumber(FrameNum)
Input:
FrameNum int
Output:
Results[0] ReturnVal boolean
Activate the frame underneath the top frame assuming that there are at least two frames.
| Boolean_t TecUtilFrameActivateByUniqueID | ( | UniqueID_t | UniqueID | ) |
Activates a frame identified by a unique ID.
| UniqueID | Unique ID of the frame. |
INTEGER*4 FUNCTION TecUtilFrameActivateByUniqueID(UniqueID) INTEGER*4 UniqueID
Python Syntax:
Results = TecUtil.FrameActivateByUniqueID(UniqueID)
Input:
UniqueID long
Output:
Results[0] ReturnVal boolean
Activate the current frame using a unique id.
{
UniqueID_t id;
TecUtilLockStart(AddOnID);
id = TecUtilFrameGetUniqueID();
TecUtilFrameActivateByUniqueID(id);
TecUtilLockFinish(AddOnID);
}
| Boolean_t TecUtilFrameActivateTop | ( | void | ) |
INTEGER*4 FUNCTION TecUtilFrameActivateTop()
Python Syntax:
Results = TecUtil.FrameActivateTop()
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFrameCreateNew | ( | Boolean_t | UseSuppliedFrameSize, | |
| double | XPos, | |||
| double | YPos, | |||
| double | Width, | |||
| double | Height | |||
| ) |
| UseSuppliedFrameSize | If set to TRUE, then XYPos, Width, and Height are used to position and size the new frame. Otherwise, the frame is created with the position and size of the factory default frame | |
| XPos | X-Position (in inches) of the frame relative to the left edge of the paper. The frame is anchored in its upper left corner. | |
| YPos | Y-Position (in inches) of the frame relative to the top edge of the paper. | |
| Width | Width of the frame in inches. | |
| Height | Height of the frame in inches. Note that the Y-direction is positive in the down direction on the paper |
INTEGER*4 FUNCTION TecUtilFrameCreateNew( & UseSuppliedFrameSize, & XPos, & YPos, & Width, & Height) INTEGER*4 UseSuppliedFrameSize REAL*8 XPos REAL*8 YPos REAL*8 Width REAL*8 Height
Python Syntax:
Results = TecUtil.FrameCreateNew(UseSuppliedFrameSize, XPos, YPos, Width, Height)
Input:
UseSuppliedFrameSize boolean
XPos double
YPos double
Width double
Height double
Output:
Results[0] ReturnVal boolean
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);
| Boolean_t TecUtilFrameDeleteActive | ( | void | ) |
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 TecUtilFrameDeleteActive()
Python Syntax:
Results = TecUtil.FrameDeleteActive()
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFrameDeleteTop | ( | void | ) |
Python Syntax:
Results = TecUtil.FrameDeleteTop()
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFrameFitAllToPaper | ( | void | ) |
Resize all frames so that they fit inside the hardclip limits of the paper.
INTEGER*4 FUNCTION TecUtilFrameFitAllToPaper()
Python Syntax:
Results = TecUtil.FrameFitAllToPaper()
Output:
Results[0] ReturnVal boolean
| ColorIndex_t TecUtilFrameGetBackgroundColor | ( | void | ) |
This function gets the current background color of the frame.
INTEGER*4 FUNCTION TecUtilFrameGetBackgroundColor()
Python Syntax:
Results = TecUtil.FrameGetBackgroundColor()
Output:
Results[0] ReturnVal TecVals color constant
| int TecUtilFrameGetCount | ( | void | ) |
Get a count of the number of frames currently defined.
INTEGER*4 FUNCTION TecUtilFrameGetCount()
Python Syntax:
Results = TecUtil.FrameGetCount()
Output:
Results[0] ReturnVal int
| ArbParam_t TecUtilFrameGetLinking | ( | const char * | Attribute | ) |
Python Syntax:
This function is not supported in Python.
| FrameMode_e TecUtilFrameGetMode | ( | void | ) |
Python Syntax:
Results = TecUtil.FrameGetMode()
Output:
Results[0] ReturnVal FrameMode_e (defined in TecVals.py)
| Boolean_t TecUtilFrameGetName | ( | char ** | Name | ) |
Get the name of the current frame.
| Name | Address of character string. Space for the new name will be allocated for you. You must later free the string by using TecUtilStringDealloc(). |
INTEGER*4 FUNCTION TecUtilFrameGetName( & Name, & NameLength) CHARACTER*(*) Name INTEGER*4 NameLength
Python Syntax:
Results = TecUtil.FrameGetName()
Output:
Results[0] ReturnVal boolean
Results[1] Name string
Get the name of the current frame:
char *name = NULL; if ( TecUtilFrameGetName(&name) ) { // do something TecUtilStringDealloc(&name); }
| PlotType_e TecUtilFrameGetPlotType | ( | void | ) |
Get the plot type of the current frame.
This function is Thread Safe.
INTEGER*4 FUNCTION TecUtilFrameGetPlotType()
Python Syntax:
Results = TecUtil.FrameGetPlotType()
Output:
Results[0] ReturnVal PlotType_e (defined in TecVals.py)
Do something when the frame mode is XY Line:
if ( TecUtilFrameGetPlotType() == PlotType_XYLine ) { // do something }
| void TecUtilFrameGetPosAndSize | ( | double * | X, | |
| double * | Y, | |||
| double * | Width, | |||
| double * | Height | |||
| ) |
Get the position and size of a frame.
| X | Returned X-Coordinate for left hand side of the frame (in inches) relative to the left hand side of the paper. | |
| Y | Returned Y-Coordinate for top of the frame (in inches) relative to the top of the paper. | |
| Width | Width of the frame (in inches). | |
| Height | Height of the frame (in inches). |
Y Pointer must be a valid address and non-NULL.
Width Pointer must be a valid address and non-NULL.
Height Pointer must be a valid address and non-NULL.
SUBROUTINE TecUtilFrameGetPosAndSize( & X, & Y, & Width, & Height) REAL*8 X REAL*8 Y REAL*8 Width REAL*8 Height
Python Syntax:
Results = TecUtil.FrameGetPosAndSize()
Output:
Results[0] X double
Results[1] Y double
Results[2] Width double
Results[3] Height double
Get the current frame's position and size:
double x, y, width, height; TecUtilFrameGetPosAndSize(&x, &y, &width, &height);
| UniqueID_t TecUtilFrameGetUniqueID | ( | void | ) |
Gets the unique ID for the current frame.
A unique ID is an integer value unique to a frame during the Tecplot session. Using the unique ID a frame can be compared to other frames and manipulated via TecUtil calls that take unique IDs. This function is Thread Safe.
INTEGER*4 FUNCTION TecUtilFrameGetUniqueID()
Python Syntax:
Results = TecUtil.FrameGetUniqueID()
Output:
Results[0] ReturnVal long
Push the current frame using its unique ID:
{
UniqueID_t ID;
TecUtilLockStart(AddOnID);
ID = TecUtilFrameGetUniqueID();
TecUtilFramePushByUniqueID(ID);
TecUtilLockFinish(AddOnID);
}
| void TecUtilFrameLightweightLoopEnd | ( | void | ) |
Ends a sequence of lightweight frame activations.
See TecUtilLightweightLoopStart() for more information on lightweight frame activating.
SUBROUTINE TecUtilFrameLightweightLoopEnd()
Python Syntax:
Results = TecUtil.FrameLightweightLoopEnd()
Output:
Results[0] ReturnVal NONE
Set the name of all frames to Hi Mom.
{
TecUtilLockStart(AddOnID);
TecUtilFrameLightweightLoopStart();
do
{
TecUtilFrameSetName("Hi Mom");
}
while ( TecUtilFrameLightweightLoopNext() );
TecUtilFrameLightweightLoopEnd();
// Don't redraw until TecUtilFrameLightweightLoopEnd() is called
TecUtilRedraw(TRUE);
TecUtilLockFinish(AddOnID);
}
| Boolean_t TecUtilFrameLightweightLoopNext | ( | void | ) |
See TecUtilLightweightLoopStart() for more information on lightweight frame activating.
INTEGER*4 FUNCTION TecUtilFrameLightweightLoopNext()
Python Syntax:
Results = TecUtil.FrameLightweightLoopNext()
Output:
Results[0] ReturnVal boolean
Set the name of all frames to Hi Mom.
{
TecUtilLockStart(AddOnID);
TecUtilFrameLightweightLoopStart();
do
{
TecUtilFrameSetName("Hi Mom");
}
while ( TecUtilFrameLightweightLoopNext() );
TecUtilFrameLightweightLoopEnd();
// Don't redraw until TecUtilFrameLightweightLoopEnd() is called
TecUtilRedraw(TRUE);
TecUtilLockFinish(AddOnID);
}
| void TecUtilFrameLightweightLoopStart | ( | void | ) |
Initialize lightweight frame activation loop.
Lightweight frame activations have much less overhead compared to TecUtilFrameActivateByNumber(), but you are more restricted in what you can do after each activation. Thus this function can be used when:
* Speed is important * You plan to cycle through and activate all of the frames * You will not do anything which will cause a redraw of the frame after the frame activation.
Call this function before calling TecUtilFrameLightweightLoopNext().
SUBROUTINE TecUtilFrameLightweightLoopStart()
Python Syntax:
Results = TecUtil.FrameLightweightLoopStart()
Output:
Results[0] ReturnVal NONE
Set the name of all frames to Hi Mom.
{
TecUtilLockStart(AddOnID);
TecUtilFrameLightweightLoopStart();
do
{
TecUtilFrameSetName("Hi Mom");
}
while ( TecUtilFrameLightweightLoopNext() );
TecUtilFrameLightweightLoopEnd();
// Don't redraw until TecUtilFrameLightweightLoopEnd() is called
TecUtilRedraw(TRUE);
TecUtilLockFinish(AddOnID);
}
| void TecUtilFrameLightweightPopEnd | ( | void | ) |
Python Syntax:
Results = TecUtil.FrameLightweightPopEnd()
Output:
Results[0] ReturnVal NONE
| Boolean_t TecUtilFrameLightweightPopNext | ( | void | ) |
Python Syntax:
Results = TecUtil.FrameLightweightPopNext()
Output:
Results[0] ReturnVal boolean
| void TecUtilFrameLightweightPopStart | ( | void | ) |
Python Syntax:
Results = TecUtil.FrameLightweightPopStart()
Output:
Results[0] ReturnVal NONE
| Boolean_t TecUtilFrameMoveToBottomByName | ( | const char * | Name | ) |
Push a frame (specified by name) to the bottom.
Does not affect which frame is active.
| Name | Name of the frame to push. Use TecUtilFrameGetName() to get the name of the active frame |
INTEGER*4 FUNCTION TecUtilFrameMoveToBottomByName(Name) CHARACTER*(*) Name
Python Syntax:
Results = TecUtil.FrameMoveToBottomByName(Name)
Input:
Name string
Output:
Results[0] ReturnVal boolean
Push the frame with the name "Frame 001" to the bottom, but do not change which frame is currently the active frame:
TecUtilFrameMoveToBottomByName("Frame 001");
| Boolean_t TecUtilFrameMoveToBottomByNumber | ( | int | FrameNum | ) |
Push a frame to the bottom of the frame stack.
In other words it is given the frame number 1 and therefore drawn first. Do not alter which frame is the active frame.
| FrameNum | Frame to be pushed. Frames are numbered 1 to numframes with frame 1 drawn first and the highest numbered frame drawn last when Redraw All is executed. See TecUtilFrameGetCount() to get the number of frames currently defined. |
INTEGER*4 FUNCTION TecUtilFrameMoveToBottomByNumber(FrameNum) INTEGER*4 FrameNum
Python Syntax:
Results = TecUtil.FrameMoveToBottomByNumber(FrameNum)
Input:
FrameNum int
Output:
Results[0] ReturnVal boolean
Assuming that there are at least two frames, push the frame underlying the top frame to the bottom of the frame stack. Do not modify which frame is the active frame.
| Boolean_t TecUtilFrameMoveToBottomByUniqueID | ( | UniqueID_t | UniqueID | ) |
Pushes a frame identified by a unique ID.
Does not affect which frame is the active frame.
| UniqueID | Unique ID of the frame. |
INTEGER*4 FUNCTION TecUtilFrameMoveToBottomByUniqueID(UniqueID) INTEGER*4 UniqueID
Python Syntax:
Results = TecUtil.FrameMoveToBottomByUniqueID(UniqueID)
Input:
UniqueID long
Output:
Results[0] ReturnVal boolean
Push the active frame using a unique id
{
UniqueID_t id;
TecUtilLockStart(AddOnID);
id = TecUtilFrameGetUniqueID();
TecUtilFrameMoveToBottomByUniqueID(id);
TecUtilLockFinish(AddOnID);
}
| Boolean_t TecUtilFrameMoveToTopByName | ( | const char * | Name | ) |
Pop a frame (specified by name) to the top, but do not activate it.
| Name | Name of the frame to pop. Use TecUtilFrameGetName() to get the name of the active frame. |
INTEGER*4 FUNCTION TecUtilFrameMoveToTopByName(Name) CHARACTER*(*) Name
Python Syntax:
Results = TecUtil.FrameMoveToTopByName(Name)
Input:
Name string
Output:
Results[0] ReturnVal boolean
Pop the frame with the name "Frame 001", but do not make that frame the active frame:
TecUtilFrameMoveToTopByName("Frame 001");
| Boolean_t TecUtilFrameMoveToTopByNumber | ( | int | FrameNum | ) |
Pop a frame to the top, but do not make it the active frame.
| FrameNum | Frame to be popped. Frames are numbered 1 to numframes with frame 1 drawn first and the highest numbered frame drawn last when RedrawAll is executed. See TecUtilFrameGetCount() to get the number of frames currently defined. |
INTEGER*4 FUNCTION TecUtilFrameMoveToTopByNumber(FrameNum) INTEGER*4 FrameNum
Python Syntax:
Results = TecUtil.FrameMoveToTopByNumber(FrameNum)
Input:
FrameNum int
Output:
Results[0] ReturnVal boolean
Pop the frame underneath the current frame assuming that there are at least two frames, but do not activate the frame:
| Boolean_t TecUtilFrameMoveToTopByUniqueID | ( | UniqueID_t | UniqueID | ) |
Pops a frame identified by a unique ID, but does not activate the frame.
| UniqueID | Unique ID of the frame. |
INTEGER*4 FUNCTION TecUtilFrameMoveToTopByUniqueID(UniqueID) INTEGER*4 UniqueID
Python Syntax:
Results = TecUtil.FrameMoveToTopByUniqueID(UniqueID)
Input:
UniqueID long
Output:
Results[0] ReturnVal boolean
Pop the active frame using a unique id:
{
UniqueID_t id;
TecUtilLockStart(AddOnID);
id = TecUtilFrameGetUniqueID();
TecUtilFrameMoveToTopByUniqueID(id);
TecUtilLockFinish(AddOnID);
}
| Boolean_t TecUtilFramePop | ( | int | FrameNum | ) |
Python Syntax:
Results = TecUtil.FramePop(FrameNum)
Input:
FrameNum int
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePopAtPosition | ( | double | X, | |
| double | Y | |||
| ) |
Pop the frame on top at a specified position on the paper.
| X | X-Coordinates to specify a position on the paper of the frame to be popped. X is in inches from the left edge of the paper. | |
| Y | Y-Coordinates to specify a position on the paper of the frame to be popped. Y is in inches from the top edge of the paper. |
INTEGER*4 FUNCTION TecUtilFramePopAtPosition( & X, & Y) REAL*8 X REAL*8 Y
Python Syntax:
Results = TecUtil.FramePopAtPosition(X, Y)
Input:
X double
Y double
Output:
Results[0] ReturnVal boolean
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);
| Boolean_t TecUtilFramePopByName | ( | const char * | Name | ) |
Python Syntax:
Results = TecUtil.FramePopByName(Name)
Input:
Name string
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePopByUniqueID | ( | UniqueID_t | UniqueID | ) |
Python Syntax:
Results = TecUtil.FramePopByUniqueID(UniqueID)
Input:
UniqueID long
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePush | ( | int | FrameNum | ) |
Python Syntax:
Results = TecUtil.FramePush(FrameNum)
Input:
FrameNum int
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePushByName | ( | const char * | Name | ) |
Python Syntax:
Results = TecUtil.FramePushByName(Name)
Input:
Name string
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePushByUniqueID | ( | UniqueID_t | UniqueID | ) |
Python Syntax:
Results = TecUtil.FramePushByUniqueID(UniqueID)
Input:
UniqueID long
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilFramePushTop | ( | void | ) |
Python Syntax:
Results = TecUtil.FramePushTop()
Output:
Results[0] ReturnVal boolean
| SetValueReturnCode_e TecUtilFrameSetBackgroundColor | ( | ColorIndex_t | color | ) |
Sets the frame background color to the specified color and surveys all basic color assignments in Tecplot 360, converting the all basic colors using the following rules to achieve the best contrast: 1.
For all line type basic colors that match the new basic frame color, set the basic line color to the best show color of the basic frame color. 2. For all fill type basic colors that match the best show color of the new basic frame color, set the fill color to the new frame color. Exceptions: 1. For geometries and text boxes if the line and fill colors are the same and filling is active then both lines and fill follow the fill rules above. 2. For zone, slice, iso-surface, and streamtrace object types the basic color shading (i.e. fill) only follows the fill rules above if lighting effects are not being used.
| color | index of the color. The possible values are: Black_C, Blue_C, Red_C, Green_C, Cyan_C, Purple_C, Yellow_C, White_C. CustomXX_C (where XX can be any number between 1 and 64.) |
Results = TecUtil.FrameSetBackgroundColor(color)
Input:
color TecVals color constant
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
| Boolean_t TecUtilFrameSetDataSet | ( | UniqueID_t | sourceDataSetID, | |
| UniqueID_t | targetFrameID | |||
| ) |
Assigns the specified dataset to a target frame.
Multiple frames may share the same dataset, each using a different plot style. The frame must not already have a dataset assigned.
| sourceDataSetID | Unique ID of the dataset to share. | |
| targetFrameID | Unique ID of the target frame with which to share the dataset. |
INTEGER*4 FUNCTION TecUtilFrameSetDataSet(sourceDataSetID, & targetFrameID) INTEGER*4 sourceDataSetID INTEGER*4 targetFrameID
Python Syntax:
Results = TecUtil.FrameSetDataSet(sourceDataSetID, targetFrameID)
Input:
sourceDataSetID long
targetFrameID long
Output:
Results[0] ReturnVal boolean
| SetValueReturnCode_e TecUtilFrameSetLinking | ( | const char * | Attribute, | |
| ArbParam_t | IValue | |||
| ) |
Python Syntax:
Results = TecUtil.FrameSetLinking(Attribute, IValue)
Input:
Attribute string
IValue (depends on attribute)
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
| SetValueReturnCode_e TecUtilFrameSetMode | ( | FrameMode_e | NewFrameMode | ) |
Python Syntax:
Results = TecUtil.FrameSetMode(NewFrameMode)
Input:
NewFrameMode FrameMode_e (defined in TecVals.py)
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
| SetValueReturnCode_e TecUtilFrameSetName | ( | const char * | Name | ) |
Set the name for the current frame.
| Name | Name to assign to the current frame. |
INTEGER*4 FUNCTION TecUtilFrameSetName(Name) CHARACTER*(*) Name
Python Syntax:
Results = TecUtil.FrameSetName(Name)
Input:
Name string
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
Rename the current frame to be "XY-plot #1":
TecUtilFrameSetName("XY-plot #1");
| SetValueReturnCode_e TecUtilFrameSetPlotType | ( | PlotType_e | NewPlotType | ) |
Set the current frame's plot type.
| NewPlotType | Plot type to switch to. The possible values are: PlotType_Cartesian3D, PlotType_Cartesian2D, PlotType_XYLine, PlotType_PolarLine, or PlotType_Sketch |
INTEGER*4 FUNCTION TecUtilFrameSetPlotType(NewPlotType) INTEGER*4 NewPlotType
Python Syntax:
Results = TecUtil.FrameSetPlotType(NewPlotType)
Input:
NewPlotType PlotType_e (defined in TecVals.py)
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
Set the current frame's plot type to be Cartesian 3D:
| SetValueReturnCode_e TecUtilFrameSetPosAndSize | ( | double | X, | |
| double | Y, | |||
| double | Width, | |||
| double | Height | |||
| ) |
Sets the position and size of the current frame.
| X | X-Coordinate for the upper left-hand corner of the frame in inches relative to the upper left-hand corner of the paper | |
| Y | Y-Coordinate for the upper left-hand corner of the frame in inches relative to the upper left-hand corner of the paper | |
| Width | Width of the frame in inches. | |
| Height | Height of the frame in inches. |
INTEGER*4 FUNCTION TecUtilFrameSetPosAndSize( & X, & Y, & Width, & Height) REAL*8 X REAL*8 Y REAL*8 Width REAL*8 Height
Python Syntax:
Results = TecUtil.FrameSetPosAndSize(X, Y, Width, Height)
Input:
X double
Y double
Width double
Height double
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
Set the frame's position and size:
TecUtilFrameSetPosAndSize(1.0,1.0,3.0,3.0);
| void TecUtilGetBoundingBoxOfAllFrames | ( | double * | X1, | |
| double * | Y1, | |||
| double * | X2, | |||
| double * | Y2 | |||
| ) |
Get dimension of the bounding box surrounding all frames in CoordSys_Paper units.
| X1 | x coordinate of the upper left corner | |
| Y1 | y coordinate of the upper left corner | |
| X2 | x coordinate of the bottom right corner | |
| Y2 | y coordinate of the bottom right corner |
SUBROUTINE TecUtilGetBoundingBoxOfAllFrames( & X1, & Y1, & X2, & Y2) INTEGER*4 X1 INTEGER*4 Y1 INTEGER*4 X2 INTEGER*4 Y2
Python Syntax:
Results = TecUtil.GetBoundingBoxOfAllFrames()
Output:
Results[0] X1 double
Results[1] Y1 double
Results[2] X2 double
Results[3] Y2 double
| ArbParam_t TecUtilLinkingGetValue | ( | const char * | Attribute, | |
| const char * | SubAttribute | |||
| ) |
Gets frame linking attributes.
| Attribute | Valid values: SV_BETWEENFRAMES and SV_WITHINFRAME. | |
| SubAttribute | Attribute to set. For Attribute SV_BETWEENFRAMES the subattribute must be one of SV_LINKCONTOURLEVELS, SV_LINKFRAMESIZEANDPOSITION, SV_LINKSOLUTIONTIME, SV_LINKXAXISRANGE, SV_LINKYAXISRANGE, SV_LINK3DVIEW, SV_LINKGROUP. For Attribute SV_WITHINFRAME the subattribute must be one of SV_LINKAXISSTYLE, SV_LINKGRIDLINESTYLE, SV_LINKLAYERLINECOLOR, SV_LINKLAYERLINEPATTERN |
SubAttribute Pointer must be a valid address and non-NULL.
Must have one or more frames.
SUBROUTINE TecUtilLinkingGetValue( & Attribute, & SubAttribute, & ResultPtr) CHARACTER*(*) Attribute CHARACTER*(*) SubAttribute POINTER (ResultPtr, Result)
Python Syntax:
This function is not supported in Python.
Query the group number of the current frame:
SmInteger_t GroupNumber; GroupNumber = (SmInteger_t)TecUtilFrameGetLinking(SV_BETWEENFRAMES, SV_LINKGROUP);
| SetValueReturnCode_e TecUtilLinkingSetValue | ( | const char * | Attribute, | |
| const char * | SubAttribute, | |||
| ArbParam_t | IValue | |||
| ) |
Convenience function for setting a frame linking attribute.
This function in turn calls TecUtilStyleSetLowLevel().
| Attribute | Valid values: SV_BETWEENFRAMES and SV_WITHINFRAME | |
| SubAttribute | Attribute to set. For Attribute SV_BETWEENFRAMES the subattribute must be one of SV_LINKCONTOURLEVELS, SV_LINKFRAMESIZEANDPOSITION, SV_LINKSOLUTIONTIME, SV_LINKXAXISRANGE, SV_LINKYAXISRANGE, SV_LINK3DVIEW, SV_LINKGROUP. For Attribute SV_WITHINFRAME the subattribute must be one of SV_LINKAXISSTYLE, SV_LINKGRIDLINESTYLE, SV_LINKLAYERLINECOLOR, SV_LINKLAYERLINEPATTERN | |
| IValue | If Attribute is SV_LINKGROUP then this is the group number otherwise this is set to TRUE or FALSE |
INTEGER*4 FUNCTION TecUtilLinkingSetValue( & Attribute, & SubAttribute, & IValuePtr) CHARACTER*(*) Attribute CHARACTER*(*) SubAttribute POINTER (IValuePtr, IValue)
Python Syntax:
Results = TecUtil.LinkingSetValue(Attribute, SubAttribute, IValue)
Input:
Attribute string
SubAttribute string
IValue (depends on attribute)
Output:
Results[0] ReturnVal SetValueReturnCode_e (defined in TecVals.py)
Turn on linking for contour levels.
TecUtilLinkingSetValue(SV_BETWEENFRAMES, SV_LINKCONTOURLEVELS,TRUE);
1.5.5