	CC_replaceShapeKey readme



/// CONTACT

Christopher Crouzet <christopher.crouzet@gmail.com>
http://www.christophercrouzet.com




/// DESCRIPTION

This plug-in contains a command that acts the exact same way than the built-in "ReplaceShapeKey" 
command except that this one retrieves the deform operations on the stack and apply them to 
the desired shape key without adding the other active shape key deformations.

As a result, you can have several shape keys active (with values different than 0) and apply 
your modifications to only one without taking in consideration the deformations added by the others.
It prevents the user from having to manually reset all other shape keys values to 0 before updating 
a shape key.

If you fire the "CC_replaceShapeKey" command on a bunch of objects containing some shape keys, a 
custom property will popup to help with the process. Otherwise you can directly process the operation 
by script by pointing the first argument of the command to a valid shape key.




/// FEATURES

- replace a shape key with the current shape of the geometry minus the deformations added 
  by the other active shape keys.
- provide an interface to intuitively replace the shape keys.




/// PLUG-IN ITEMS

___ commands

- CC_replaceShapeKey(selection)
    Replaces a shape key with the current shape of the geometry minus the deformations added 
    by the other active shape keys.

    \param selection  (XSICollection)  Input shape key to replace.
                                       If the collection contains some X3DObject, a property is 
                                       created on those objects to help with the process.



___ menus

- replaceShapeKey
    Menu item accessible via the "Shape" menu.
    Fire a simple call to the "CC_replaceShapeKey" command with the default arguments.



___ properties

- CC_replaceShapeKeyProp
    Helper property.




/// INSTALLATION

- copy the "CC_replaceShapeKey.dll" file to your "{XSI_USER_PATH}/Application/Plugins/" directory.
- update your XSI plug-ins using the "Plugin Manager" if necessary.




/// CHANGELOG

___ v1.0 - July 12, 2009

- initial release.