OOF2: The Manual

OOF.Graphics_n.File.Animate
Prev  6.2.20. OOF.Graphics_n.File Commands  Next

Name

OOF.Graphics_n.File.Animate — Animate the Mesh displayed in the graphics window.

Synopsis

OOF.Graphics_n.File.Animate(start,finish,times,frame_rate,style)

Details

  • Parent Menu: OOF.Graphics_n.File
  • Callback: function GhostGfxWindow.animate in module ooflib.common.IO.ghostgfxwindow

  • Parameters:

    start
    Start the animation at this time. Type: A floating point number, or the earliest or latest time.
    finish
    End the animation at this time. Type: A floating point number, or the earliest or latest time.
    times
    How to select times between 'start' and 'finish'. Type: An object of the AnimationTimes class.
    frame_rate
    Update the display this many times per second. Type: A real number.
    style
    How to play the animation. Type: An object of the AnimationStyle class.

Description

The Animate command animates the contents of the graphics window. After a time dependent problem has been solved, the command causes the graphics window to recompute and redisplay its time dependent Layers, using data from the different times stored in the displayed Meshes. The times stored in a Mesh are the times at which Scheduled Outputs were requested when the Mesh was being solved.

The only Layers that will be animated are those whose when parameter is set to latest. Layers that do not have a when parameter, or whose when parameter is set to anything other than latest, will be drawn but will not change during the animation.

The start and finish parameters to Animate set bounds on the times that will be displayed. start must be less than finish. The times parameter determines how the intermediate times between start and finish will be selected. It can be set to select the times stored in a single Mesh, or all the times stored in all Meshes. It can also be set to select evenly spaced times between start and finish. If any of the display times is not stored in the Mesh, data will be generated by linear interpolation between the nearest stored times.

The frame_rate parameter determines how many time slices will be displayed each second. OOF2 will attempt to display the requisite number, but may not be able to attain it if it's displaying a lot of data. A future version (later than 2.1.1) may be able to precompute and cache frames to speed up the animation.

The style parameter determines whether or not the animation runs just once or repeatedly, and which direction it goes. Any animation can be halted via the Activity Viewer window. This is especially important for those that run repeatedly, since they won't stop otherwise.

Animate can be run from the File menu in the Graphics window's menubar.

Prev  Up  Next
OOF.File.Quit  Home  OOF.Graphics_n.File.Clear