------------------------------------------------------------------------------
                                  DPK_animUI
------------------------------------------------------------------------------

Version: 2.1.8
   Date: Mar 30, 2011


---------
Contents:
---------
1. Installation
2. Version History
3. Known Issues
---------



---------------
1. Installation

Extract the file you've downloaded and copy the ".mel" file(s) into your
scripts directory (e.g.: ../maya/scripts). To use the scripts conveniently,
you should consider creating a shelf button with the following command:
    DPK_animUI 1;

Note that the "1" is an important part of the command, so be sure to copy the
whole line.

The documentation is in the "docs" folder. I strongly recommend you keep it
and open the "index.html". From there you can easily get to the Manual and
Quick Start.


- The AnimUI in a Panel -
To open the animUI in a panel, click on an existing panel's "Panels" menu
(e.g. in the Outliner) and choose "Panel" and then "DPK_animUI". In case it is
not listed under the "Panel" menu, you have to source the DPK_animUI script.

To avoid having to manually source the script every time Maya is started, you
can place the following line into your "userSetup.mel" script:
    DPK_animUI 0; DPK_animUI_registerPanel;

If you don't know where to find/create the "userSetup.mel" script or what it
is, simply search the Maya help for "userSetup". One of the results should be
"Run MEL commands whenever Maya starts up".


------------------
2. Version History

Version 2.1.8
    - Compatibility fixes for Maya 2011 on Windows and Linux


Version 2.1.7
    - Added option to section list to select all attributes of the selected
      sections. This is useful e.g. for showing only the keys of some sections
      in the timeline or the Graph Editor.
    - Added a similar option "Sync with Scene-Selection" that selects the
      attrs every time the list is clicked for faster workflow
    - Small bug fixes (renaming ctrl object after GUI has been re-opened works)


Version 2.1.6
    - Fixed a problem of missing mel scripts


Version 2.1.5
    - Made the GUI Linux compatible
    - The section list now has the "view" popup menu on CTRL+right-click
      instead of middle-click for Linux compatibility
    - Since Linux doesn't support marking menus on sliders, alternative slider
      menus were added above the preset slider and the attribute sliders (the
      latter can be switched on and off in the Options)
    - Corrected some drawing issues when expanding/collapsing slider areas
    - Tiny change for x64 compatibility
    - Other minor bug fixes


Version 2.1.4
    - Added option to defer the preset slider reset so that further tweaks to
      the mix are possible
    - Added "Set To Zero" command for use in deferred mode of preset slider
    - Added "Undo Last Dragging" command for the preset slider when not in
      deferred mode
    - Added configurable preset slider ranges (for normal and relative modes)
    - Minor changes to the option layout


Version 2.1.3
    - Added option to apply presets "relatively"
    - Fixed a small bug where the preset slider stopped to work in rare cases


Version 2.1.2
    - Added option to lock/unlock and mute/unmute attributes of individual
      sections
    - Added option to the preset list to flip presets left/right
    - Added option to the preset list to set a keyframe on all attributes that
      "would" be affected when applying the preset(s)


Version 2.1.1
    - Added options for hiding the "Select" and "Key All" button
    - Minor GUI changes (annotations, corrected button label, etc.)


Version 2.1.0
    New Features:
    - The preset library can now import and export sections

    Bug Fixes:
    - Importing a preset with attrs that don't exist now produces a warning
      instead of an error
    - When the animUI is started in window mode while it is currently opened
      in a panel, a valid alternative panel is now left behind
    - Other minor bug fixes
    - Minor corrections in the manuals


Version 2.0.3
    - Added an option that controls whether the numeric field resets its focus
      after a value is entered (default is on). Disable this option when you
      have problems using the animUI in panel mode.
    - When switching between different setups, sliders of attrs that were
      locked didn't wake up correctly
    - The main UI didn't refresh when the Section Manager was closed and the
      animUI was used as a panel


Version 2.0.2
    - Added the option to hide the "Key" button next to each attr slider


Version 2.0.1
    - The AnimUI can now be opened in a panel (see installation instructions)
    - Fixed a bug that occured when the script was sourced before the bcs
      plugin was loaded


Version 2.0
    This is a complete rewrite of the script. Here are some things that have
    changed:
        - Changed the name from DPK_animationInterface to DPK_animUI
        - Attributes of more than one object can now be part of one setup
        - Attributes can be excluded from presets
        - The preset slider uses just one slot in the undo queue
        - The left-right recognition is now configurable
        - Added top-bottom symmetry, syncing, and mirroring
        - Added a preset manager for creating preset libraries
        - The lists now have marking menus for reaching menu items faster
        - A script collection in DPK_animUISetup.mel allows you to query, edit
          and create animUI setups. This should help in integrating the animUI
          into almost any pipeline.
        - Added "real" help docs
        - and more...


Version 1.13
    - Added support for elements of multi attrs


Version 1.12
    - The attributes that store presets aren't locked anymore. This allows you
      to add/remove/change presets of a referenced anim node. To make it work
      with existing anim setups, you'd need to unlock the presets in the
      original scene. This can be done by adding and removing a preset.


Version 1.11
    - Presets can now be applied to either the left or right side
    - You can set keys for the selected sections through the context menu


Version 1.00
    - Initial release (I think ;)


---------------
3. Known Issues

- The Preset/Section Library doesn't store the left-right and top-bottom
  configuration of attributes in section entries.

- Without the DPK_bcs plugin, using the attr sliders and the preset slider
  will flood the undo queue. This means that you can't use undo/redo after
  using them.


--------------
If you have any questions, comments, or suggestions, please email me at:
daniel@dpk.stargrav.com

Daniel Pook-Kolb
