Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘ANIMATE’
Description:
Animates grid plots. Set animation parameters using the ANIMATESETUP command.
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘ANIMATESETUP [optional parameters]’
Description:
Sets up the parameters for playing and recording in grid plot animations. The same parameters are used for recording and playing, although some parameters are ignored when not recording.
Optional Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
FNAME |
= <string> |
none |
Name of the animation file. Ignored when not recording. |
|
FTYPE |
= <option> |
AVI |
Type of animate file to create. Valid options are AVI, MPEG4, PNG, BMP, PS, TIFF, EPS, WMF, JPEG.
If a single image format is specified (PNG, etc.), then each frame of the animation will be output as a single image in the parent directory of the specified file name (FNAME). The file name of each frame will include the base file name FNAME parameter and a sequence number. |
|
SPEED |
= <double> |
1.0 |
Animation speed. Applies only to output formats that recognize frame speed. |
|
ANTIALIAS |
= <boolean> |
FALSE |
Perform antialiasing to improve quality – TRUE or FALSE |
|
SUPERSAMPLEFACTOR |
= <integer> |
3 |
Antialiasing super factor. |
|
WIDTH |
= <integer> |
300 |
Sets the width of the output frame. Ignored when not recording. |
|
STARTPERCENT |
= <integer> |
0 |
Starting position of the animation as a percentage of total frames. Zero indicates the first frame. |
|
ENDPERCENT |
= <integer> |
100 |
Ending position of the animation as a percentage of total frames. One hundred indicates the last frame. |
|
RECORD |
= <boolean> |
|
Set to TRUE to record this animation. |
|
DIRECTION |
= <integer> |
1 |
Animation direction: 1 for forward, and -1 for backwards |
CROSSPLOT
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘CROSSPLOT’
Description:
Change settings for Cross plots. Has no effect if the Plot type is not 2D or 3D Grid.
Optional Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
SHOW |
= <boolean> |
None |
Show Cross Plot frame - TRUE or FALSE |
HISTOGRAM
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘HISTOGRAM’
Description:
Change settings for histogram plots. Has no effect if the Plot type is not 2D or 3D Grid.
Optional Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
SHOW |
= <boolean> |
None |
Show Histogram Plot frame - TRUE or FALSE |
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘XYANIMATE’
Description:
Starts the animation of XY plots. Set animation options using the XYANIMATESETUP command.
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘XYANIMATESETUP [optional parameters]’
Description:
Sets up the parameters for playing and recording in XY plot animations. The same parameters are used for recording and playing, although some parameters are ignored when not recording.
Required Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
TYPE |
= <option> |
none |
Type of XY plot to be animated – XYVARIABLES, XYENTITIES, or CUSTOM |
Optional Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
FNAME |
= <string> |
none |
Name of the animation file. Ignored when not recording. |
|
FTYPE |
= <option> |
AVI |
Type of animate file to create. Valid options are AVI, MPEG4, PNG, BMP, PS, TIFF, EPS, WMF, JPEG.
If a single image format is specified (PNG, etc.), then each frame of the animation will be output as a single image in the parent directory of the specified file name (FNAME). The file name of each frame will include the base file name FNAME parameter and a sequence number. |
|
SPEED |
= <double> |
1.0 |
Animation speed. Applies only to output formats that recognize frame speed. |
|
ANTIALIAS |
= <boolean> |
FALSE |
Perform antialiasing to improve quality – TRUE or FALSE |
|
SUPERSAMPLEFACTOR |
= <integer> |
3 |
Antialiasing super sampling factor. |
|
WIDTH |
= <integer> |
300 |
Sets the width of the output frame. Ignored when not recording. |
|
OBJECTSET |
= <set> |
None |
Set of 1-based Entities/Variable numbers to export if exporting a sequence of images. The set is enclosed in square brackets and indices are separated by commas or a dash to indicate a range. Example: [1,2,4-7]. Each entity/variable is a 1-based index from the list of available entities or variables after any filtering has been applied.
Note: if this parameter is not included, the STARTSELECT/ENDSELECT will determine the starting and ending indicies.
Note: If this parameter is included, the STARTSELECT/ENDSELECT options are ignored. |
|
STARTSELECT |
= <integer> |
1 |
Starting entity or variable number (depending on the plot type). This uses a 1-based index from the list of available entities or variables after any filtering has been applied |
|
STOPSELECT |
= <integer> |
2 |
Final entity or variable index. |
|
RECORD |
= <boolean> |
FALSE |
Syntax:
$!ADDONCOMMAND
ADDONID = ‘TECPLOT RS’
COMMAND = ‘XYGLOBALSETTINGS [optional parameters]’
Description:
Sets global options for XY plots
Optional Parameters:
|
Parameter |
Syntax |
Default |
Notes |
|
FRAMESELECTIONMODE |
= <option> |
SEQUENTIAL |
Sets the frame selection mode. Must be one of the following: SEQUENTIAL - Variables are assigned based on the ordering in the sidebar (default) MANUAL - A variable can be assigned to each individual multi-frame. |