Home About Description Documentation Download News Register  
XCrySDen --
(X-Window)
	      CRYstalline Structures and DENsities

[Figure]
XCrySDen Scripting Documentation

Table of Contents
    Scripting/scripting::makeMovie
    Scripting/scripting::makeMovie::init
    Scripting/scripting::makeMovie::begin
    Scripting/scripting::makeMovie::makeFrame
    Scripting/scripting::makeMovie::end


Generated from scriptingMakeMovie.tcl with ROBODoc v3.2.4 on Wed May 25 16:04:51 2005


Scripting/scripting::makeMovie

NAME
 scripting::makeMovie

PURPOSE
 This namespace provide the scripting interface for making
 MPEG/Animated-GIF movies. The scripting::makeMovie namespace
 interface is kind of state machine. The "init" command initializes
 the process, and then the movie creation is encapsulated between
 "begin" and "end" commands. Every movie frame is created within the
 "begin" and "end" commands with "makeFrame" command. One can create
 several movies within one scripting file. Make sure the sequence of
 makeMovie calls will have the following order:

 init
 begin
   makeFrame
   makeFrame
   ...
 end

 init
 begin
   makeFrame
   makeFrame
   ...
 end


COMMANDS
 -- scripting::makeMovie::init
 Initializes the movie creation process. It must be called before
 making movie. One passes several configuration options to init call.

 -- scripting::makeMovie::begin
 Marks the begining of movie creation.

 -- scripting::makeMovie::makeFrame
 Makes one movie frame, that is, saves (i.e. prints to file) the
 content of the currently displayed object.

 -- scripting::makeMovie::end
 Finishes the movie creation and encodes the movie.


Scripting/scripting::makeMovie::init

NAME
 scripting::makeMovie::init

USAGE
 scripting::makeMovie::init -option value ?-option value? ...

PURPOSE
 This proc initializes the movie creation processes. One can pass several
 configuration options, which determine the technical details of the
 movie.

ARGUMENTS
 args -- various configuration "-option value" pairs

OPTIONS
 ------------------------------------------------------------------------
  OPTION               ALLOWED-VALUES + DESCRIPTION
 ------------------------------------------------------------------------

  -gif_transp          0|1 --> make oblique|transparent animated-GIF

  -gif_minimize        0|1 --> don't-minimize|minimize animateg-GIF

  -gif_global_colormap 0|1 --> don't-use|use global colormap for animated-GIF

  -movieformat         mpeg|gif --> create MPEG|Animated-GIF

  -dir                 tmp|pwd --> put temporary (i.e. frame) files to 
                                   scratch(tmp) or current working
                                   directory(pwd) 

  -frameformat         PPM|JPEG --> format of the frame-files 

  -firstframe          positive-integer --> repeat first frame n-times

  -lastframe           positive-integer --> repeat first frame n-times

  -delay               positive-integer --> time dalay between frames 
                                            in 1/100 sec
  -save_to_file        file --> if specified the movie will be saved to file
                                otherwise the filename will be queried
 

RETURN VALUE
 Undefined.

EXAMPLE
 scripting::makeMovie::init \
    -movieformat mpeg \
    -dir         tmp \
    -frameformat PPM \
    -firstframe  10 \
    -lastframe   10 \
    -delay       0


Scripting/scripting::makeMovie::begin

NAME
 scripting::makeMovie::begin

USAGE
 scripting::makeMovie::begin

PURPOSE
 This proc marks the beginning of movie creation.

RETURN VALUE
 Undefined.

EXAMPLE
 scripting::makeMovie::begin


Scripting/scripting::makeMovie::makeFrame

NAME
 scripting::makeMovie::makeFrame

USAGE
 scripting::makeMovie::makeFrame

PURPOSE
 This proc makes one movie frame, that is, it flushes (i.e. prints
 to file) the content of the currently displayed object.

WARNINGS
 Note that this proc should be called within scripting::makeMovie::begin 
 and scripting::makeMovie::end calls. The scripting::makeMovie::init
 should be called before "begin; makeFrame; ...; end" sequence.

RETURN VALUE
 Undefined.

EXAMPLE
 scripting::makeMovie::makeFrame


Scripting/scripting::makeMovie::end

NAME
 scripting::makeMovie::end

USAGE
 scripting::makeMovie::end

PURPOSE
 This proc finishes the movie creation and encodes the movie.

RETURN VALUE
 Undefined.

EXAMPLE
 scripting::makeMovie::end


Home | About | Description | Documentation | Download | News | Register
Webmaster: Tone Kokalj
This document was last modified on Tue May 31 10:23:36 CEST 2005