Masquerade is a powerful facial animation tool for Alias Maya

Note:
* indicates a known bug or problem.
`character name` is used to represent the user defined character name given in creating a control mask.
`curve name` is used to represent any of the control curves, eye brows, eyes, or mouth.

 

Installing Masquerade:


1. Copy the script Masquerade.mel to your local scripts directory
C:\Documents and Settings\"USER"\My Documents\maya\6.0\scripts\

2. Copy the Masquerade_icons folder to your icons directory
C:\Documents and Settings\"USER"\My Documents\maya\6.0\prefs\icons\

If you want Masquerade to launch automatically, copy userSetup.mel to your scripts directory.
If you already have a userSetup.mel file, add, "Masquerade;" to it.

3. Launch Maya

4. If "Masquerade;" is not in a userSetup.mel file, type "Masquerade;"
into Maya's command line, and press "Enter".

If you are viewing this page through Maya 6's web browser click here. It will do step 4 for you.

 

Masquerade in Maya


  • About Masquerade: Displays author and copyright information about Masquerade.
  • Create Control Mask: Creates a control mask.
  • Launch Masquerade: Launch selected character in Masquerade; if no character is selected, the Character List will appear.
  • Launch Masquerade With: This submenu contains a menu for every character in the scene. Each menu will launch the character in Masquerade.
  • Character to Shelf: Creates a shelf button that will launch selected character in Masquerade. If no character is selected, the Character List will appear. When the shelf button is pressed, the character is launched in Masquerade regardless of the current selection. If the character is not found in the scene, a window will be displayed asking the user if they want to import or reference the character into the scene.
  • Delete Selected Mask: Deletes selected control mask, its camera rig, and layer. If no character is selected, the Character List will appear.
  • Auto Launch Masquerade: This will toggle Auto Launch Masquerade on or off.
  • Frame HUD: This will toggle the Current Frame HUD on or off.
  • Masquerade Info HUD: Toggle the Masquerade info HUD on or off. This HUD reports the state of Auto Launch Masquerade.
  • Sound Manager: Launches the Sound Manager.
  • Frame/Time Converter: Launches Frame/Time Converter.
  • Masquerade/Persp: Displays Masquerade Panel and Persp.
  • Masquerade/Persp/Graph Editor: Displays Masquerade Panel, persp and graph editor.
  • Add Atributes: Launches Load Attribute.
  • Prefix/Suffix: Launches Rename Attributes.
  • Remove Attributes: Removes selected attributes. This does not delete the attibute; it simply makes it unkeyable and locked so the user can reactivate it at any time.
  • Get A Face Lift: This will bring the user to the download section to check for updates or new versions.
  • Masquerade Home Page: Launches the Masquerade home page.
  • Help: Opens this site

All menu items have shelf buttons associated with them, except "Auto Launch", "Frame HUD", "Info HUD". Because they are check boxes, shelf buttons for these options will have no effect. To add a shelf button to the current shelf , hold shift+ctrl and click on the menu item.


Shelf

When Masquerade is launched, it creates a shelf and menu set. If you do not like using shelves, type "maskShelf off;" into Maya's command line and press "Enter". When Masquerade is launched now, no shelf will be created. If you want to turn the shelf creation on, type "maskShelf on;".

If you are viewing this page through Maya 6's web browser click below.

 

Create Control Mask


Masquerade is based on a "Control Mask" which is made of nurbs curves. When the user starts Masquerade, they are prompted to give a character's name. After the name is entered, a control mask and layer are created. The "Font Options" check box allows the user to chose a font for the character's label. If "Font Optons" is not checked, Time Roman Numeral is used as the font. The character's name cannot contain any spaces or symbols.


Next the user defines which attributes are going to be used in Masquerade and which tabs they go into. This is done by adding attributes to the "Load Attributes" window, then designating what attributes go in each tab. To add attributes to the list select them in the channel box and press "Add attributes to list".

For blend shapes, launch the blend shape editor and press "Select". The blend shapes will appear in the channel box. Select the attributes to be used and load them into the list. Any type of character setup will work with Masquerade, whether it is joint, blendshape, or lattice. Masquerade can control any attribute in Maya*.

With the attributes in the list and the control mask selected, press the button for the appropriate tab (eye brows, eyes, mouth). This will transfer and link your attributes to new attributes in the control mask. When the Masquerade interface is launched, it looks for attributes in the control mask; all attributes found in "`character name`_LeftEyeBrowControl" are put into the eye brow tab, "`character name`_LeftEyeControl" are put in the "Eyes" tab, and "`character name`_MouthControl" are placed in the "Mouth" tab. This makes the process non-linear because attributes can be added, removed, and/or renamed at any time.

Once all attributes are transferred, select the control mask and the character's head joint, press "Finished".

This will move the control mask to the top of the character's head and parent it to the head joint*. This also creates the face camera used in the Masquerade interface, which is set to always pivot around the head. A locator is also created that is part of the camera rig.

 

Masquerade


Menu
  • Save Scene: Same as Maya, saves the current scene.
  • Save Scene As: Same as Maya, saves the current scene under a different name.
  • Import: Same as Maya, imports a scene into the current one.
  • Masquerade Info HUD: This head up display shows the Auto Launch state.
  • Set Window Size: This will set Masquerade to always launch at the current window size.
  • Reset Window Size: This will reset Masquerade to its default size*.
  • Resize Attributes Tab: The attribute tabs can be scaled. This changes how much it is scaled, 10, 20, or 50 pixels.
  • Character To Shelf: Creates a shelf button that launches the character in Masquerade, regardless of what is selected. If the character is not found in the scene, a window will be displayed asking the user if they want to import or reference the character into the scene.
  • About Masquerade: Displays author and copyright information about Masquerade.
  • Help: Opens this site.
  • Close: Closes the Masquerade interface.
  • Undo: Same as Maya, undo last action.
  • Redo: Same as Maya, redo last action
  • Clear Undos: Clears undos from memory.

  • Select Camera: Selects the character's face camera.
  • Points: Display objects in face camera view as points.
  • Wireframe: Display objects in face camera view as wireframe.
  • Flat Shaded: Display objects in face camera view as flat shaded.
  • Smooth Shaded: Display objects in face camera view as smooth shaded.
  • Texture Shaded: Display objects in face camera view as texture shaded.
  • Wireframe on Shaded: Display objects in face camera view as wireframe on shaded.
  • Isolate Selected: Isolates selected objects in face camera view
  • Single: Displays the face camera view as a single panel.
  • Split View: Use any camera in the scene in a horizontal split panel view with the face camera.
  • Time Editors: Masquerade can use several animation editors in single or vertical split panel formations.
  • Heads Up Display: All HUD can be controlled through Masquerade, including custom ones that display the Current Frame and the Auto Launch state.
  • Graph Editor: Opens the graph editor in its own window.
  • Trax Editor: Opens the trax editor in its own window.
  • Dope Sheet: Opens the dope sheet in its own window.
  • Outliner: Opens an outliner in its own window.
  • Hypergraph: Opens hypergraph in its own window.
  • Channel Control Editor: Opens the channel control editor.
  • Attribute Editor: Opens the attribute editor.
  • Atribute Spread Sheet: Opens the attribute spread sheet.
  • Sound Manager: Launches the Sound Manager.
  • Frame/Time Converter: Launches Frame/Time Converter.
  • Fps: The frames per second can be changed from this submenu.
  • Looping: The looping state of the play back changed in this submenu.
  • Frame HUD: Toggle the Current Frame heads up display on or off.
  • Time Code: Toggle a time code in the time slider on or off.
  • Play Blast: This submenu contains options to play blast to fcheck, window media player or open the Maskblast options.
  • Animation Preferences: Opens the animation preferences.
  • Key All: Sets a key frame on every attribute in the control mask.
  • Remove All Keys: Removes every key frame in every attribute in the control mask.
  • Reset: Resets every attribute in the control mask to its defult value. This does not assume that the attributes are blend shapes and reset their values to zero. Masquerade determines the attribute's default value is and sets it as the value.
  • Show Window Command: Toggle whether the Button Command window is shown before creating a pose button.
  • Create Pose: This sub menu contains Create Pose, Create Pose for eye brows, eyes or mouth, and Create Pose for all.
  • Save Pose Library: Saves the current pose library.
  • Auto Save Pose Library: Toggle auto save pose library. If "on", the pose library will be saved every time a pose button is created.
  • Import Library: Import a designated pose library.
  • New Library: Clear the current library.
  • Delete Library: Deletes the character's pose library and all images associated with it.

 

Face Camera View

The face camera is viewed in a single panel by default.


The panel can also be viewed in a horizontal split. Any camera in the scene can be used in the second view.


This second panel could also be used to rotoscope animation.

 

Toolbox
The Toolbox contains translate, rotate, and scale buttons. It also contains buttons to change the state of the face camera and animation editor panels. The first button in the second column will toggle the camera view panel between single and split. More options are available in Panels>Split View. The next button will change the animation editor panel to Trax Editor over Graph Editor. The last button will change the panel to Dope Sheet over Graph Editor. More options are avaliable in Panels>Time Editors .

 

Selection Image


The selection image will select the character's control curves and display them in the animation editors and channel box.

The curves are selected through menus accessed by left clicking on the portions of the image. These menus will dynamically update based on what is selected. If nothing is selected, the menus will only have "Select `curve name`"; if anything is selected, the menu will display "Select `curve name`" and "Add `curve name`". If the curve is already selected, the menu will display "Deselect `curve name`".

The top of the image contains additional menus that can be accessed by right or left clicking.

The image changes to show the user what is selected.

 

Face Camera Control

The camera slider rotates the camera around the character's head regardless of where the character is. The slider can control every rotation axis of the camera, right clicking on the slider will display a menu to chose what axis to rotate on.

Left clicking on the camera icon will snap the camera to orthagraphic
(-90, 0, 90, 180) views on the current axis.

 

Time Controls

Masquerade contains similar control as Maya for playing back animation. In addition Masquerade allows the user to toggle the play back looping state, which can also be changed in the Time>Looping menu or in the popup menu on the time slider (below). Masquerade also contais auto frame which toggles Maya's auto key frame.

 

 

Masquerade contains a time slider like Maya's. Right clicking on the time slider will display options that are also found in the Time menu.

 

Attributes


When Masquerade is launched, it places all the attributes found in the "`character name`_LeftEyeBrowControl" in the "Eye Brows" tab, all attributes in "`character name`_LeftEyeControl" are put in the "Eyes" tab, and attributes in "`character name`_MouthControl" are placed in the "Mouth" tab.

At the top of the attribute tabs are buttons.
  • Create Pose Button: Creates a pose button containing every attribute in the tab.
  • Key All: Key frames every attribute in the tab.
  • Remove All Keys: Removes all the key frames for every attribute in the tab.
  • Reset: Resets every attribute in the tab to its default value. (Note: this does not assume that the attributes are blend shapes and reset their values to zero. It figures out what the attributes default value is and sets it as the value.)
  • Check Key: Opens Check Key.
Along with an attribute slider, each attribute has a key, auto key and step key controls.
  • Step Key: These three buttons will allow the user to step through the key frames of that attribute. "<" steps to previous key frames. ">" steps to the next key frame. The check box allows the user to set or remove key frames. It also shows if the attribute has a key frame at the current frame.
  • Set Key: Sets a key frame on the attribute.
  • Auto Key Frame: If "on", a key frame will be set whenever the slider's value is changed.
  Label weidth is determined by the length of the longest attribute name.

 

Check Key

Check Key allows for a number of key frames to be set very fast. A window will display every attribute in the tab. Placing a check next to the attributes will place a key frame when "Key Checked" is pressed.

 

Pose Library

The Pose Library is Masquerade's most powerful feature. It allows the user to save facial expresions to buttons; these buttons are saved to an external file that can be shared across networks or distributed to off-site animators.

Click here to see a example of a pose library file.

  • Create Pose Button: Creates a pose button using every attribute in the control mask.
  • Check Pose: Launches Check Pose.
  • New Library: Removes all pose buttons.
  • Load Library: Imports a designated pose library.
  • Save Library: Saves the current pose Library. Pose libraries are saved in the "Pose" folder of the "Masquerade" folder in your project directory as "`character name`PoseLibrary".
  • Auto Save Pose Library: Toggles auto save pose library on or off. If "on", the pose library is saved every time a pose button is created.
  • Delete Pose Library: Deletes the pose library file and all images associated with it.
  Right clicking on a pose button will display a menu to change the label, image, and command*. This menu also allows the user to delete a pose button.

 

Check Pose

Check Key will allow the user to chose which control curves are used in creating the pose library. Pose buttons do not have to be created for the whole face. Poses can be created for just the eye brows, eyes, mouth or any combination of these. This allows the user to mix and match poses.

 

Pose Button Options
The pose button creator allows the user to define the pose button's label and background color. The background color is set by clicking on the color portion of the slider. The colors can be saved as a "Quick Pick Button"*. The buttons are saved to an external file. The Quick Pick Buttons are created through the "Colors" menu. The ability to change the background color was designed to color code pose buttons.

 

Pose Command Window

In the Pose Library menu, the command window can be turned on, If on a window will be displayed before the Pose Creator window is. This window shows the user which attributes will be affected by the pose button. These values can be changed; what ever is in the window will be put into the pose button. Note to Technical Directors: Custom commands can be put in the window and will execute when the button is pressed.

 

Channel Box


Masquerade contains its own channel box and layer editor*. At the top of the channel box are options similar to Maya. On the left are buttons to display only the channel box, only the layer editor, or the layer editor and channel box. Right clicking on the attributes in the channel box will display a menu to key selected, key all, and remove key frames.

Right clicking on the layer editor will display a menu containing options to change the layer states, visibility, templated, referenced, or normal.

The size of the tab can be changed by the two buttons at the bottom of the tabs. The left will increase the size of the tabs and the right will decrease the tab size. The attribute tab can be resized by 10, 20 , or 50 pixels. This value is changed in the Masquerade menu set.
Masquerade Interface>Masquerade>Resize Attributes Tab

 

Maskblast

Maskblast is similar to Maya's Playblast window. Maskblast also allow the user to define the start and end time for the playblast and only works with the face camera.

 

Panel

Masquerade, in addition to the window, can be viewed as a panel that contains similar features to the window.

 

Panel Menu

  • Masquerade Info HUD: Toggle the Masquerade Info HUD that will display the state of Auto Launch Masquerade.
  • About Masquerade: Displays author and copyright information about Masquerade.
  • Help: Opens this site.
  • Sound Manager: Launches the Sound Manager.
  • Frame/Time Converter: LaunchesFrame/Time Converter.
  • Fps: The frames per second for your animation can be changed from this submenu.
  • Looping: The looping state of the play back changed in this submenu.
  • Frame HUD: Toggle the Current Frame heads up display "on" or "off".
  • Time Code: Toggle a time code in the time slider on or off.
  • Animation Preferences: Opens the animation preferences.
  • Load Character: Loads selected character into panel. If no character is selected, the Character List is displayed.
  • Load With: Submenu containing a menu for every character in the scene. The menu will load the character into the Panel.
  • Key All: Sets a key frame on every attribute in the control mask.
  • Remove All Keys: Removes every key frame in every attribute in the control mask.
  • Reset: Resets every attribute in the control mask to its default value. Note: This does not assume that the attributes are blend shapes and reset their values to zero.Masquerade determines the attribute's default value and sets it as the value.
  • Attributes: Options for attributes.
  • Launch Masquerade: Launches Masquerade with the character currently in the panel.
  • Masquerade/Persp: Displays the saved layout for the Masquerade Panel and persp view.
  • Masquerade/Persp/Graph Editor: Displays the saved layout for the Masquerade Panel, persp view and graph editor.
  • Hide UI Elemets: Same as Maya, hides all UI Elements.
  • Show UI Elemets: Same as Maya, shows all UI Elements.
  • Masquerae UI Set: Turns off all UI elements except time and range slide (seen below).

 

Prefix/Suffix

This allows the user to add prefixs and/or suffixs to attribute names.

 

Sound Manager

Sound Manager will help manage sound files in Maya. The window displays every sound file in the scene, as well as options for importing, displaying and deleting sound files. Double clicking on a sound in the list will display its attibute editor. Selecting a sound in the list and pressing the delete key will delete it from the scene.

 

Frame/Time Converter

Frame/Time converts frames to time and time to frames. The scenes frame rate is used by default but any frame rate can be used in the conversion. Right clicking on the absolute frames field will display options to "Get Current Time", "Get End Time", "Set End Time", and "Set End Playback Time".

 

Character List

Many commands in Masquerade execute using a selected control mask. If no control mask is selected and there are one or more control masks in the scene, this window will appear, listing every control mask in the scene. Double clicking or selecting the control mask from the list and pressing "OK" will execute the command with the control mask.

 

Auto Launch
If "On", Masquerade will be launched whenever a control mask is selected.

 

Masquerade Info HUD
Displays the auto launch state of Masquerade.

 

Current Frame HUD

Displays the current frame*.

 

Known Bugs and Other Notes
  • Attributes with no min, max, or default value not supported by "Load Attribute". For these type of attributes the link will have to be made manually. Create a new attribute in the appropriate curve in the control mask. Then in Maya's connection editor, link the new attribute to the desired one.
  • Although the position of the control mask does not matter, it does not always snap to the characters head joint.
  • The default size of Masquerade is set for Windows XP, windows in XP are 10 pixels larger than those in classic.
  • Changing the pose buttons label and image only affects the pose buttons in the panel until the library is saved and re-imported. The "change command" option does not work.
  • The "Auto Save Pose Button" menu is always set to off; it does not remember its value.
  • Layer Editor only updates new layers when Masquerade is launched. Panel Layer Editor does not update until new scene is opened.
  • Display Current Frame HUD does not work for playblasts.
Special thanks to John Liebler for allowing me to use his Spock model.
For more information, e-mail David Keegan
© David Keegan 2004