Retargeter MEL Commands [Maya]

Brian Genna -

(This documentation is a work in progress.  Please check back for updates.)

 

 

ftiRetarget - Retargets a Pose Group and Frame Range.

Usage: 

// Arguments: Pose Group, Frame Range, Autosolve On or Off (Boolean) 
ftiRetarget "Mouth" "All Frames" -as true ;

 

ftiOpenPerformance - Loads a performance in Retargeter.

Usage:

// FWR File, XML File, Options On or Off (Boolean)
ftiOpenPerformance "C:/PerformanceFile.fwr" "C:/CharacterFile.xml" -fr True -pr True -a False -v False -as True ;

 

Optional Arguments:

  • -fr = set fps
  • -pr = set playback range
  • -a = import audio
  • -v = import video
  • -as = run AutoSolve

 

 

 

Retargeter – Opens the main Faceware Retargeting window.

 Usage:

  • Example: Retargeter ;

 

 ImCharacterSetup – Opens the Faceware Character Setup window.

 Usage:

  • Example: ImCharacterSetup ;

 

 ImAddPose - Adds a Pose to a Face Group

Usage: 

  • 3 Arguments - Face Group Name (String), Frame Number (Integer), Pose Description (String)
  • Example: ImAddPose "Brows" 10 "My Pose Description" ;

 

ImUpdatePose – Updates a pose(equivalent of the ‘Update’ button).

 Usage:

  • 2 Arguments – Pose Group Name (String) and Frame Number (Integer)

  • Example: ImUpdatePose “Mouth” 54 ;

 

ImCreateNetworkDatabase - Creates a Shared Pose Database

Usage: 

  • 1 Argument - .FWSP file path (String)
  • Example: ImCreateNetworkDatabase "C:/!Testing/Victor_SP.fwsp" ;

 

ftiLoadSharedPoseDatabase – Loads a Shared Pose Database file to be used.

Usage:

  • 1 Argument - .FWSP file path (string)

  • Example: ftiLoadSharedPoseDatabase “C:/faceware/sharedposes.fwsp” ;

 

ImUpdatePoseSelected – Sets a pose to on or off (equivalent of the checkbox to the left of the pose).

 Usage:

  • 4 Arguments – Pose Group Name (String), Frame Range (String), Frame Number (Integer), On or Off (Boolean)

  • Example: ImUpdatePoseSelected “Mouth” “All Frames” 122 false ;

 

ImAddSharedPose – Adds the pose to the Shared Pose Database.

Usage:

  • 2 Arguments – Pose Group Name (String), Frame Number (Integer)

  • Example: ImAddSharedPose “Mouth” 122 ;

 

ImRevertToPoses – Reverts to poses only. Removes in-between animation.

Usage:

  • 2 Arguments – Pose Group Name (String), Frame Range (String)

  • Example: ImRevertToPoses "Mouth" "All Frames" ;

 

ImClearAllKeys – Clears all keyframes within the specified group and range.

Usage:

  • 2 Arguments – Pose Group Name (String), Frame Range (String)

  • Example: ImClearAllKeys "Mouth" "All Frames" ;

 

ImSetPlaybackRange – Sets the scene timeline to match the videos range.

Usage:

  • Example: ImSetPlaybackRange ;

 

ImSetSceneFrameOffset – Sets the scene’s frame offset for current job.

 Usage:

  • 1 Argument – Offset (Integer)

  • Example: ImSetSceneFrameOffset 21 ;

 

ImUpdateSharedPoses – Updates the user’s shared poses if the database has been updated.

 Usage:

  • 1 Argument – Pose Group Name (String)

  • Example: ImUpdateSharedPoses “Mouth” ;

 

ImDefaultCurrentFrame – Sets all controllers in specified Pose Group to their default value on the current frame.

Usage:

  • 1 Argument – Pose Group Name (String)

  • Example: ImDefaultCurrentFrame “Mouth” ;

 

ImDeletePose – Deletes the pose on the specified frame.

 Usage:

  • 3 Arguments – Pose Group Name (String), Frame (Integer), Delete Keys (Boolean)

  • Example: ImDeletePose “Mouth” 122 true ;

 

ImGetAutoPoses – Gets a number of auto-poses on the group and range specified.

Usage:

  • 3 Arguments – Pose Group Name (String), Frame Range (String), Number Of Poses (Integer)

  • Example: ImGetAutoPoses “Mouth” “All Frames” 5 ;

 

ImCopyPose – Makes a copy of a pose.

 Usage:

  • 3 Arguments – Pose Group Name (String), Source (Integer), Destination (Integer), New Pose Description (String)

  • Example: ImCopyPose “Brows” 122 156 "Copied Pose" ;

 

ImMovePose – Moves a pose from one frame to another.

 Usage:

  • 3 Arguments – Pose Group Name (String), Source (Integer), Destination (Integer), New Pose Description (String)

  • Example: ImMovePose “Brows” 122 156 "Moved Pose" ;

 

ImSetPoseName – Sets the description of the specified pose.

 Usage:

  • 3 Arguments – Pose Group Name (String), Frame (Integer), Description (String)

  • Example: ImSetPoseName “Brows” 122 “Angry” ;

 

ImBackup – Creates a backup.

 Usage:

  • 1 Argument – Backup Name (String)

  • Example: ImBackup “Finished” ;

 

ImRestore – Restores to a backup.

 Usage:

  • 1 Argument – Backup Name (String)

  • Example: ImRestore “Finished”

 

ImUpdateSharedPoseSelected --  Sets a Shared Pose to on or off (equivalent of the checkbox to the left of the Shared Pose).

Usage:

  • 5 Arguments -- Pose Group Name (String), Frame Range Name (String), Pose Video Name (String), Frame Number (Integer), On/Off (Boolean)
  • Example: ImUpdateSharedPoseSelected "Mouth" "All Frames" "Cartoon_Line005_Liam_IM" 23 true ;

 

ImEditRetargetingRange -- Edits the values of a Retargeting Frame Range (Pruning, Smoothing, etc.)

Usage:

  • 9 Arguments - Pose Group Name (String)  Retarget Range Name (String)  Name (String)  Pruning (Integer)  Prune Buffer (Integer)  Smoothing (Integer)  Master Control (String)  Range String (String) AutoSolve (Boolean)
  • Example: ImEditRetargetingRange  "Mouth"  "All Frames"  "All Frames" 20 1 10 "Auto" "" true

 

ImAddRetargetRange - Adds a new Frame Range.

Usage:

 

  • 3 Arguments: Face Group (String), Frame Range Name (String), Frame Range (String)
  • Example: ImAddRetargetRange "Mouth" "All Frames" "101-200" ;

 

ImDeleteRetargetingRange - Deletes a Frame Range.

Usage:

 

  • 2 Arguments: Face Group (String), Frame Range Name (String)
  • Example: ImDeleteRetargetingRange "Mouth" "All Frames" ;

 

ImReloadRetargetingResults - Reloads Retargeting Results.

Usage:

 

  • 2 Arguments: Face Group (String), Frame Range Name (String)
  • Example: ImReloadRetargetingResults "Brows" "All Frames" ;

 

 

Have more questions? Submit a request

Comments

this.location="http://support.facewaretech.com"
Powered by Zendesk