# -= ml_worldBake.py =-
# __ by Morgan Loomis
# ____ ___ / / http://morganloomis.com
# / __ `__ \/ / Revision 15
# / / / / / / / 2018-07-18
# /_/ /_/ /_/_/ _________
# /_________/
#
# ______________
# - -/__ License __/- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#
# Copyright 2018 Morgan Loomis
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# ___________________
# - -/__ Installation __/- - - - - - - - - - - - - - - - - - - - - - - - - -
#
# Copy this file into your maya scripts directory, for example:
# C:/Documents and Settings/user/My Documents/maya/scripts/ml_worldBake.py
#
# Run the tool in a python shell or shelf button by importing the module,
# and then calling the primary function:
#
# import ml_worldBake
# ml_worldBake.ui()
#
#
# __________________
# - -/__ Description __/- - - - - - - - - - - - - - - - - - - - - - - - - - -
#
# Temporarily bake animation to locators in world (or custom) space. Use this
# tool to preserve the worldspace position of animation when you need to make
# positional changes to an object's parent.
#
# ____________
# - -/__ Usage __/- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#
# Run the tool, select the objects, then press the "To Locators" button. When
# you're ready to bake back, select the locators and press the "From Locators"
# button. Checking "Bake on Ones" will bake every frame, otherwise the keytimes
# will be derived from the original animation.
#
# _________
# - -/__ Ui __/- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#
# [Bake Selection To Locators] : Bake selected object to locators specified space.
# [Bake Selected Locators Back To Objects] : Bake from selected locators back to their source objects.
# [Re-Parent Animated] : Parent all selected nodes to the last selection.
# [Un-Parent Animated] : Parent all selected to world.
# [Bake Selected] : Bake from the first selected object directly to the second.
# [Bake Selected With Offset] : Bake from the first selected object directly to the second, maintaining offset.
#
# ___________________
# - -/__ Requirements __/- - - - - - - - - - - - - - - - - - - - - - - - - -
#
# This script requires the ml_utilities module, which can be downloaded here:
# https://raw.githubusercontent.com/morganloomis/ml_tools/master/ml_utilities.py
#
# __________
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /_ Enjoy! _/- - -
__author__ = 'Morgan Loomis'
__license__ = 'MIT'
__revision__ = 15
__category__ = 'animation'
from functools import partial
import maya.cmds as mc
from maya import OpenMaya
try:
import ml_utilities as utl
utl.upToDateCheck(32)
except ImportError:
result = mc.confirmDialog( title='Module Not Found',
message='This tool requires the ml_utilities module. Once downloaded you will need to restart Maya.',
button=['Download Module','Cancel'],
defaultButton='Cancel', cancelButton='Cancel', dismissString='Cancel' )
if result == 'Download Module':
mc.showHelp('http://morganloomis.com/tool/ml_utilities/',absolute=True)
def ui():
'''
User interface for world bake
'''
with utl.MlUi('ml_worldBake', 'World Bake', width=400, height=175, info='''Select objects, bake to locators in world, camera, or custom space.
When you're ready to bake back, select locators
and bake "from locators" to re-apply your animation.''') as win:
mc.checkBoxGrp('ml_worldBake_bakeOnOnes_checkBox',label='Bake on Ones',
annotation='Bake every frame. If deselected, the tool will preserve keytimes.')
tabs = mc.tabLayout()
tab1 = mc.columnLayout(adj=True)
mc.radioButtonGrp('ml_worldBake_space_radioButton', label='Bake To Space', numberOfRadioButtons=3,
labelArray3=('World','Camera','Last Selected'), select=1,
annotation='The locators will be parented to world, the current camera, or the last selection.')
mc.checkBoxGrp('ml_worldBake_constrain_checkBox',label='Maintain Constraints',
annotation='Constrain source nodes to the created locators, after baking.')
win.ButtonWithPopup(label='Bake Selection To Locators', command=toLocators, annotation='Bake selected object to locators specified space.',
readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox',
'spaceInt':'ml_worldBake_space_radioButton',
'constrainSource':'ml_worldBake_constrain_checkBox'},
name=win.name)#this last arg is temp..
mc.setParent('..')
tab2 = mc.columnLayout(adj=True)
win.ButtonWithPopup(label='Bake Selected Locators Back To Objects', command=fromLocators, annotation='Bake from selected locators back to their source objects.',
readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox'}, name=win.name)#this last arg is temp..
mc.setParent('..')
tab3 = mc.columnLayout(adj=True)
win.ButtonWithPopup(label='Re-Parent Animated', command=reparent, annotation='Parent all selected nodes to the last selection.',
readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox'}, name=win.name)
win.ButtonWithPopup(label='Un-Parent Animated', command=unparent, annotation='Parent all selected to world.',
readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox'}, name=win.name)
mc.separator()
mc.checkBoxGrp('ml_worldBake_maintainOffset_checkBox',label='Maintain Offset',
annotation='Maintain the offset between nodes, rather than snapping.')
win.ButtonWithPopup(label='Bake Selected', command=utl.matchBake, annotation='Bake from the first selected object directly to the second.',
readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox',
'maintainOffset':'ml_worldBake_maintainOffset_checkBox'}, name=win.name)
mc.tabLayout( tabs, edit=True, tabLabel=((tab1, 'Bake To Locators'), (tab2, 'Bake From Locators'), (tab3, 'Bake Selection')) )
# win.ButtonWithPopup(label='Bake Selected With Offset', command=matchBake, annotation='Bake from the first selected object directly to the second, maintaining offset.',
# readUI_toArgs={'bakeOnOnes':'ml_worldBake_bakeOnOnes_checkBox'}, name=win.name)#this last arg is temp..
def toLocators(bakeOnOnes=False, space='world', spaceInt=None, constrainSource=False):
'''
Creates locators, and bakes their position to selection.
Creates connections to the source objects, so they can
be found later to bake back.
'''
if spaceInt and 0 <= spaceInt <= 2:
space = ['world', 'camera', 'last'][spaceInt]
sel = mc.ls(sl=True)
parent = None
if space == 'camera':
parent = utl.getCurrentCamera()
elif space == 'last':
parent = sel[-1]
sel = sel[:-1]
mc.select(sel)
matchBakeLocators(parent=parent, bakeOnOnes=bakeOnOnes, constrainSource=constrainSource)
def fromLocators(bakeOnOnes=False):
'''
Traces connections from selected locators to their source nodes, and
bakes their position back.
Arguments:
bakeOnOnes :: Bool :: Preserve the original keytimes from the locator.
'''
#get neccesary nodes
objs = mc.ls(sl=True)
if not objs:
OpenMaya.MGlobal.displayWarning('Select a previously baked locator.')
return
source = list()
destination = list()
for src in objs:
try:
dest = mc.listConnections(src+'.ml_bakeSource',destination=False)[0]
if dest:
source.append(src)
destination.append(dest)
except StandardError:
pass
if not destination:
OpenMaya.MGlobal.displayWarning('Select a previously baked locator.')
return
#delete constraints on destination nodes
for each in destination:
constraints = mc.listConnections(each, source=True, destination=False, type='constraint')
if constraints:
try:
mc.delete(constraints)
except StandardError:
pass
utl.matchBake(source, destination, bakeOnOnes=bakeOnOnes)
for each in source:
mc.delete(each)
def matchBakeLocators(parent=None, bakeOnOnes=False, constrainSource=False):
#get neccesary nodes
objs = mc.ls(sl=True)
if not objs:
OpenMaya.MGlobal.displayWarning('Select an Object')
return
locs = list()
cutIndex = dict()
noKeys = list()
noKeysLoc = list()
for obj in objs:
name = mc.ls(obj, shortNames=True)[0]
if ':' in name:
name = obj.rpartition(':')[-1]
locator = mc.spaceLocator(name='worldBake_'+name+'_#')[0]
mc.setAttr(locator+'.rotateOrder', 3)
mc.addAttr(locator, longName='ml_bakeSource', attributeType='message')
mc.connectAttr('.'.join((obj,'message')), '.'.join((locator,'ml_bakeSource')))
mc.addAttr(locator, longName='ml_bakeSourceName', dataType='string')
mc.setAttr('.'.join((locator,'ml_bakeSourceName')), name, type='string')
if parent:
locator = mc.parent(locator, parent)[0]
locs.append(locator)
#should look through all trans and rot
if not mc.keyframe(obj, query=True, name=True):
noKeys.append(obj)
noKeysLoc.append(locator)
utl.matchBake(objs, locs, bakeOnOnes=bakeOnOnes)
if not bakeOnOnes and noKeys:
utl.matchBake(noKeys, noKeysLoc, bakeOnOnes=True)
if constrainSource:
mc.cutKey(objs)
for loc, obj in zip(locs, objs):
mc.parentConstraint(loc, obj)
def reparent(bakeOnOnes=False):
objs = mc.ls(sl=True)
if not objs or len(objs) < 2:
OpenMaya.MGlobal.displayWarning('Select one or more nodes, followed by the new parent.')
return
parentBake(objs[:-1], objs[-1], bakeOnOnes=bakeOnOnes)
def unparent(bakeOnOnes=False):
objs = mc.ls(sl=True)
if not objs:
OpenMaya.MGlobal.displayWarning('Select one or more nodes to unparent.')
return
parentBake(objs, bakeOnOnes=bakeOnOnes)
def parentBake(objs, parent=None, bakeOnOnes=False):
#check objects can be parented
parentReferenced = mc.referenceQuery(parent, isNodeReferenced=True) if parent else False
culledObjs = []
for each in objs:
eachParent = mc.listRelatives(each, parent=True)
if mc.referenceQuery(each, isNodeReferenced=True):
if parentReferenced:
OpenMaya.MGlobal.displayWarning("Child and parent are both referenced, skipping: {} > {}".format(each, parent))
continue
if eachParent and mc.referenceQuery(eachParent[0], isNodeReferenced=True):
OpenMaya.MGlobal.displayWarning("Node is referenced and can't be reparented, skipping: {}".format(each))
continue
if not parent and not eachParent:
OpenMaya.MGlobal.displayWarning("Node is already child of the world, skipping: {}".format(each))
continue
culledObjs.append(each)
if not culledObjs:
OpenMaya.MGlobal.displayWarning("No nodes could be reparented.")
return
source = []
destination = []
for each in culledObjs:
source.append(mc.duplicate(each, parentOnly=True)[0])
mc.copyKey(each)
mc.pasteKey(source[-1], option='replaceCompletely')
try:
if parent:
destination.append(mc.parent(each, parent)[0])
else:
destination.append(mc.parent(each, world=True)[0])
except RuntimeError as err:
mc.delete(source)
raise err
utl.matchBake(source=source, destination=destination, bakeOnOnes=bakeOnOnes)
mc.delete(source)
def mm_matchLocators(*args):
matchBakeLocators()
def mm_matchLocatorsOnes(*args):
matchBakeLocators(bakeOnOnes=True)
def mm_fromLocators(*args):
fromLocators()
def mm_reparent(*args):
reparent()
def mm_unparent(*args):
unparent()
def markingMenu():
menuKwargs = {'enable':True,
'subMenu':False,
'enableCommandRepeat':True,
'optionBox':False,
'boldFont':True}
mc.menuItem(radialPosition='N', label='Bake To Locators', command=mm_matchLocators, **menuKwargs)
mc.menuItem(radialPosition='NW', label='Bake To Locators (Ones)', command=mm_matchLocatorsOnes, **menuKwargs)
mc.menuItem(radialPosition='W', label='Bake From Locators', command=mm_fromLocators, **menuKwargs)
mc.menuItem(radialPosition='E', label='Re-Parent', command=mm_reparent, **menuKwargs)
mc.menuItem(radialPosition='S', label='Un-Parent', command=mm_unparent, **menuKwargs)
mc.menuItem(label='World Bake UI', command=ui, **menuKwargs)
if __name__ == '__main__':
#matchBakeLocators(constrainSource=True)
ui()
# ______________________
# - -/__ Revision History __/- - - - - - - - - - - - - - - - - - - - - - - -
#
# Revision 1: : First publish
#
# Revision 6: : Updated to use ml_utilities. Changed from direct constraint to constrained duplicate node.
#
# Revision 7: 2011-05-13 : fixed a bug with transferring certain types of tangents.
#
# Revision 8: 2011-05-14 : fixed error baking things with transforms locked or hidden
#
# Revision 9: 2012-06-13 : fixing duplicate name bug, adding more error checking.
#
# Revision 10: 2012-11-15 : Converting UI to tabs, adding camera and explicit options.
#
# Revision 11: 2014-03-01 : adding category
#
# Revision 12: 2015-05-14 : Baking broken out and moved to ml_utilities
#
# Revision 13: 2018-02-17 : Updating license to MIT.
#
# Revision 14: 2018-06-27 : parenting options and marking menu
#
# Revision 15: 2018-07-18 : marking menu
