home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d9xx / d914 / mainactor.lha / MainActor / Docs / MainActor.doc next >
Text File  |  1993-10-04  |  61KB  |  1,905 lines
  1. MainActor 1.16 Documentation
  2. ****************************
  3.  
  4. Warm Up
  5. *******
  6.  
  7.    MainActor is shareware. The program may be freely distributed and
  8. copied as long as the following conditions are acknowledged:
  9.  
  10.    - The sales price must not be higher than the cost of an (empty)
  11.      disk plus a nominal copying fee plus costs for shipping. The total
  12.      price must not be higher than 6 US$ or 10 DM.
  13.  
  14.    - All parts of the program and the documentation must be complete.
  15.      The distribution of single parts is not allowed.
  16.  
  17.    - MainActor or parts of it must not be sold in combination with
  18.      commercial software without the written permission of the author.
  19.  
  20.    - Program and documentation must not be changed in any ways.  The
  21.      repacking of this distribution with different packers is however
  22.      allowed.
  23.  
  24.    - Permission is granted to include this archive in Public-Domain
  25.      collections, especially in Fred Fishs Amiga Disk Library (including
  26.      CD ROM versions of it).
  27.  
  28.    - The author is not responsible for misuse, or damage caused by
  29.      MainActor.
  30.  
  31. Installation
  32. ************
  33.  
  34.    Just copy the MainActor drawer to a device of your choice and add an
  35. assign to your user-startup, like
  36.  
  37.    `assign MainActor: <Path>'
  38.  
  39.    The default configuration file will clone your Workbench, the
  40. positions of the windows are however saved according to my setup and
  41. may look strange on yours.
  42.  
  43.    If you have an older version of MainActor installed, make sure to
  44. delete it before installing the new version (except perhaps the
  45. preferences files).
  46.  
  47. Introduction
  48. ************
  49.  
  50. What is MainActor ?
  51. ===================
  52.  
  53.    MainActor is a modular animation package for the `Amiga'. There
  54. exist four different kinds of modules:
  55.  
  56.    1) Animation Loaders
  57.  
  58.    2) Animation Savers
  59.  
  60.    3) Picture Loaders
  61.  
  62.    4) Picture Savers
  63.  
  64. this can change in the future.
  65.  
  66.    You can handle up to five projects; every project can have an
  67. animation or picture loader, as well as an animation or picture saver.
  68. This makes it possible to convert everything in any ways, the number of
  69. available modules can be easily upgraded.
  70.  
  71. Features
  72. ========
  73.  
  74.    - Intelligent caching/tracking, MainActor can cache your animations
  75.      and picture lists, if you have not enough memory it will directly
  76.      access your data from any device. This makes it for example
  77.      possible to create/edit/play a 400MB animation on your 2MB Amiga.
  78.  
  79.    - If you run OS 3.0 or higher, you will get an extra speed bonus on
  80.      animations through the use of the new graphics routines.  For
  81.      OS2.0/2.1 users there are specific routines in the modules, which
  82.      will give them the best playback speed possible on their system
  83.      (and my knowledge :)).
  84.  
  85.    - Under OS 3.0 you will get the extra features of showing pictures or
  86.      playing animations in a scrollable, resizable window on your
  87.      MainActor or Workbench screen. The colors will be properly
  88.      adjusted to your screen attributes.
  89.  
  90.    - The modules have play routines of their own, so it will be possible
  91.      to redirect the input/output of special modules to graphic cards
  92.      or other hardware.
  93.  
  94.    - The play routines support a timecode per frame option. A Sound
  95.      Module (per frame) option will be there in one of the next
  96.      releases.
  97.  
  98.    - MainActor has a totally user reconfigureable GUI. The settings of
  99.      your sessions can be saved, this includes the size/position of
  100.      windows as well as the status of the projects.
  101.  
  102.    - MainActor has an arexx port, nearly all functions can be accessed
  103.      through it. You can for example scale or dither whole animations
  104.      on the fly through the use of an image processor, scripts are
  105.      included.
  106.  
  107.    - MainActor lets you setup and save nearly everything concerning the
  108.      display mode for playing an animation or showing a picture.  For
  109.      example you can set the X/Y offsets, the display mode ID of your
  110.      screen (view) and so on.
  111.  
  112.    - MainActor supports localization.
  113.  
  114. New features in v1.1
  115. ====================
  116.  
  117.    - You can now map your arexx scripts to the function keys.
  118.  
  119.    - New IFF-Anim8_32, IFF-Anim8_16, PCX modules.
  120.  
  121.    - The new Universal modules allow you to easily load all of the
  122.      supported graphic formats.  The Universal_Picasso-II modules remap
  123.      the output of all modules directly to the Picasso-II graphics
  124.      board from Village Tronic.
  125.  
  126.    - MainActor has now an powerful external player named 'MainView', it
  127.      can view all animations/pictures for which MainActor has the proper
  128.      loader module.  It is executeable from the wb or cli and supports,
  129.      per tooltypes or cli arguments, all of MainActors view options.
  130.  
  131.    - MainActor now (optionally) saves icons for your newly created
  132.      animations or pictures, enabling you to view the
  133.      animations/pictures by selecting their icons. These icons support
  134.      the same tooltypes as MainView.
  135.  
  136.    - You can now control how many times MainActor/MainView play
  137.      animations.
  138.  
  139.    - The new 'Flash' option allows you to profile your animations.
  140.  
  141. The Menus
  142. *********
  143.  
  144.    You are able to access most of MainActor's functions through the
  145. various menu items and their equivalent shortcuts. Some functions can
  146. only be accessed through the menus.
  147.  
  148. Project Menu
  149. ============
  150.  
  151. `Open New Project'
  152.  
  153.    will open a new project window. You can open up to five project
  154. windows, see Project Window.
  155.  
  156.    The attributes of the project window will be set, according to the
  157. defaults selectable in the MainActor Preferences Window.
  158.  
  159. `Project'
  160.  
  161.    Consists of several submenu items, their functions are identical to
  162. the gadgets of the Project Control Panel Window.
  163.  
  164. `Open Prefs'
  165.  
  166.    Opens an asl-requester which lets you choose a MainActor preferences
  167. file, saved with one of the two following menu items.  When you have
  168. choosen a prefs file, the display AND all projects and their contents
  169. will be closed, MainActor will then be reopened with the settings of
  170. the preferences file.
  171.  
  172.    You can also activate MainActor by simply clicking on the icons of
  173. the preferences files.
  174.  
  175. `Save Prefs As ...'
  176.  
  177.    Saves your current setup of MainActor; nearly everything will be
  178. saved : the projects informations( All view settings, the actual
  179. project name, the size and position of all windows, the settings of the
  180. system preferences ...).
  181.  
  182.    An self-execuing icon will be created for the preferences file.  You
  183. should save every setup you use frequently !
  184.  
  185. `Save Prefs As Defaults'
  186.  
  187.    This will save your setup as the default preferences file, which will
  188. be automatically loaded when you start MainActor.  The default
  189. preferences file is `MainActor:Prefs/Default_Prefs'.  Replace the
  190. default by your most used setup.
  191.  
  192. `Iconify'
  193.  
  194.    MainActor will be terminated and the MainActor icon will be placed
  195. on your workbench. If you want to reactivate MainActor, just click on
  196. the icon.
  197.  
  198. `About'
  199.  
  200.    Gives you some informations of the current version of MainActor and
  201. its author.
  202.  
  203. `Quit'
  204.  
  205.    Will close all projects and quit MainActor.
  206.  
  207. Text Buffer Menu
  208. ================
  209.  
  210.    MainActor uses the Text Buffer Window for presenting feedback to the
  211. user.
  212.  
  213. `Print Buffer'
  214.  
  215.    Prints the informations stored in the Text Buffer Window.
  216.  
  217. `Save Buffer As ...'
  218.  
  219.    Will let you choose a file into which the contents of the Text
  220. Buffer Window will be saved.
  221.  
  222. `Clear Buffer'
  223.  
  224.    Will clear the Text Buffer Window and its buffer.
  225.  
  226. Miscellaneous Menu
  227. ==================
  228.  
  229.    The menu items of this menu will only be accessable when a project
  230. is loaded in the source project. The `Set Timecode' item will only be
  231. activated if an animation project is loaded in the source project.
  232.  
  233. `Select All'
  234.  
  235.    Will select all items frames/pictures in your source project.
  236.  
  237. `Select Range'
  238.  
  239.    A requester will pop up, just enter the start/stop frame for the
  240. range of items to be selected.
  241.  
  242. `DeSelect All'
  243.  
  244.    This item will deselect all frames/pictures in your source project.
  245.  
  246. `DeSelect Range'
  247.  
  248.    A requester will pop up, just enter the start/stop frame for the
  249. range of frames/pictures to be deselected.
  250.  
  251. `Set Timecode'
  252.  
  253.    Enter the timecode in the requester which you want to be applied to
  254. all selected frames in the source project. Remember to hit return after
  255. you typed a new value into the integer gadget.  The new timecode will
  256. be set immediately.  All timecodes are entered in 1/60 of a second,
  257. MainActor calculates the right timecode for your vertical beam
  258. frequency itself.
  259.  
  260. Arexx Menu
  261. ==========
  262.  
  263.    See The Arexx Interface,for more informations of MainActors arexx
  264. capabilities.
  265.  
  266. `Install Arexx Scripts'
  267.  
  268.    This menu item will open a window through which you can map your most
  269. used arexx scripts to the function keys.  The cycle gadget in the upper
  270. part of the window will let you choose the function key on which you
  271. want to install an arexx script.  The function keys are displayed as F1
  272. ... F20, F10 ... F20 mean the function key + one of the shift keys.
  273. You can choose the function key by clicking on the gadget or (the
  274. faster method) by simply pressing the appropriate function key.
  275. (Remember that you have to press F1 together with the shift key to get
  276. the F11 key).
  277.  
  278.    Below the cycle gadget are the `Select Script ...' gadget and a
  279. string gadget. The arexx script which is currently associated to the
  280. actual function key displayed in the cycle gadget is visible in the
  281. string gadget.  You can enter a new arexx script or edit the name of the
  282. existing one through the string gadget.  You can use the `Select Script
  283. ...' gadget to choose the arexx script via an asl requester.
  284.  
  285.    The three gadgets in the lower part of the window are labeled `Save',
  286. `Use' and `Cancel'.
  287.  
  288. `Save'
  289.      saves your definitions of the function keys, they will be
  290.      automatically reloaded the next time you start MainActor.
  291.  
  292. `Use'
  293.      will keep the definitions, but will not save them
  294.  
  295. `Cancel'
  296.      ignores the changes you made to the definitions.
  297.  
  298. `Start Arexx Script'
  299.  
  300.    Will let you choose an arexx script, which will then be executed.
  301.  
  302. Windows Menu
  303. ============
  304.  
  305.    This menu will let you open/close the different MainActor windows by
  306. simply selecting the desired menu item.
  307.  
  308. The Windows
  309. ***********
  310.  
  311.    The windows are MainActors main interface to the user. Their use is
  312. however optional, you can close all of them (except the Project Windows)
  313. and only use the menus. The choice is yours. The position and status of
  314. the windows will be saved in the preferences files.
  315.  
  316.    The following is a detailed description of MainActors windows and
  317. their gadgets.
  318.  
  319. Project Window
  320. ==============
  321.  
  322.    A new Project Window will be opend by selecting the `Open New
  323. Project' menu item in the Project Menu.
  324.  
  325.    You can open up to five Project Windows, the number of your Project
  326. Window will be displayed in the title bar, in front of the project
  327. name, like `1: HAM8_Animation'. If no project is loaded, the title is
  328. `Unused Project'.
  329.  
  330.    If you have loaded a project, you can find further informations
  331. about it in the screens title bar (when the Project Window is
  332. activated).  (CPF stands for Color per Frame, CPA for Color per
  333. Animation).
  334.  
  335.    The Project Windows are mainly controlled by the Project Control
  336. Panel Window.
  337.  
  338. `Project Mode Gadget'
  339.  
  340.    Depending on your projects mode, it will be labeled "Source Project",
  341. "Destination Project" or "DeActivated Project".
  342.  
  343. "The Source Project"
  344.      You can only have one source project. This is the project on which
  345.      all actions from the Project Control Panel Window will be
  346.      executed. The gadgets of the Project Control Panel and the Project
  347.      View Settings will be setup according to the source project.
  348.  
  349. "The Destination Project"
  350.      This is the project into which all selected data from the source
  351.      project will be appended through the "Append" gadget of the
  352.      Project View Settings Window.
  353.  
  354.      There can only be one Destination Project.
  355.  
  356. "The DeActivated Projects"
  357.      These projects are waiting to be switched into the source or
  358.      destination mode. There can be more than one DeActivated Project.
  359.  
  360.    You can change the project mode by clicking on the `Project Mode
  361. Gadget', for example if you click on the source projects `Project Mode
  362. Gadget', it will be changed into the destination project and the former
  363. destination project will changed into the source project.
  364.  
  365.    If you click on a DeActivated projects `Project Mode Gadget', it will
  366. change into the source project.
  367.  
  368.    If only one Project Window is open, you cannot change the `Project
  369. Mode Gadget'.
  370.  
  371.    Everytime you switch on the source project, the gadgets in the
  372. Project Control Panel Window and the Project View Settings Window will
  373. be adjusted to the settings of the new source project.
  374.  
  375. `Caching'
  376.  
  377.    This is a simple toggle gadget. If it is checked, it means that your
  378. Project is cached or is going to be cached in ram.
  379.  
  380.    If you have not enough ram, you will have to disable it. That means
  381. that for example animations will be directly played from your harddisk,
  382. which will be much slower than playing them directly from ram.
  383.  
  384.    You can only toggle the status of the `Caching' gadget when the
  385. project window is unused. As soon as you load a project, it will become
  386. "ghosted".
  387.  
  388. `Select Load Module'
  389.  
  390.    When clicking on this Button Gadget, a requester will appear in which
  391. you can select the loader module for this project.
  392.  
  393.    The cycling gadget in the requester will let you switch between
  394. "Picture Loaders" or "Animation Loaders".
  395.  
  396.    When hitting the `Load' gadget in the Project Control Panel Window,
  397. MainActor executes the animation/picture loader you have selected for
  398. the source project.
  399.  
  400.    The name of the current loader module is visible in a text gadget
  401. directly under the `Select Load Module' gadget.  Next to the name is a
  402. small recessed box with an `A' or `P' in it.  They stand for
  403. `A'nimation or `P'icture loader.
  404.  
  405.    The `Select Load Module' gadget will be ghosted as soon as you load
  406. a project.
  407.  
  408. `Select Save Module'
  409.  
  410.    When clicking on this button gadget, a requester will appear in which
  411. you can select the saver module.
  412.  
  413.    The cycling gadget in the requester will let you switch between
  414. "Picture Savers" or "Animation Savers".
  415.  
  416.    When hitting the `Save' gadget in the Project Control Panel Window,
  417. MainActor executes the animation/picture saver you have selected for
  418. the source project.
  419.  
  420.    The name of the current saver module is visible in a text gadget
  421. directly under the `Select Save Module' gadget. Next to the name is a
  422. small recessed box with an `A' or `P' in it. They stand for `A'nimation
  423. or `P'icture saver.
  424.  
  425.    The `Select Save Module' gadget will only be accessable when a
  426. project is loaded.
  427.  
  428. `The Scrolling Frames/Picture List'
  429.  
  430.    The scroll list will let you choose the frames or pictures you want
  431. to execute a certain operation on.
  432.  
  433.    If you have an animation loader for this project window, the scroll
  434. list will show you the numbered Frames of the Animation along with
  435. their timecodes.
  436.  
  437.    If you have a picture Loader, the scroll list will show you the
  438. names of the pictures you have loaded.
  439.  
  440.    Just (de)select the frame/picture by clicking on its text. For
  441. multiple selection do not release the mouse button and move over the
  442. items to be selected. The list will scroll if you come to the top or
  443. bottom border.
  444.  
  445.    See MainActor Preferences Window, you can select how many items
  446. shall be displayed in the scroll list. You can also select a special
  447. font for it. (The default is Topaz 8 for the font and 8 for the number
  448. of items which shall be visible).
  449.  
  450. Project Control Panel Window
  451. ============================
  452.  
  453.    This window executes its functions on the current source Project
  454. Window.
  455.  
  456. `Load'
  457.  
  458.    If you have an animation loader selected for the source project, an
  459. requester will appear in which you have to select an animation of the
  460. appropiate type.
  461.  
  462.    If you have an picture loader selected, the first requester will ask
  463. you about the first Picture, after selecting this picture the second
  464. qequester will ask you about the last picture.  MainActor will now
  465. alphabetically sort the pictures and load them.  For example, if you
  466. have a picture list:
  467.  
  468.      Amiga_Pic.00001
  469.      Amiga_Pic.00002
  470.      .
  471.      .
  472.      Amiga_Pic.00155
  473.  
  474.    and select Amiga_Pic.00055 in the first requester and
  475. Amiga_Pic.00100 in the next, all pictures from Amiga_Pic.00055 to
  476. Amiga_Pic.00100 will be loaded.  The second requester is optional, that
  477. means you can abort it by clicking on `Cancel' if you just want to load
  478. one picture.
  479.  
  480.    The `Load' gadget is only available if you have not loaded a project
  481. into the source project yet.
  482.  
  483. `Unload'
  484.  
  485.    Is the gadget directly under the `Load' gadget. It will unload the
  486. current project of the source project.
  487.  
  488.    It is only available when you have loaded a project in the source
  489. project.
  490.  
  491. `Play'
  492.  
  493.    Is next to the `Load' gadget. It is only available when you have
  494. loaded an animation project in the source project.
  495.  
  496.    If you play your animation on a screen, there are two routines
  497. available.  MainActor checks automatically if you run an OS Version
  498. lower than OS 3.0 and will play it the old fashioned way. If you have
  499. OS 3.0 or higher you will profit from the new double buffering routines.
  500.  
  501.    The animation will be played according to the settings of the
  502. Project View Settings Window.
  503.  
  504.    The following keys can be used to control the playing of the
  505. animation:
  506.  
  507. ESCAPE OR A MOUSEBUTTON
  508.      will abort playing the animation
  509.  
  510. SPACE
  511.      will stop playing the animation. While the animation is stopped
  512.      you can use the "TAB" key to flip to the next frame.
  513.  
  514. RETURN
  515.      will enable the timecodes you see in the scroll list of the source
  516.      project and which you can change (These timecodes are default).
  517.  
  518. THE CURSOR KEYS
  519.      scroll the display, the offset changes will be shown in the
  520.      Project View Settings Windows x and y offset gadgets.
  521.  
  522. N
  523. M
  524.      If you have activated the `Frame Info' option, you can cycle the
  525.      color of the info text using N and M up and down.
  526.  
  527. THE FUNCTION KEYS
  528.      are used to set the frame rate, they override the defaults.  You
  529.      can reactivate the defaults by pressing "RETURN".
  530.  
  531.     F1
  532.           sets the timecode to 1/60 Second (60 fps)
  533.  
  534.     F2
  535.           sets the timecode to 2/60 Second (30 fps)
  536.  
  537.     F3
  538.           sets the timecode to 3/60 Second (20 fps)
  539.  
  540.     F4
  541.           sets the timecode to 4/60 Second (15 fps)
  542.  
  543.     F5
  544.           sets the timecode to 5/60 Second (12 fps)
  545.  
  546.     F6
  547.           sets the timecode to 10/60 Second (6 fps)
  548.  
  549.     F7
  550.           sets the timecode to 20/60 Second (3 fps)
  551.  
  552.     F8
  553.           sets the timecode to 40/60 Second (1.5 fps)
  554.  
  555.     F9
  556.           sets the timecode to 60/60 Second (1 fps)
  557.  
  558.     F10
  559.           sets the timecode to 120/60 Second (0.333 fps)
  560.  
  561. `Show'
  562.  
  563.    Is the gadget under `Play'. It will display all the frames/pictures
  564. you have selected in the source projects scroll list.  This gadget is
  565. available for both animation and picture projects.
  566.  
  567.    The frames/pictures will be shown according to the settings of the
  568. Project View Settings Window.
  569.  
  570.    The following keys can be used to control the showing of the
  571. pictures:
  572.  
  573. ESCAPE OR A MOUSEBUTTON
  574.      will abort showing the pictures.
  575.  
  576. SPACE
  577.      will show the next pictures you have selected.
  578.  
  579. THE CURSOR KEYS
  580.      scroll the display, the offset changes will be shown in the
  581.      Project View Settings Windows x and y offset gadgets.
  582.  
  583. `Save' "WILL NOT BE USEABLE WITHOUT A KEYFILE"
  584.  
  585.    If you have an animation saver activated in your source project, it
  586. will ask you about the name of the new animation. Then it will build up
  587. the new animation in the appropriate animation Format. It will only
  588. save the frames you have `SELECTED' in the source projects scroll list.
  589. If you just want to convert or resave the animation, you have to select
  590. all the frames in the scroll list.
  591.  
  592.    If you have a picture saver activated in your source project, a
  593. requester will appear in which you have to select the directory and the
  594. base name of the pictures.
  595.  
  596.    Example: You have activated an animation loader and a picture saver
  597. and loaded an animation. The animation is called `Example_Anim'. Now
  598. you select the first ten frames of the animation and click on the
  599. `Save' gadget. In the requester you type `Ram:' for the Directory and
  600. `Example_Pics' for the base name.  The ten pictures will then be saved
  601. as
  602.  
  603.      Ram:Example_Pics.00001
  604.      Ram:Example_Pics.00002
  605.      .
  606.      .
  607.      Ram:Example_Pics.00010
  608.  
  609.    This is also valid if you have a picture loader and a picture saver.
  610.  
  611.    If you have a picture loader and an animation saver, some more
  612. gadgets will appear and ask you for some specific attributes of the new
  613. animation: `Palette per Picture' and `Looping Animation'.  If you have
  614. an animation loader and saver the saver module will only ask, if you
  615. want to have a looping animation, the color per frame setting will be
  616. set according to the source animation.  (You could change this by
  617. executing the `Save' function through an arexx script).
  618.  
  619. The following combinations are possible:
  620.  
  621.   1. Animation Loader and Animation Saver
  622.  
  623.   2. Animation Loader and Picture Saver
  624.  
  625.   3. Picture Loader and Animation Saver
  626.  
  627.   4. Picture Loader and Picture Saver
  628.  
  629.    In this way, you can easily convert any picture/animation format
  630. into any picture/animation format.
  631.  
  632. `Append' "WILL NOT BE USEABLE WITHOUT A KEYFILE"
  633.  
  634.    You can append the frames/pictures you have selected in the source
  635. project to the destination project. The destination project has to be
  636. an animation project.
  637.  
  638.    The source projects animation saver has to belong to the
  639. destinations loader module. (For Example the IFF-Anim5 loader and
  640. saver).  The destination project must `NOT' be cached.
  641.  
  642.    Some animation types have to fulfill some other attributes, for
  643. example the IFF-Anim5 format can only append to non-looping animations.
  644. When you want to append frames to a loop Anim5 animation, just resave it
  645. and select `NO' in the loop animation requester, then append the frames.
  646.  
  647.    If you want to add a loop to a non-looping animation, just append
  648. two pictures which are identical to the first two, then reload the
  649. animation.
  650.  
  651.    See The Modules, for more information about the specific attributes
  652. of the modules.
  653.  
  654. Project View Settings Window
  655. ============================
  656.  
  657.    This window controls the output of the `Play' and `Show' gadgets of
  658. the Project View Settings Window. The values will be set individually
  659. for each project and will be saved with the preferences files.
  660.  
  661. `Frame Info'
  662.  
  663.    This switch (when activated) will give you informations about the
  664. current frame while playing animations, it is only availaible if the
  665. source project contains an animation.
  666.  
  667.    If playing on a screen you will see the info on the top right edge
  668. of the screen. When you see no info text, use the M and N keys while
  669. playing to cycle the color of the info text up and down.
  670.  
  671.    When playing in a window, the windows title text will display the
  672. infos for the current frame.
  673.  
  674. `Mode'
  675.  
  676.    This cycle gadget will let you choose between the screen and window
  677. mode. In the screen mode the animation/pictures will be shown on a
  678. screen (view) of its own.
  679.  
  680.    In the window mode the animation/pictures will be shown in a
  681. resizeable, scrollable window on your MainActor screen.  THIS OPTION IS
  682. ONLY AVAILABLE ON SYSTEMS RUNNING OS3.0+.
  683.  
  684.    The more colors the MainActor screen has available (see System
  685. Preferences Window), the better is the dithering of your frame/picture.
  686. If you show a 256 color picture on a 4 Color screen, you will be
  687. disappointed by the result.  The timecodes of the animation will be
  688. ignored, the animation will be displayed as fast as possible.
  689.  
  690. `Select Display'
  691.  
  692.    You can choose the resolution/view mode of your animation/picture
  693. with this gadget (makes only sense in the screen mode).  This will
  694. override the old value, if you resave the animation/ picture, the new
  695. value will be saved.
  696.  
  697. `X/Y Offsets'
  698.  
  699.    With these two integer gadgets, you can select the offsets for
  700. showing animations/pictures (again, this makes only sense in the screen
  701. mode). If you scroll a frame (while playing an animation or showing a
  702. picture), the values of the gadgets will immediately be set up to the
  703. new values.
  704.  
  705. `Number of Repeats'
  706.  
  707.    This integer gadget controls how often MainActor will play an
  708. animation.  If it contains for example a "1", MainActor will play it
  709. one time.  Possible values are 1 to 9999.
  710.  
  711.    This gadget is only accessable if the source project contains an
  712. animation.
  713.  
  714. `Flash'
  715.  
  716.    If the flash gadget is enabled, MainActor will flash the display
  717. while playing animations when the animation format is not fast enough to
  718. decompress the current frame within the current timeframe.  This means
  719. that you can profile your animations using this gadget along with the
  720. `Frame Info' option.  The flash is done by shortly changing color 0 of
  721. your animation to red.  It is only available if the source project
  722. contains an animation.
  723.  
  724. Consider:
  725.  
  726.    - Nearly no bigger animation can decompress every picture in 1/60 of
  727.      a second, dont worry if your animations flashes much (press F1 to
  728.      get max. speed).  If the animations flashes VERY much at 2/60
  729.      (press F2) or 3/60 (F3), you should try another (faster) animation
  730.      format.
  731.  
  732.    - Flashing slowes the animation down in itself, if you have a lot of
  733.      flashing it will play much slower.
  734.  
  735.    - The `Frame Info' option also slowes animations down, you get less
  736.      flashing if you turn it off.
  737.  
  738.    - Non-Looping animations will often flash while decompressing
  739.      picture 1 (IFF-Anim5,IFF-Anim7,IFF-Anim8).
  740.  
  741.    - You can easily find out the weak spots of your animations (much
  742.      flashing), try to smooth the deltas at these points if you use
  743.      delta compression.  (IFF-Anim5,IFF-Anim7,IFF-Anim8).
  744.  
  745. System Preferences Window
  746. =========================
  747.  
  748. This window handles everything concerning the outer appearance of
  749. MainActor.
  750.  
  751. `Select Font'
  752.  
  753.    Choose your font for MainActor. This font will then be used for all
  754. windows, gadgets, menus. Only the list items of the Project Window will
  755. be displayed in a different font, you can select it in the MainActor
  756. Preferences Window.
  757.  
  758.    The actual font and its size are displayed beneath the gadget.  The
  759. `Select Font' gadget is not activated when you clone the workbench
  760. screen.
  761.  
  762. `Select Display'
  763.  
  764. ONLY AVAILABLE AT OS 2.1 +
  765.  
  766.    Choose your display mode for your MainActor screen. The current
  767. display mode is displayed beneath the gadget.
  768.  
  769.    This gadget is only activated when
  770.  
  771.    * MainActor has a screen of its own
  772.  
  773.    * You dont clone the workbench screen
  774.  
  775. `Use own Screen'
  776.  
  777.    If enabled, MainActor uses a screen of its own, if not, MainActor
  778. will use the workbench screen.
  779.  
  780. `SHANGHAI Windows'
  781.  
  782.    If enabled, MainActor uses the SHANGHAI public screen mode, that
  783. means that for example shell windows will automatically pop up on the
  784. MainActor screen.
  785.  
  786.    This gadget is only activated when you run MainActor on a screen of
  787. its own.
  788.  
  789. `Screen Size'
  790.  
  791.    This gadget is only available when you have enabled the `Use own
  792. Screen' gadget.  You can choose MainActors screen size and its overscan
  793. mode with this cycle gadget. The screen size of the current mode is
  794. displayed in the two integer gadgets to the right of the `Screen Size'
  795. gadget.  The screen size depends on the screen mode you selected with
  796. the `Select Display' gadget.
  797.  
  798.    You can select the following screenmodes:
  799.  
  800. "WorkBench"
  801.      Clones the workbench screen properties (screen size, overscan
  802.      mode, display mode, font)
  803.  
  804. "Custom"
  805.      Enter MainActors screen size in the two integer gadgets to the
  806.      right.
  807.  
  808. "Standard"
  809.      Use the standard screen size, without overscan ( for Example 640 *
  810.      512) at Pal: HighRes Interlace)
  811.  
  812. "Text Overscan"
  813.      The normal overscan mode which the workbench uses
  814.  
  815. "Video Overcan"
  816.      Tries to open as big a screen as possible. Flickers on normal
  817.      displays at the right border
  818.  
  819. "Max Overscan"
  820.      Slightly smaller than the "Video Overscan" mode, but as useless on
  821.      normal displays due to its flicker
  822.  
  823. `Palette Size'
  824.  
  825.    Select the colors of your palette with this gadget. The value left
  826. to the slider gadget shows the current colors available on your
  827. MainActor screen.
  828.  
  829.    This gadget only makes sense if you display pictures or play
  830. animations in the window mode. More colors == better dithering of your
  831. frames/ pictures. (the window mode is only available under OS 3.0 +).
  832.  
  833.    This gadget is only activated when
  834.  
  835.    * MainActor has a screen of its own
  836.  
  837.    * You dont clone the workbench screen.
  838.  
  839. `Use System Preferences'
  840.  
  841.    If you want to enable the changes you have made to your display just
  842. click on this gadget.
  843.  
  844. MainActor Preferences Window
  845. ============================
  846.  
  847.    This window lets you choose/enter some special MainActor attributes.
  848.  
  849. `Select Default Load Module'
  850.  
  851.    Lets you choose the default load module. Everytime you open a new
  852. project window, the default load module will be the one choosen for
  853. this new projects load module.
  854.  
  855. `Select Default Save Module'
  856.  
  857.    Lets you choose the default save module. Everytime you open a new
  858. project window, the default save module will be the one choosen for
  859. this new projects save module.
  860.  
  861. `Select List Item Font'
  862.  
  863.    Choose the font for your list items in your Project Window, this
  864. font must have a fixed with, the current font and its size are
  865. displayed to the right of the gadget, the default is topaz.font 8.
  866.  
  867. `Number of List Items'
  868.  
  869.    You can enter how many list items will be displayed in the project
  870. windows with this integer gadget, the default is 8.
  871.  
  872. `Save Icon'
  873.  
  874.    If you enable this gadet, MainActor will save an workbench-icon for
  875. every animation/picture you create. You can then view them by double
  876. clicking on their icons. The icons support the same tooltypes as
  877. MainView, see MainView.  The initial settings of the tooltypes clone
  878. the settings of the source project (from which you create the new
  879. animation/picture).
  880.  
  881. `Use MainActor Preferences'
  882.  
  883.    Will enable the changes made to the MainActor preferences.
  884.  
  885. Text Buffer Window
  886. ==================
  887.  
  888.    This window shows and buffers messages for feedback of the user.
  889. You can use the cursor up/down keys to scroll the text one line up/down.
  890. Control+cursor up/down will move to the start/end of the buffer.  You
  891. can also use the windows scrollbar to scroll through the buffer.
  892.  
  893.    See Text Buffer Menu, for more functions concerning the text uffer.
  894.  
  895. The Modules
  896. ***********
  897.  
  898.    MainActor has animation and picture modules of which each has loader
  899. and saver modules.
  900.  
  901. The Animation Modules
  902. =====================
  903.  
  904. Anim Universal
  905. --------------
  906.  
  907.    This module examines the animation format and executes the proper
  908. animation module.
  909.  
  910. Pecularities:
  911.  
  912.    The "Append" function will not work if the destination project has
  913. an Universal loader.
  914.  
  915. Anim Universal_PicassoII
  916. ------------------------
  917.  
  918.    Works in the same way as the `Universal' module but displays all
  919. pictures or animations directly on the Picasso-II board from
  920. VillageTronic.
  921.  
  922. Pecularities:
  923.  
  924.    It is faster to view animations of the bitmap formats (like
  925. Anim-5,7,8) on the native chipset as these formats have to be converted
  926. to the picassos chunky pixel mode.
  927.  
  928.    The frame info, display mode etc. options have of course no meaning
  929. for this module, the handling of the time codes is however correct and
  930. you can still stop the animation and flip to the next frame like normal.
  931. The function keys also control the speed of the animation.
  932.  
  933. IFF-Anim5
  934. ---------
  935.  
  936.    The IFF-Anim5 specification was created by `Electronic Arts'.
  937.  
  938.    It is a "good at compressing but slow at playing" format.
  939.  
  940. Pecularities:
  941.  
  942.    You cannot append to looping animations. You can bypass this by
  943. resaving it to a non-looping animation and then appending the frames.
  944. You can make a non-looping Animation to a looping animation by
  945. appending two frames which are identical to the first two.  (You have
  946. to reload the animation to make the loop appear) There are some bad
  947. animation packers out there, who do not save the first ANHD chunk
  948. before the BODY chunk. In this case MainActor cannot insert the
  949. timecode for the first frame and will give you an error message (the
  950. other timecodes will be set).  if you want to time the first frame,
  951. just resave the animation with MainActor to avoid this problem.
  952.  
  953. IFF-Anim7
  954. ---------
  955.  
  956.    The IFF-Anim7 specification was created by `Wolfgang Hofer'.
  957.  
  958.    It is a quit good compromise between speed and animation size.  The
  959. IFF-Anim7_16 modules use words (16 bits) the Anim-7_32 modules
  960. longwords (32 bits) for compression.  Therefore the 16 bit variant
  961. compresses slightly better than the 32 bit modules, but playback is
  962. slower.
  963.  
  964.    The IFF-Anim7_32 modules are, in my opinion, the best choice for
  965. timeable, fast animations.
  966.  
  967. Pecularities:
  968.  
  969.    You cannot append to looping animations. You can bypass this by
  970. resaving it to a non-looping animation and then appending the frames.
  971. You can make a non-looping animation to a looping animation by
  972. appending two frames which are identical to the first two.  (You have
  973. to reload the animation to make the loop appear) There are some bad
  974. animation packers out there, who do not save the first ANHD chunk
  975. before the BODY chunk. In this case MainActor cannot insert the
  976. timecode for the first frame and will give you an error message (the
  977. other timecodes will be set).  if you want to time the first frame,
  978. just resave the animation with MainActor to avoid this problem.  The
  979. modules do NOT support animations with a DLTA chunk instead of a BODY
  980. chunk for the first frame.
  981.  
  982. IFF-Anim8
  983. ---------
  984.  
  985.    The IFF-Anim8 specification was created by Joe Porkka of `ASDG'.
  986. There is no difference in playback speed between the Anim7 and Anim8
  987. formats.
  988.  
  989. Pecularities:
  990.  
  991.    You cannot append to looping animations. You can bypass this by
  992. resaving it to a non-looping animation and then appending the frames.
  993. You can make a non-looping animation to a looping animation by
  994. appending two frames which are identical to the first two.  (You have
  995. to reload the animation to make the loop appear) There are some bad
  996. animation packers out there, who do not save the first ANHD chunk
  997. before the BODY chunk. In this case MainActor cannot insert the
  998. timecode for the first frame and will give you an error message (the
  999. other timecodes will be set).  if you want to time the first frame,
  1000. just resave the animation with MainActor to avoid this problem.  The
  1001. modules do NOT support animations with a DLTA chunk instead of a BODY
  1002. chunk for the first frame.
  1003.  
  1004. IFF-AnimBrush
  1005. -------------
  1006.  
  1007.    The IFF-AnimBrush specification was created by `Dan Silva' of
  1008. Electronic Arts.  Anim Brushes are used/saved by DPaint.
  1009.  
  1010. Pecularities:
  1011.  
  1012.    There is no saver module at the moment.
  1013.  
  1014. The Picture Modules
  1015. ===================
  1016.  
  1017. Picture Universal
  1018. -----------------
  1019.  
  1020.    This module examines the picture format and executes the proper
  1021. picture module.
  1022.  
  1023. Picture Universal_PicassoII
  1024. ---------------------------
  1025.  
  1026.    Works in the same way as the `Universal' module but displays all
  1027. pictures directly on the Picasso-II board from VillageTronic.
  1028.  
  1029. Pecularities:
  1030.  
  1031.    The frame info, display mode etc. options have of course no meaning
  1032. for this module.  The only options you have is to press space for the
  1033. next picture or press escape to abort viewing.
  1034.  
  1035. IFF
  1036. ---
  1037.  
  1038.    This is the standard Interchangeable File Format (IFF), the
  1039. specification was designed by `Electronic Arts'.
  1040.  
  1041. Pecularities:
  1042.  
  1043.    Starting from MainActor Version 1.02, the IFF modules can load/save
  1044. IFF24 (24-Bit) pictures.
  1045.  
  1046. SFCP_PicassoII
  1047. --------------
  1048.  
  1049.    `Super Fast Chunky Pixels', the format was created by myself to view
  1050. pictures more quickly on my Picasso-II board. It was designed for
  1051. maximal speed on chunky pixel devices.
  1052.  
  1053. The advantages of this format are :
  1054.  
  1055.    SFCP uncompresses pictures about 5 to 10 times faster as IFF, at 24
  1056. bit it is blazingly fast.  SFCP compresses pictures to a size about 10
  1057. to 20 percent smaller than IFF in general.
  1058.  
  1059. The disadvantages are :
  1060.  
  1061.    You need a chunky pixel device for fast viewing. It is currently only
  1062. working on the Picasso-II board.  SFCP compression is not as good as
  1063. IFF on 24 bit pictures, but speedup is about 10 times faster.
  1064.  
  1065. Pecularities:
  1066.  
  1067.    SFCP pictures will currently only be recognized by the
  1068. `Universal_PicassoII' universal module as there is currently no support
  1069. for viewing SFCP pictures on the native chipset.  Convert the SFCP
  1070. pictures you want to view to the IFF format with MainActor if you dont
  1071. have a supported gfx board.
  1072.  
  1073. PCX
  1074. ---
  1075.  
  1076.    PCX is a picture format heavily used on pc's, it was designed by
  1077. `ZSoft'.
  1078.  
  1079. Pecularities:
  1080.  
  1081.    No save module yet
  1082.  
  1083. Workbench-Icon
  1084. --------------
  1085.  
  1086.    These modules support the workbench icons.
  1087.  
  1088. Pecularities:
  1089.  
  1090.    The saver module will append ".info" to the save name.
  1091.  
  1092. The Arexx Interface
  1093. *******************
  1094.  
  1095.    MainActors arexx port name is `MAINACTOR'.
  1096.  
  1097. Format:
  1098.  
  1099. <>
  1100.      Parmaters in these angle brackets have to be supplied
  1101.  
  1102. []
  1103.      Parameters in square brackets are optional
  1104.  
  1105. |
  1106.      Vertical bars mean OR and are used to seperate options of which
  1107.      you can choose one : [ON | OFF]
  1108.  
  1109.    The result variable contains the result of the operation, its
  1110. possible contents are listed in the command reference.
  1111.  
  1112.    Look at the `MainActor:rexx' directory for examples. Note that
  1113. MainActor does not support blanks in filenames which are arexx
  1114. arguments.
  1115.  
  1116. The arexx commands integrated in MainActor 1.16 are:
  1117.  
  1118. Append
  1119. ======
  1120.  
  1121. `Format:' Append "WILL NOT BE USEABLE WITHOUT A KEYFILE"
  1122.  
  1123.    Appends the selected frames/pictures of the source project to the
  1124. destination project.
  1125.  
  1126. result: -
  1127.  
  1128. DeSelectAll
  1129. ===========
  1130.  
  1131. `Format:' DeSelectAll
  1132.  
  1133.    Deselects all frames/pictures in the source project.
  1134.  
  1135. result: -
  1136.  
  1137. DeSelectRange
  1138. =============
  1139.  
  1140. `Format:' DeSelectRange <from> <to>
  1141.  
  1142.    Will deselect all frames/pictures in the source project from the
  1143. integer value `from' to `to'
  1144.  
  1145. result: -
  1146.  
  1147. DeSelectRangeRequest
  1148. ====================
  1149.  
  1150. `Format:' DeSelectRangeRequest
  1151.  
  1152.    The DeSelectRange requester will appear,letting you choose the
  1153. frames or pictures to deselect.
  1154.  
  1155. result: -
  1156.  
  1157. GetSPInfo
  1158. =========
  1159.  
  1160. `Format:' GetSPInfo
  1161.  
  1162.    Returns information about the current source project:
  1163.  
  1164.    The width of the source project, followed by its height, followed by
  1165. the amount of Colors (`HAM6',`HAM8',`EHB' will be given back literally
  1166. for AdPro compatibility), followed by the number of frames/pictures in
  1167. your project, followed by `CACHING=NO' or `CACHING=YES' depending if
  1168. you have caching en/disabled, followed by `LOOP=YES' or `LOOP=NO'
  1169. depending on the loop status and at last `CPF=YES' or `CPF=NO'
  1170. depending on your color per frame status.
  1171.  
  1172.    Picture lists have `LOOP' disabled and `CPF' enabled.
  1173.  
  1174. result: width height colors #ofpics caching loop cpf
  1175.  
  1176. `Examples':
  1177.  
  1178.    result=320 256 HAM6 220 CACHING=YES LOOP=YES CPF=NO
  1179.  
  1180.    result=320 256 16 10 CACHING=YES LOOP=YES CPF=YES
  1181.  
  1182. GetSPLoader
  1183. ===========
  1184.  
  1185. `Format:' GetSPLoader
  1186.  
  1187.    Returns two arguments, the first is `ANIM' or `PIC' depending of the
  1188. loader module type of the source project.  The second argument is the
  1189. name of the module itself.
  1190.  
  1191. result: ModuleType ModuleName
  1192.  
  1193. GetSPName
  1194. =========
  1195.  
  1196. `Format:' GetSPName
  1197.  
  1198.    If the source project has an animation loaded, it returns the full
  1199. animation name with path, else it returns two arguments, the first is
  1200. the name of the first picture with full path, the second is the name of
  1201. the last picture without its path.
  1202.  
  1203. result: Name of animation or name of first and last picture.
  1204.  
  1205. GetSPSaver
  1206. ==========
  1207.  
  1208. `Format:' GetSPSaver
  1209.  
  1210.    Returns two arguments, the first is `ANIM' or `PIC' depending of the
  1211. saver module type of the source project.  The second argument is the
  1212. name of the module itself.
  1213.  
  1214. result: ModuleType ModuleName
  1215.  
  1216. LoadProject
  1217. ===========
  1218.  
  1219. `Format:' LoadProject <Name1> [Name2]
  1220.  
  1221.    LoadProject will load an animation or picture list, according to the
  1222. type of the load module of the source project.
  1223.  
  1224.    `Name1' is the name of the animation or the name of the first picture
  1225. of the picture list.
  1226.  
  1227.    `Name2' is only needed when you want to load a picture list, it is
  1228. the name of the last picture.
  1229.  
  1230. `Examples':
  1231.  
  1232.    LoadProject Graphics:CountAnim.00001 Graphics:CountAnim.00010
  1233.  
  1234.    LoadProject Graphics:CountAnim.00001 CountAnim.00010
  1235.  
  1236.    LoadProject Graphics:Test/mandel7_32
  1237.  
  1238. result:-
  1239.  
  1240. OpenNewProject
  1241. ==============
  1242.  
  1243. `Format:' OpenNewProject [CACHING]
  1244.  
  1245.    Opens a new project window (up to five) If you supply the `CACHING'
  1246. parameter, the project window will have caching enabled, otherwise it
  1247. will be disabled.
  1248.  
  1249. result: -
  1250.  
  1251. PlayProject
  1252. ===========
  1253.  
  1254. `Format:' PlayProject
  1255.  
  1256.    Plays the animation contained in the source project, will fail if
  1257. the source project is a picture list.
  1258.  
  1259. result: -
  1260.  
  1261. Quit
  1262. ====
  1263.  
  1264. `Format:' Quit
  1265.  
  1266.    Closes all projects and quits MainActor.
  1267.  
  1268. result: -
  1269.  
  1270. PrintTxt
  1271. ========
  1272.  
  1273. `Format:' PrintTxt <text>
  1274.  
  1275.    Displays `text' in the Text Buffer Window.
  1276.  
  1277. result: -
  1278.  
  1279. PrintAndStoreTxt
  1280. ================
  1281.  
  1282. `Format:' PrintAndStoreTxt <text>
  1283.  
  1284.    Displays and buffers `text' in the Text Buffer Window.
  1285.  
  1286. result: -
  1287.  
  1288. RequestInteger
  1289. ==============
  1290.  
  1291. `Format:' RequestInteger <InitValue> <text>
  1292.  
  1293.    This command pops up an integer requester, `text' will be displayed
  1294. above the integer value which was initialized with `InitValue'.
  1295.  
  1296. `Example:'
  1297.  
  1298.    RequestInteger 640 "Enter new Width"
  1299.  
  1300. result: integer value
  1301.  
  1302. Save
  1303. ====
  1304.  
  1305. `Format:' Save <Name> [CPF=YES|NO] [LOOP=YES|NO]
  1306.  
  1307.    "WILL NOT BE USEABLE WITHOUT A KEYFILE"
  1308.  
  1309.    An animation saver will save the selected frames into a new animation
  1310. under the name you put in the `Name' parameter. `CPF' decides wether
  1311. you want a color palette per frame or not, `LOOP' decides if you want
  1312. to have a looping animation. `LOOP' and `CPF' overrule the normal
  1313. behaviour, if you dont supply them, everything will be saved as though
  1314. you had activated the `Save' gadget.
  1315.  
  1316.    If you have a picture saver, `Name' is the base name for the
  1317. pictures, `LOOP' and `CPF' have, in this case, no meaning.
  1318.  
  1319. result: -
  1320.  
  1321. ScreenToBack
  1322. ============
  1323.  
  1324. `Format:' ScreenToBack
  1325.  
  1326.    Flips the MainActor screen to the back.
  1327.  
  1328. result: -
  1329.  
  1330. ScreenToFront
  1331. =============
  1332.  
  1333. `Format:' ScreenToFront
  1334.  
  1335.    Flips the MainActor screen to the front.
  1336.  
  1337. result: -
  1338.  
  1339. SelectAll
  1340. =========
  1341.  
  1342. `Format:' SelectAll
  1343.  
  1344.    Selects all frames/pictures in the source project.
  1345.  
  1346. result: -
  1347.  
  1348. SelectRange
  1349. ===========
  1350.  
  1351. `Format:' SelectRange
  1352.  
  1353.    Will select all frames/pictures in the source project from the
  1354. integer value `from' to `to'
  1355.  
  1356. result: -
  1357.  
  1358. SelectRangeRequest
  1359. ==================
  1360.  
  1361. `Format:' SelectRangeRequest
  1362.  
  1363.    The SelectRange requester will appear, letting you choose the frames
  1364. or pictures to select.
  1365.  
  1366. result: -
  1367.  
  1368. ShowPictures
  1369. ============
  1370.  
  1371. `Format:' ShowPictures
  1372.  
  1373.    Shows the selected pictures/frames of the source project.
  1374.  
  1375. result: -
  1376.  
  1377. SetSPLoader
  1378. ===========
  1379.  
  1380. `Format:' SetSPLoader <ModuleType> <ModuleName>
  1381.  
  1382.    Sets the load module of the source project to the module type
  1383. `ModuleType' with the module name `ModuleName'.
  1384.  
  1385. `EXAMPLES:'
  1386.  
  1387.    SetSPLoader PIC IFF
  1388.  
  1389.    SetSPLoader ANIM IFF-Anim5
  1390.  
  1391. result: -
  1392.  
  1393. SetSPSaver
  1394. ==========
  1395.  
  1396. `Format:' SetSPSaver <ModuleType> <ModuleName>
  1397.  
  1398.    Sets the save module of the source project to the module type
  1399. `ModuleType' with the module name `ModuleName'.
  1400.  
  1401. `EXAMPLES:'
  1402.  
  1403.    SetSPSaver PIC IFF
  1404.  
  1405.    SetSPSaver ANIM IFF-Anim5
  1406.  
  1407. result: -
  1408.  
  1409. SetTimecode
  1410. ===========
  1411.  
  1412. `Format:' SetTimecode <Timecode>
  1413.  
  1414.    Sets `Timecode' (a value from 1 to 999) to the selected frames of
  1415. the source project.
  1416.  
  1417. result: -
  1418.  
  1419. SwapDeActivatedToSource
  1420. =======================
  1421.  
  1422. `Format:' SwapDeActivatedToSource
  1423.  
  1424.    Flips the first deactivated project to the source and the source
  1425. project to the destination project.
  1426.  
  1427. result: -
  1428.  
  1429. SwapProjects
  1430. ============
  1431.  
  1432. `Format:' SwapProjects
  1433.  
  1434.    Flips the destination project to the source and the source project
  1435. to the destination project.
  1436.  
  1437. result: -
  1438.  
  1439. UnloadProject
  1440. =============
  1441.  
  1442. `Format:' UnloadProject
  1443.  
  1444.    Unloads the current project of the source project.
  1445.  
  1446. result: -
  1447.  
  1448. Version
  1449. =======
  1450.  
  1451. `Format:' Version
  1452.  
  1453.    Will return the actual version string of MainActor.
  1454.  
  1455. result: MainActor xx.xx (xx.xx.xx)
  1456.  
  1457. WBToFront
  1458. =========
  1459.  
  1460. `Format:' WBToFront
  1461.  
  1462.    Flips the WorkBench screen to the front.
  1463.  
  1464. result: -
  1465.  
  1466. MainView
  1467. ********
  1468.  
  1469.    MainView is MainActors external player. It can display all
  1470. animations/pictures for which MainActor has the proper loader modules.
  1471.  
  1472.    The key commands while playing animations or showing pictures are
  1473. the same as if you would view them directly with MainActor.  Thats the
  1474. reason for not listing them here again, have a look at the Project
  1475. Control Panel Window under `Play' and `Show'.
  1476.  
  1477.    If MainActor saved an icon for the animations/pictures to view,
  1478. MainView will take the view settings from this icon (overruling its own
  1479. settings) !  You can change this behaviour through the `IgnoreIcons'
  1480. option.
  1481.  
  1482.    You can start MainView from the workbench or form the cli.
  1483.  
  1484. `Starting MainView from the Workbench'
  1485.  
  1486.    If you start MainView from the wb (per icon) you can select the
  1487. file(s) to view in an asl-requester. For multi selecting just press one
  1488. of the shift keys and select the files with the mouse. (Starting from
  1489. OS 2.1+)
  1490.  
  1491. MainView supports the following tooltypes:
  1492.  
  1493. "Window"
  1494.      This tooltype enables the window mode, all animations or pictures
  1495.      will be displayed in an window on the current public screen.  It
  1496.      is disabled by default.
  1497.  
  1498. "FrameInfo"
  1499.      FrameInfo enables the FrameInfo mode. It Is disabled by default.
  1500.  
  1501. "NoCaching"
  1502.      Disables caching, with caching disabled MainView plays direct from
  1503.      the harddisk (or whatever). This allows you to play big animations
  1504.      even if you have not much ram.  It is disabled by default.
  1505.  
  1506. "IgnoreIcons"
  1507.      Ignores the icons of the animations/pictures It is disabled by
  1508.      default.
  1509.  
  1510. "Flash"
  1511.      Enables the Flash option. It is disabled by default.
  1512.  
  1513. "XOffset=<Value>"
  1514.      You can directly set the start x offset.  Defaults to 0.
  1515.  
  1516. "YOffset=<Value>"
  1517.      The same for the y offset.  Defaults to 0.
  1518.  
  1519. "Repeat=<Value>"
  1520.      Repeats the animation <Value> times.  For example `Repeat=1' would
  1521.      play the animation one time.  Defaults to 100.
  1522.  
  1523. "Directory=<Path>"
  1524.      This is the initial directory for the asl-requester.
  1525.  
  1526. "Anim_Module=<Module>"
  1527.      Chooses the default loader module for animations.  Default is the
  1528.      `Universal' module.
  1529.  
  1530. "Pic_Module=<Module>"
  1531.      Chooses the default loader module for pictures.  Default is the
  1532.      `Universal' module.  If you want to view all pictures for example
  1533.      on the PicassoII gfx board, choose the `Universal_PicassoII'
  1534.      module.
  1535.  
  1536. `Starting MainView from the cli'
  1537.  
  1538.    Starting MainView from the cli will give you enhanced functionality.
  1539. You can for example define patterns for animations or picture lists.
  1540.  
  1541.    Usage is : MainView [-<options>] <file>
  1542.  
  1543.    You can enter as many files as you like.
  1544.  
  1545. MainView supports these options :
  1546.  
  1547.      -w           : enables the window mode
  1548.      -fi          : enables the frameinfo option
  1549.      -nc          : turns caching off
  1550.      -i           : ignore the icons for the animations/pictures
  1551.      -f           : enables the flash option
  1552.      -xvalue      : value describes the initial x offset
  1553.      -yvalue      : the same for the y offset.
  1554.      -rvalue      : value describes how often the animation
  1555.                     should be repeated
  1556.      -amodule     : where module is the default animation loader
  1557.                     for example `-aUniversal' selects the universal
  1558.                     loader (default).
  1559.      -pmodule     : where module is the default picture loader
  1560.                     for example `-aUniversal' selects the universal
  1561.                     loader (default).
  1562.                     If you want to remap your pictures to the
  1563.                     PicassoII board enter `-pUniversal_PicassoII'
  1564.  
  1565. Examples:
  1566.  
  1567. `MainView -nc -r1 Graphics:Pics/#? Animation/#?8_32' will show all
  1568. files in the Graphics:Pics/ directory as well as all files in the
  1569. Animation/ directory which end with '8_32' and all animations will be
  1570. directly played from the harddisk (one time).
  1571.  
  1572. `MainView -pUniversal_PicassoII Graphics:#?_24Bit' will display all
  1573. pictures which names end with '_24Bit' on the Picasso-II board.
  1574.  
  1575. Tutorial
  1576. ********
  1577.  
  1578.    This tutorial will try to (quickly) explain the tasks you can
  1579. perform with MainActor.  It is just meant to give you the idea behind
  1580. MainActor, you have still to read all of the documentation to get the
  1581. most out of MainActor.
  1582.  
  1583.    ALL SAVE OR APPEND FUNCTIONS ARE DISABLED IF YOU DONT HAVE A KEYFILE
  1584. (DONT HAVE REGISTERED MAINACTOR YET).  THE TASKS YOU CANNOT PERFORM IF
  1585. YOU DONT HAVE A KEYFILE ARE MARKED WITH AN *.
  1586.  
  1587. `This tutorial will tell you how to'
  1588.  
  1589. Load Animations
  1590. ===============
  1591.  
  1592.    You need an unused Project to load an animation into MainActor.
  1593. Select the `Select Load Module' gadget of the Project Window and select
  1594. the proper animation format (if you, for example, want to load an
  1595. IFF-Anim5 animation, select the IFF-Anim5 loader or the Universal
  1596. loader).  If you want to cache the animation (buffer the animation in
  1597. memory), enable the `Caching' gadget. Now select the `Load' gadget of
  1598. the Project Control Panel Window and select the animation in the
  1599. opening asl requester. MainActor will now examine the animation and
  1600. load it into memory (if caching is enabled).  After that the frames of
  1601. the animation are listed in the scroll list area of the project window,
  1602. also all gadgets (except the `Load' and perhaps the `Append' gadget) of
  1603. the Project Control Panel Window are now enabled.
  1604.  
  1605. Load Picture(s)
  1606. ===============
  1607.  
  1608.    You need an unused Project to load a picture or a picture list into
  1609. MainActor.  Select the `Select Load Module' gadget of the projects
  1610. window and select the proper picture format (if you, for example, want
  1611. to load an IFF picture, select the IFF loader).  If you want to cache
  1612. the picture(s) (buffer the picture(s) in memory), enable the `Caching'
  1613. gadget. Now select the `Load' gadget of the Project Control Panel
  1614. Window and select the first picture of the picture list in the opening
  1615. asl requester, if you want to load only one picture, you can cancel the
  1616. second requester, otherwise select the last picture of the picture list
  1617. in the second requester.  MainActor will now load the selected
  1618. picture(s) and buffer them into memory (if caching is enabled).  After
  1619. that the picture(s) are listed in the scroll list area of the project
  1620. window, also all gadgets (except the `Load' and `Play' and perhaps the
  1621. `Append' gadgets) of the Project Control Panel Window are now enabled.
  1622.  
  1623. Play Animations
  1624. ===============
  1625.  
  1626.    You have to load an animation first.  Just click on the `Play'
  1627. gadget of the Project Control Panel Window.  For further details have a
  1628. look into the documentation.
  1629.  
  1630. Show Pictures
  1631. =============
  1632.  
  1633.    You have to load an animation or a picture list first.  Select the
  1634. pictures you want to show in the source projects list view gadget,
  1635. after that simply press the `Show' gadget of the Project Control Panel
  1636. Window.  For further details have a look into the documentation.
  1637.  
  1638. Create/Convert Animations
  1639. =========================
  1640.  
  1641.    You have to load an animation or a picture list first.  Select the
  1642. pictures who shall be included in the new animation in the source
  1643. projects list view gadget. After that select the `Select Save Module'
  1644. gadget and select the proper animation format.  Now click on the `Save'
  1645. gadget of the Project Control Panel Window and enter the name of the
  1646. new animation.  MainActor will then create the animation, you may have
  1647. to answer some requesters (looping or non looping animation and so on).
  1648. For further details have a look into the documentation.
  1649.  
  1650. Save Pictures From Animations
  1651. =============================
  1652.  
  1653.    The procedure is exactly the same as before, just select a picture
  1654. save module instead of an animation module.  For further details have a
  1655. look into the documentation.
  1656.  
  1657. Convert Picture Formats
  1658. =======================
  1659.  
  1660.    The procedure is exactly the same as before, just load a picture or a
  1661. picture list and select another picture formats save module.
  1662.  
  1663. Append To Animations
  1664. ====================
  1665.  
  1666.    Load an animation or picture list into the source project and an
  1667. animation into the destination project.  The name of the source
  1668. projects saver module has to equal the name of the destination projects
  1669. saver module (Beware of the Universal loader !!) The `Append' gadget of
  1670. the Project Control Panel Window should now be enabled. Select the
  1671. pictures you want to append (to the destination project) in the source
  1672. project. After that select the `Append' gadget, MainActor will now
  1673. append the selected pictures of the source project to the animation in
  1674. the destination project.  For further details have a look into the
  1675. documentation.
  1676.  
  1677. Time Animations
  1678. ===============
  1679.  
  1680.    Load an animation and select the pictures you want to give a new
  1681. timecode.  Now select the `Select Timecode' item in the Miscellaneous
  1682. Menu and enter the new timecode into the integer gadget.  MainActor
  1683. will now write the new timecodes to the animation, you can check the
  1684. new timecodes by playing the animation.
  1685.  
  1686. Execute Arexx Scripts
  1687. =====================
  1688.  
  1689.    You can directly execute arexx scripts by selecting the `Start Arexx
  1690. Script' item in the Arexx Menu and selecting the arexx scripts.  You
  1691. can map arexx scripts to the function keys through the `Install Arexx
  1692. Scripts' item (again in the Arexx Menu). You can really speed up your
  1693. work by using them, take a look at their header to get a short
  1694. description what they do.
  1695.  
  1696. Show Pictures/Animations On The PicassoII
  1697. =========================================
  1698.  
  1699.    Just use the `Universal_PicassoII' loader modules, they remap the
  1700. output of every module to the picasso board.  Note that it is faster to
  1701. view animations of the bitmap formats (like Anim-5,7,8) on the native
  1702. chipset as these formats have to be converted to the picassos chunky
  1703. pixel mode.
  1704.  
  1705. Registration
  1706. ************
  1707.  
  1708.    The registration fee is `$50' (85 german marks) or any aquivalent
  1709. sum in your local currency.
  1710.  
  1711.    You will get your keyfile per disk or email.  If you have an email
  1712. address, please include it in your letter.
  1713.  
  1714.    When the printed manuals are ready, you will get one.  If you dont
  1715. have ftp access and cant get the updates this way, two free (disk
  1716. based) updates are included in the shareware fee.  You have to contact
  1717. me everytime you want me to send you an upgrade.
  1718.  
  1719. You can send cash or international money order to
  1720.  
  1721.      Markus Moenig
  1722.      Bruesseler Ring 61
  1723.      52074 Aachen
  1724.      Germany
  1725.      Tel.: (49)-241-71844
  1726.  
  1727. If you prefer direct transfer:
  1728.  
  1729.      Markus Moenig
  1730.      NO. 20011672
  1731.      Stadtsparkasse Aachen
  1732.      BLZ 390 500 00 (Germany)
  1733.      Usage: MainActor
  1734.      PLEASE INCLUDE YOUR NAME ON THE TRANSFER ORDER !!
  1735.  
  1736. If you have questions/suggestions feel free to contact me through email:
  1737.  
  1738.      Fido        2:242/7.13
  1739.      Internet    moenig@pool.informatik.rwth-aachen.de
  1740.      ADSP        markusm@tolkien.adsp.sub.org
  1741.  
  1742. The Future
  1743. **********
  1744.  
  1745. Future enhancements which are on my list:
  1746.  
  1747.    - an animation loader/saver for VRLIs Vista Pro format (VANIM)
  1748.  
  1749.    - mpeg and Jpeg loader
  1750.  
  1751.    - more picture and animation modules (in general)
  1752.  
  1753.    - user defineable shortcuts ala TurboText
  1754.  
  1755.    - support of more 24 Bit modules, for example more modules for
  1756.      graphiccards
  1757.  
  1758.    - more powerful arexx commands (for example : syncing arexx commands
  1759.      to animations)
  1760.  
  1761.    - far more arexx scripts (sinus (de)-acceleration scripts and more)
  1762.  
  1763.    - German documentation
  1764.  
  1765.    - sending printed manuals to registered users
  1766.  
  1767.    - the whole MultiMedia stuff ...
  1768.  
  1769.    In the long run i want to make a complete `MultiMedia' package out
  1770. of MainActor with Sound and Effect modules.  The planned sample per
  1771. frame option is the first step in that direction, instead of
  1772. integrating the samples in the animations/pictures itself, there will
  1773. be a new module type : Sound.  You will be able to associate sound
  1774. modules to every frame/picture. Sound modules could for example be
  1775. samples or protracker play routines.
  1776.  
  1777. Credits
  1778. *******
  1779.  
  1780. This package was developed by usage of the following products:
  1781.  
  1782.    - Dice, from Obvious Implementation Corp
  1783.  
  1784.    - Devpac 3.04, from HiSoft
  1785.  
  1786.    - WShell2.0 and Arexx, from Wishful Thinking Corp
  1787.  
  1788.    - TurboText from Oxxi
  1789.  
  1790.    - ToolManager from Stefan Becker
  1791.  
  1792.    - MultiTool II from Boris Jakubaschk
  1793.  
  1794. Thanks for producing high quality software.
  1795.  
  1796. Special thanks to:
  1797.  
  1798.    - Stefan Becker for his Amiga knowledge, without him this project
  1799.      would not have been become possible
  1800.  
  1801.    - all GAMMA and BETA testers
  1802.  
  1803.    - Norbert Bogenrieder for the icons
  1804.  
  1805.    - Paul van der Heu for the original Amigaguide conversion of the docs
  1806.  
  1807.    - Jesper Juul for his optimizing suggestions
  1808.  
  1809. Index
  1810. *****
  1811.  
  1812.  
  1813.  
  1814.  Amiga                                  What is MainActor ?
  1815.  Anim Universal                         Anim Universal
  1816.  Anim Universal_PicasssoII              Anim Universal_PicassoII
  1817.  Append                                 Append
  1818.  Append To Animations                   Append To Animations
  1819.  Arexx Menu                             Arexx Menu
  1820.  ASDG                                   IFF-Anim8
  1821.  Convert Picture Formats                Convert Picture Formats
  1822.  Create/Convert Animations              Create-Convert Animations
  1823.  Credits                                Credits
  1824.  Dan Silva                              IFF-AnimBrush
  1825.  DeSelectAll                            DeSelectAll
  1826.  DeSelectRange                          DeSelectRange
  1827.  DeSelectRangeRequest                   DeSelectRangeRequest
  1828.  Electronic Arts                        IFF-Anim5
  1829.  Electronic Arts                        IFF
  1830.  Execute Arexx Scripts                  Execute Arexx Scripts
  1831.  Features                               Features
  1832.  GetSPInfo                              GetSPInfo
  1833.  GetSPLoader                            GetSPLoader
  1834.  GetSPName                              GetSPName
  1835.  GetSPSaver                             GetSPSaver
  1836.  IFF                                    IFF
  1837.  IFF-Anim5                              IFF-Anim5
  1838.  IFF-Anim7                              IFF-Anim7
  1839.  IFF-Anim8                              IFF-Anim8
  1840.  IFF-AnimBrush                          IFF-AnimBrush
  1841.  Installation                           Installation
  1842.  Introduction                           Introduction
  1843.  Load Animations                        Load Animations
  1844.  Load Picture(s)                        Load Picture(s)
  1845.  LoadProject                            LoadProject
  1846.  MainActor Preferences Window           MainActor Preferences Window
  1847.  MainView                               MainView
  1848.  Miscellaneous Menu                     Miscellaneous Menu
  1849.  New features in v1.1                   New features in v1.1
  1850.  OpenNewProject                         OpenNewProject
  1851.  OS 3.0                                 Project Control Panel Window
  1852.  PCX                                    PCX
  1853.  Picture Universal                      Picture Universal
  1854.  Picture Universal_PicassoII            Picture Universal_PicassoII
  1855.  Play Animations                        Play Animations
  1856.  PlayProject                            PlayProject
  1857.  PrintAndStoreTxt                       PrintAndStoreTxt
  1858.  PrintTxt                               PrintTxt
  1859.  Project Control Panel Window           Project Control Panel Window
  1860.  Project Menu                           Project Menu
  1861.  Project View Settings Window           Project View Settings Window
  1862.  Project Window                         Project Window
  1863.  Quit                                   Quit
  1864.  Registration                           Registration
  1865.  RequestInteger                         RequestInteger
  1866.  Save                                   Save
  1867.  Save Pictures From Animations          Save Pictures From Animations
  1868.  ScreenToBack                           ScreenToBack
  1869.  ScreenToFront                          ScreenToFront
  1870.  SelectAll                              SelectAll
  1871.  SelectRange                            SelectRange
  1872.  SelectRangeRequest                     SelectRangeRequest
  1873.  SetSPLoader                            SetSPLoader
  1874.  SetSPSaver                             SetSPSaver
  1875.  SetTimecode                            SetTimecode
  1876.  SFCP_PicassoII                         SFCP_PicassoII
  1877.  Show Pictures                          Show Pictures
  1878.  Show Pictures/Animations On The PicassoIIShow Pictures-Animations On The PicassoII
  1879.  ShowPictures                           ShowPictures
  1880.  Super Fast Chunky Pixels               SFCP_PicassoII
  1881.  SwapDeActivatedToSource                SwapDeActivatedToSource
  1882.  SwapProjects                           SwapProjects
  1883.  System Preferences Window              System Preferences Window
  1884.  Text Buffer Menu                       Text Buffer Menu
  1885.  Text Buffer Window                     Text Buffer Window
  1886.  The Animation Modules                  The Animation Modules
  1887.  The Arexx Interface                    The Arexx Interface
  1888.  The Future                             The Future
  1889.  The Menus                              The Menus
  1890.  The Modules                            The Modules
  1891.  The Picture Modules                    The Picture Modules
  1892.  The Windows                            The Windows
  1893.  Time Animations                        Time Animations
  1894.  Tutorial                               Tutorial
  1895.  UnloadProject                          UnloadProject
  1896.  Version                                Version
  1897.  Warm Up                                Disclaimer
  1898.  WBToFront                              WBToFront
  1899.  What is MainActor ?                    What is MainActor ?
  1900.  Windows Menu                           Windows Menu
  1901.  Wolfgang Hofer                         IFF-Anim7
  1902.  Workbench-Icon                         Workbench-Icon
  1903.  ZSoft                                  PCX
  1904.  
  1905.