hwISession CaptureAnimationByArea

Creates a movie file by animating the current page, allowing you to first draw a box and select a sub-rectangle of the page for capture.

Syntax

hwISession_handle CaptureAnimationByAreafiletype, filename, left, top, right, bottom, [dimension_type, width, height]

Application

HyperWorks Tcl Query

Description

This command uses the current values for options found in the hwIAVIExportOptions or hwIAMFExportOptions object.

Inputs

filetype: Indicates the format of the output file. The animated formats can be "avi", "amf", and "gif" (one file contains the entire animation) or "png", "jpeg", "bmp" and "tiff" (a numbered series of still image files comprising the entire animation).
filename: The name of the file to be created.
left: The coordinate of the left side of the capture region, in screen percentage.
top: The coordinate of the top of the capture region, in screen percentage.
right: The coordinate of the right side of the capture region, in screen percentage.
bottom: The coordinate of the bottom of the capture region, in screen percentage.
dimension_type: Specifies the width and height units of the final animation, which can be in percent or pixels.
Note: If you specify a dimension_type, you MUST specify BOTH width and height (see below).
width: The number of width units of the final captured animation.
height: The number of height units of the final captured animation.

Example

To generate an animation file of the currently displayed graphics in the GIF format (note that these examples require the graphics area is at least 1050x450) :

hwi GetSessionHandle mySessionName
mySessionName GetGIFExportOptionsHandle myGIF
myGIF SetSize 99
myGIF SetDelay 0.5
mySessionName CaptureAnimationByArea gif c:/temp/fun.gif 0 0 1050 450
mySessionName CaptureAnimationByArea gif c:/temp/fun_75.gif 0 0 1050 450 percent 75 75

Error

Success (0) or an error code.