{"id":590,"date":"2018-07-16T12:40:09","date_gmt":"2018-07-16T16:40:09","guid":{"rendered":"http:\/\/www.vicdebaie.com\/blog\/?p=590"},"modified":"2018-07-16T12:47:52","modified_gmt":"2018-07-16T16:47:52","slug":"motionbuilder-python-library-aka-my-fav-functions","status":"publish","type":"post","link":"http:\/\/www.vicdebaie.com\/blog\/motionbuilder-python-library-aka-my-fav-functions\/","title":{"rendered":"MotionBuilder Python Library aka. My Fav Functions"},"content":{"rendered":"

\"\"<\/p>\n

 <\/p>\n

Here is a quick post containing a collection of my favorite functions or snippets of scripts that I find very useful in my day to day workflow. You could save them all and then import them into your scripts as apart of your person library, to do that I will point you here<\/a>. \ud83d\ude42<\/p>\n

\r\nimport pyfbsdk as fb\r\nimport pyfbsdk_additions as fba\r\n\r\n##Search the module namespace for specific name ie searchFB("Scene")\r\ndef searchFB(string):\r\n    count = 0\r\n    for i in dir(fb):\r\n        if string in i:\r\n            count = count + 1\r\n            print "fb." + i\r\n        else:\r\n            pass\r\n    if count == 0:\r\n        print "No Results Found"\r\n            \r\n##Search through the module fb.FBScene for specific name ie. searchFBScene("Layer")          \r\ndef searchFBScene(string):\r\n    count = 0\r\n    for i in dir(fb.FBScene):\r\n        if string in i:\r\n            count = count + 1\r\n            print "fb.FBScene." + i\r\n        else:\r\n            pass\r\n    if count == 0:\r\n        print "No Results Found"\r\n\r\n##Search dir() On User Specific Component But Only Return Attributes That Match User's Specific String ie. SearchDirString(fb.FBSystem().Scene.Takes, "Get")\r\ndef searchDirString(component, string):\r\n    count = 0\r\n    for item in dir(component):\r\n        if string in item:\r\n            print item\r\n            count = count + 1\r\n        else:\r\n            pass\r\n    if count == 0:\r\n        print 'No Attributes Match Or Contain "' + string + '" - This Search Is Case Sensitive.'\r\n        print 'Please Try Again Using Proper Case Of Text Or Use "searchDirString(component, sting)" To Return All Results.'\r\n        \r\n'''\r\nTime Line\/Frames\r\n'''\r\n##Scene Refresh Bug Work Around\r\ndef SceneRefresh(): \r\n    fb.FBPlayerControl().GotoNextKey()\r\n    fb.FBSystem().Scene.Evaluate()\r\n    fb.FBPlayerControl().GotoPreviousKey()\r\n    fb.FBSystem().Scene.Evaluate()\r\n\r\n##Get Current Frame\r\ndef GetCurrentFrame():\r\n    return fb.FBSystem().LocalTime.GetFrame()\r\n\r\n##Get First Frame Of Time Line \/ Get Start Frame Of Time Line    \r\ndef GetStartFrame():\r\n    lStartFrame = fb.FBSystem().CurrentTake.LocalTimeSpan.GetStart().GetFrame()\r\n    return lStartFrame\r\n\r\n##Get Last Frame Of Time Line \/ Get End Frame Of Time Line           \r\ndef GetEndFrame():\r\n    lEndFrame = fb.FBSystem().CurrentTake.LocalTimeSpan.GetStop().GetFrame()\r\n    return lEndFrame\r\n\r\n##Get Length Of Time Line \/ Get Time Line Frame Count            \r\ndef GetTimeSpan():\r\n    return ( fb.FBSystem().CurrentTake.LocalTimeSpan.GetStop().GetFrame() - fb.FBSystem().CurrentTake.LocalTimeSpan.GetStart().GetFrame() )\r\n\r\n##Set Time Line Length ie. SetTimeSpan(150, 200) Will Set The Time Line To Start At Frame 150 And End At Frame 200\r\ndef SetTimeSpan(start, end):\r\n    fb.FBSystem().CurrentTake.LocalTimeSpan = fb.FBTimeSpan(fb.FBTime(0, 0, 0, start, 0), fb.FBTime(0, 0, 0, end, 0))\r\n    \r\n##Goto User Specified Frame ie. GotoFrame(15) Will Place The Time Slider\/Play Head On Frame 15\r\ndef GotoFrame(frame):\r\n    t = fb.FBTime(0, 0, 0, frame, 0)\r\n    fb.FBPlayerControl().Goto(t)\r\n    \r\n##Goto First Frame Of Time Line \/ Get Start Frame Of Time Line    \r\ndef GotoStartFrame():\r\n    fb.FBPlayerControl().GotoStart()\r\n\r\n##Goto Last Frame Of Time Line \/ Get End Frame Of Time Line      \r\ndef GotoEndFrame():\r\n    fb.FBPlayerControl().GotoEnd()\r\n\r\n##Move The Time Slider\/Play Head Up One Frame From Its Current Position    \r\ndef GotoNextFrame():\r\n    fb.FBPlayerControl().StepForward()\r\n\r\n##Move The Time Slider\/Play Head Down One Frame From Its Current Position        \r\ndef GotoPreviousFrame():\r\n    fb.FBPlayerControl().StepBackward()\r\n\r\n##Move The Time Slider\/Play Head To The Next Key On The Time Line    \r\ndef GotoNextKey():\r\n    fb.FBPlayerControl().GotoNextKey()\r\n\r\n##Move The Time Slider\/Play Head To The Previous Key On The Time Line     \r\ndef GotoPreviousKey():\r\n    fb.FBPlayerControl().GotoPreviousKey()\r\n\r\n##User Specified Setting Of The Scenes Play Back Speed (in Frames Per Second) ie. SetFPS(45) Will Set The Scene To Play Back At 45 Frames Per Second     \r\ndef SetFPS(number):\r\n    fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeModeCustom, number)\r\n\r\n##Set The Scene's FPS Play Back Through User Specified Modes ie. SetFPSMode("PAL") Will Play The Scene Back At 25 Frames Per Second.\r\ndef SetFPSMode(mode):\r\n    if mode == "Cinema":\r\n        fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeMode24Frames)\r\n    if mode == "PAL":\r\n        fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeMode25Frames)\r\n    if mode == "NTSC":\r\n        fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeMode2997Frames)    \r\n    if mode == "NTSC_Drop":\r\n        fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeMode2997Frames_Drop)\r\n    if mode == "CinemaND":\r\n        fb.FBPlayerControl().SetTransportFps(fb.FBTimeMode.kFBTimeMode23976Frames)\r\n    else:\r\n        pass\r\n\r\n'''\r\nKeying\r\n'''\r\n##Get The Current Keying Mode\r\ndef GetKeyingMode():\r\n    return fb.FBApplication().CurrentCharacter.KeyingMode\r\n\r\n##Set The Character Keying Mode ie. SetKeyingMode("FullBody") Will Set The Keying Mode To FullBody (fb.FBCharacterKeyingMode.kFBCharacterKeyingFullBody) \r\ndef SetKeyingMode(mode):\r\n    if mode == "FullBody":\r\n        fb.FBApplication().CurrentCharacter.KeyingMode = fb.FBCharacterKeyingMode.kFBCharacterKeyingFullBody\r\n    if mode == "BodyPart":\r\n        fb.FBApplication().CurrentCharacter.KeyingMode = fb.FBCharacterKeyingMode.kFBCharacterKeyingBodyPart\r\n    if mode == "Selection":\r\n        fb.FBApplication().CurrentCharacter.KeyingMode = fb.FBCharacterKeyingMode.kFBCharacterKeyingSelection\r\n\r\n##Set Auto Key ie. SetAutoKey(True) Will Endable Auto Key\r\ndef SetAutoKey(value):\r\n    if value == True:\r\n        fb.FBKeyControl().AutoKey = True\r\n    if value == False:\r\n        fb.FBKeyControl().AutoKey = False\r\n\r\n'''Used With Layers To Set Zero Keys'''\r\n##Zero Transforms By Getting Model's FBVectors \r\ndef ZeroTransforms( yourmodel ):\r\n    yourmodel.Translation = fb.FBVector3d()\r\n    yourmodel.Rotation = fb.FBVector3d() \r\n\r\n##Sets Zero Key On Selected Model On Current Frame    \r\ndef ZeroKeySelected():    \r\n    SelModels = GetSelModels()\r\n    for model in SelModels:         \r\n        ZeroTransforms( model )\r\n        fb.FBPlayerControl().Key()\r\n\r\n##Sets Zero Key On Selected Model At Desired Frame ie. ZeroKeySelOnFrame(50) Will Set A Zero Key On Frame 50\r\ndef ZeroKeySelOnFrame(frame):\r\n    GotoFrame(frame)        \r\n    ZeroKeySelected()\r\n\r\n    \r\n'''\r\nTakes\r\n'''\r\n\r\n##Get Index Of Selected Takes\r\ndef GetSelTakeIdx():\r\n    listIndex = []\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        if i.Selected == True:\r\n            listIndex.extend([i])\r\n        else: pass\r\n    return listIndex\r\n\r\n##Get All The Take Names Within The Scene\r\ndef GetTakeNames():\r\n    lTakeNames = []\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        lTakeNames.extend([i.Name])\r\n    return lTakeNames\r\n\r\n##Goto User Specified Take ie. GotoTakeName("Take 002") Will Make "Take 002" Your Currently Acitve Take   \r\ndef GotoTakeName(name):\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        if i.Name == name:\r\n            fb.FBSystem().CurrentTake = i\r\n        else:\r\n            pass\r\n\r\n##Set The Currently Acitve Take As A Reference. This Is Used With Loops And When At The End Of The Loop We Need To Arive Back On The Take We Started On.\r\ndef SetTakeAsTakeRef():\r\n    TakeRef = fb.FBSystem().CurrentTake\r\n    TakeRefName = fb.FBSystem().CurrentTake.Name\r\n    return TakeRef\r\n\r\n##Returns Us Back To Our TakeRef. This Is Used With Loops And When At The End Of The Loop We Need To Arive Back On The Take We Started On.\r\ndef ReturnToOriginTake(TakeRef):\r\n    if TakeRef == fb.FBSystem().CurrentTake.Name:\r\n        pass\r\n    else:\r\n        fb.FBSystem().CurrentTake = TakeRef\r\n\r\n##Set Current Take As A Selected Take\r\ndef SelectCurrentTake():\r\n    fb.FBSystem().CurrentTake.Selected = True\r\n\r\n##Using A Take's Name We Can Set Tate Take As The Selected Take ie. SelectTakeName("Take 002") Will Make "Take 002" Now Selected And All Other Selected Takes Will Be Unselected.  \r\ndef SelectTakeName(takename):\r\n    UnSelectAllTakes()\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        if fb.FBSystem().Scene.Takes[i].Name == takename:\r\n            lTakeLst.extend([fb.FBSystem().Scene.Takes[i]])\r\n        else: pass\r\n    for take in lTakeLst:\r\n        fb.FBSystem().CurrentTake = take\r\n        fb.FBSystem().CurrentTake.Selected = True\r\n\r\n##Sets All Takes Within The Scene As Selected Takes    \r\ndef SelectAllTakes():\r\n    TakeRef, TakeRefName = SetTakeAsTakeRef()\r\n    lTakeNames = []\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        fb.FBSystem().CurrentTake = i\r\n        i.Selected = True\r\n    ReturnToOriginTake(TakeRef)    \r\n    \r\n##Sets All Takes Within The Scene As UnSelected Takes\r\ndef UnSelectAllTakes():\r\n    TakeRef, TakeRefName = SetTakeAsTakeRef()\r\n    lfbTakeSum = 0\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        lfbTakeSum = lfbTakeSum+1\r\n    for x in range (lfbTakeSum):\r\n        fb.FBSystem().CurrentTake = fb.FBSystem().Scene.Takes[x]\r\n        fb.FBSystem().CurrentTake.Selected = False\r\n    ReturnToOriginTake(TakeRef)\r\n\r\n##Creates A New Take With The User's Specified Take Name ie. CreateNewTake("Take 003") Will Create A New Empty Take Named "Take 003"\r\ndef CreateNewTake(takename):\r\n    fb.FBSystem().Scene.Takes.append( fb.FBTake(takename) )\r\n\r\n##Copies The Current Take To A New Take And Names It To The User's Specified Name ie DuplicateCurrentTake("MyCopiedTake")    \r\ndef DuplicateCurrentTake(newtakename):\r\n    fb.FBSystem().CurrentTake.CopyTake(newtakename)\r\n\r\n##Duplicates All Selected Takes With the Suffix "CopyOf____" ie. "Take 002" Will Be Duplicated As "CopyOf____Take 002"     \r\ndef DuplicateSelectedTakes():\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        if fb.FBSystem().Scene.Takes[i].Selected == True:\r\n            lTakeLst.extend([fb.FBSystem().Scene.Takes[i]])\r\n        else: pass\r\n    for take in lTakeLst:\r\n        fb.FBSystem().CurrentTake = take\r\n        lnewtakename = "CopyOf____"+take.Name\r\n        fb.FBSystem().CurrentTake.CopyTake(lnewtakename)\r\n\r\n##Duplicate Take By Take Name ie. DuplicateTakeByName("Take 002") Will Only Duplicate "Take 002" And Will Name It As "CopyOf____Take 002"           \r\ndef DuplicateTakeByName(takename):\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        if fb.FBSystem().Scene.Takes[i].Name == takename:\r\n            lTakeLst.extend([fb.FBSystem().Scene.Takes[i]])\r\n        else: pass\r\n    for take in lTakeLst:\r\n        fb.FBSystem().CurrentTake = take\r\n        lnewtakename = "CopyOf____"+take.Name\r\n        fb.FBSystem().CurrentTake.CopyTake(lnewtakename)\r\n    \r\n##Rename Take ie. RenameTake("Take 002", "My Take 002")\r\ndef RenameTake(currentname, newname):\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        if i.Name == currentname:\r\n            i.Name = newname\r\n        else:\r\n            pass\r\n\r\n##Rename All Selected Takes ie. RenameSelectedTake("My_New_Name") Will Produce Takes "My_New_Name", "My_New_Name 1", "My_New_Name 2", "My_New_Name 3", etc.             \r\ndef RenameSelectedTake(newname):\r\n    for i in fb.FBSystem().Scene.Takes:\r\n        if i.Selected == True:\r\n            i.Name = newname\r\n        else:\r\n            pass\r\n            \r\n##Delete Take By Name ie.  DelTakeByName("Take 002")           \r\ndef DelTakeByName(takename):\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        if fb.FBSystem().Scene.Takes[i].Name == takename:\r\n            lTakeLst.extend([fb.FBSystem().Scene.Takes[i]])\r\n        else:\r\n            pass\r\n    for take in lTakeLst:\r\n        take.FBDelete()\r\n\r\n##Delete All Selected Takes                \r\ndef DelSelectedTakes():\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        if fb.FBSystem().Scene.Takes[i].Selected == True:\r\n            lTakeLst.extend([fb.FBSystem().Scene.Takes[i]])\r\n        else: pass\r\n    for take in lTakeLst:\r\n        take.FBDelete()     \r\n\r\n##Delete All Takes Within You Scene    \r\ndef DelAllTakes():\r\n    lTakeLst = []\r\n    for i in range( len(fb.FBSystem().Scene.Takes) ):\r\n        lTakeLst.extend([fb.FBSystem().Scene.Takes[i]]) \r\n    for take in lTakeLst:\r\n        take.FBDelete()\r\n\r\n'''\r\nLayers    \r\n'''\r\n##Rename The Top Layer To The User's Specification ie. ReNameTopLayer("MyNewName")\r\ndef ReNameTopLayer(newname):\r\n    laycount = fb.FBSystem().CurrentTake.GetLayerCount()\r\n    layer = fb.FBSystem().CurrentTake.GetLayer(laycount-1)\r\n    layer.Name = newname\r\n\r\n##Creat Layer ie. CreateLayer("MyNewLayer") Will Create A New Top Layer Named "MyNewLayer"\r\ndef CreateLayer(name):\r\n    fb.FBSystem().CurrentTake.CreateNewLayer()\r\n    lCount = fb.FBSystem().CurrentTake.GetLayerCount()\r\n    fb.FBSystem().CurrentTake.SetCurrentLayer(lCount-1)\r\n    fb.FBSystem().CurrentTake.GetLayer(lCount-1).Name= name\r\n'''\r\nScene Components\r\n'''\r\n##Clear All Selected Components\r\ndef ClearAllComponents():\r\n    for lComp in fb.FBSystem().Scene.Components:\r\n        lComp.Selected = False\r\n              \r\n'''\r\nModels\r\n'''        \r\n##Clear Selected Models\r\ndef ClearSelModel():\r\n    modelList = fb.FBModelList()\r\n    fb.FBGetSelectedModels (modelList, None, True)\r\n    for model in modelList:\r\n        model.Selected = False\r\n\r\n##Returns A List Of All Selected Models\r\ndef GetSelModels():\r\n    lSelModels = []\r\n    modelList = fb.FBModelList()\r\n    fb.FBGetSelectedModels (modelList, None, True)\r\n    for model in modelList:\r\n        if model.Selected == True:\r\n            lSelModels.extend([model])\r\n        else:\r\n            pass\r\n    return lSelModels\r\n\r\n##Get Model By Long Name ie. GetModel('Character_01:Ctrl:HipsEffector') Will Return The HipEffector Of The Character Within Your Scene That Has The NameSpace "Character_01" \r\ndef GetModel(longname):\r\n    lModel = fb.FBFindModelByLabelName(longname) \r\n    return lModel\r\n\r\n##Select Model By Long Name ie. GetModel('Character_01:Ctrl:HipsEffector',True) Will Additonally Select The HipEffector Of The Character Within Your Scene That Has The NameSpace "Character_01" \r\ndef SelectModel(longname, appendselection):\r\n    if appendselection == False:\r\n        ClearSelModel()\r\n    if appendselection == True:\r\n        pass\r\n    lModel = fb.FBFindModelByLabelName(longname) \r\n    lModel.Selected = True           \r\n    \r\n'''\r\nCharacters\r\n'''\r\n    \r\ndef GetCharNameSpace():\r\n    return fb.FBApplication().CurrentCharacter.LongName.rsplit(':', 1)[0]\r\n\r\n##Set Active Caharcter By Name Space ie. GetCharByNameSpace("Carl")\r\ndef GetCharByNameSpace(namespace):\r\n    charInScene = fb.FBSystem().Scene.Characters\r\n    nameSpaceList = []\r\n    for i in charInScene:\r\n        nameSpaceList.extend( [ i.LongName.rsplit(':', 1)[0] ] )\r\n    if namespace not in nameSpaceList:\r\n        print "No Character With That Name Space" \r\n    else:\r\n        for i in charInScene:\r\n            if i.LongName.rsplit(':', 1)[0] == namespace:\r\n                fb.FBApplication().CurrentCharacter = i\r\n            else:\r\n                pass\r\n##Select Current Character's Effector By Name ie. GetActiveCharEffector("RightAnkleEffector")\r\ndef GetActiveCharEffector(name, appendselection):\r\n    if appendselection == False:\r\n        ClearSelModel()\r\n    if appendselection == True:\r\n        pass \r\n    nameSpace = GetCharNameSpace()\r\n    charEffeector = fb.FBFindModelByLabelName(nameSpace+":Ctrl:"+name)\r\n    print charEffeector.Name\r\n    charEffeector.Selected = True\r\n\r\n##Character Plot Options\r\ndef CharPlotOptions():\r\n    lPlotCtrlRigTakeOptions = fb.FBPlotOptions()\r\n    lPlotCtrlRigTakeOptions.ConstantKeyReducerKeepOneKey = False\r\n    lPlotCtrlRigTakeOptions.PlotAllTakes = False\r\n    lPlotCtrlRigTakeOptions.PlotOnFrame = True\r\n    lPlotCtrlRigTakeOptions.PlotPeriod = fb.FBTime( 0, 0, 0, 1 )\r\n    lPlotCtrlRigTakeOptions.PlotTranslationOnRootOnly = False\r\n    lPlotCtrlRigTakeOptions.PreciseTimeDiscontinuities = False\r\n    lPlotCtrlRigTakeOptions.RotationFilterToApply = fb.FBRotationFilter.kFBRotationFilterUnroll\r\n    lPlotCtrlRigTakeOptions.UseConstantKeyReducer = False\r\n    return lPlotCtrlRigTakeOptions\r\n\r\n##Plot Selected Character\r\ndef PlotSelChar():\r\n    plotOptions = CharPlotOptions()\r\n    fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnSkeleton,plotOptions )\r\n    fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnControlRig,plotOptions )\r\n\r\n##Plot All Characters In The Scene    \r\ndef PlotAllChar():\r\n    plotOptions = CharPlotOptions()\r\n    for i in range( len(fb.FBSystem().Scene.Characters) ):\r\n        char = fb.FBSystem().Scene.Characters[i]\r\n        fb.FBApplication().CurrentCharacter = char\r\n        fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnSkeleton,plotOptions )\r\n        fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnControlRig,plotOptions )\r\n\r\ndef PlotToCtrlRig():\r\n    plotOptions = CharPlotOptions()\r\n    fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnControlRig,plotOptions )\r\n\r\ndef PlotAllCharToCtrlRig():\r\n    plotOptions = CharPlotOptions()\r\n    for i in range( len(fb.FBSystem().Scene.Characters) ):\r\n        char = fb.FBSystem().Scene.Characters[i]\r\n        fb.FBApplication().CurrentCharacter = char\r\n        fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnSkeleton,plotOptions )\r\n        fb.FBApplication().CurrentCharacter.PlotAnimation (fb.FBCharacterPlotWhere.kFBCharacterPlotOnControlRig,plotOptions ) \r\n           \r\n<\/pre>\n
I hope to update this post in the future with links to more of these “Cheat Sheets”.<\/p>\n
As always, I hope this helps and maybe even speeds up your workflow when it comes to python scripting within MotionBuilder.<\/p>\n
<\/p>
\n\n    
<\/div>\n\n<\/div>\n        \n