Description | Example | Return message | Group

RecordMovie3D

Control movie recording features for a 3D window

Syntax

RecordMovie3D <ScenarioPath> {MovieOptions}

Related commands

Description

The RecordMovie3D command allows you to set the options for and control the recording of the view in a 3D window.

{MovieOptions}Description
Record {On | Off | Parallel}On indicates frames will be captured once every animation time step during animation.

Off indicates no frames are recorded and saved during animation.

Using the Parallel option begins recording the movie using STK Parallel Computing.

OutputDir "<DirectoryPath>" The directory in which images of individual frames are saved.
Prefix <String>A string that will prefix each image's file name.
StartFromNumber <Number>The first number in the file sequence. The frame number increases incrementally for each subsequent frame saved. This number follows the prefix in the file name.
FileFormat {BMP | PNG | TIF | JPEG | H264 | WMV | ProRes}The format in which the files are to be saved. H264, WMV, and ProRes use only the prefix and not the numbers, since they generate a video file instead of individual image files.
MinDigits <NumDigits>The minimum number of digits to be used when naming a file. For instance, if the <NumDigits> is 2, file names are saved with the prefix plus a number from 01 to 99. When 99 is reached, STK begins overwriting files from 01 again.
PreloadTextures {On | Off}Use On to preload globe textures to ensure that the correct resolution textures are loaded for each animation frame. Preloading textures improves visual quality.

Use Off if globe textures are not preloaded. The correct resolution texture may not fully load until you stop moving the cursor, but you will be able to move more smoothly around the 3D graphics window.

SnapWindowSaves a picture of the current 3D Graphics window using the file naming options set here.

If the SnapWindow option is included in the command with other recording options, recording options will be set before the window is snapped.

AntiAlias {Off | 2 | 3 | 4 | FXAA}Indicates how color values are calculated. Blending region size options are:
  • Off - Turns off Anti-aliasing.
  • 2 - (2x2) Color is derived by dividing a single pixel into 4 squares, determining the color of the center of each square, and then averaging the color values over the pixel.
  • 3 - (3x3) Color is derived by dividing a single pixel into 9 squares, determining the color of the center of each square, and then averaging the color values over the pixel.
  • 4 - (4x4) Color is derived by dividing a single pixel into 16 squares, determining the color of the center of each square, and then averaging the color values over the pixel.
  • FXAA - Use the FXAA (Fast Approximate Anti-aliasing) algorithm.
LensFlareEnable {On | Off}When enabled, the lens flare effect emulates the Sun's light bouncing between inner elements within a camera's lens, creating "ghost" copies of the Sun in a line across the screen. These are only visible when the Sun is near the center of the screen and not blocked by the aircraft body.
Vignette Enable {On | Off} VignetteStrength {0.001-5.0}When enabled, the edges of the 3D Graphics window become darker than the center. The brightness of overlaid text annotations are not affected by this. This emulates a real-world effect present in some lenses and filters, where more light is permitted through the center of the lens barrel. The digital version of this can sometimes improve contrast between the STK image and the annotations. The strength ranges from about 0.001 to 5.0, but is most useful in the default strength of 1.0.
WindowID <WinNumber>Enter the number of the 3D window to which the changes will be applied.

The following options are available if the FileFormat is WMV (Windows Media Video).

OptionDescription
FrameRate <Rate>Enter the value in frames per second. <Rate> is an integer greater than 0.
BitRate <Rate>Enter the value in kilobits per second. <Rate> is an integer greater than 0.

To use FileFormat WMV, you may be required to install Windows Media Player.

Examples

To enable Anti-aliasing with the 2x2 calculation:

RecordMovie3D * AntiAlias 2

To turn recording on:

RecordMovie3D * Record On

To record animation frames to a single H.264 video file and save it to the location specified:

RecordMovie3D * Record On FileFormat H264 OutputDir "c:\MyTemp"

To capture the active 3D Graphics window and save it to the location specified with the prefix specified:

RecordMovie3D * SnapWindow OutputDir "c:\MyTemp" Prefix TestC

To enable Lens flare:

RecordMovie3D * LensFlareEnable On

To enable Vignette set to 1.0:

RecordMovie3D * VignetteEnable On VignetteStrength 1.0

Return message

Group membership

This command belongs to the following group(s):

Attitude

VO

VO Objects

Version

11.5