Potential first release.

Author: retsyn

README.md

@@ -1,4 +1,28 @@
 # febex
 
-This isn't ready for use yet, as it has no UI.
-But you can try your luck!
+This is a quick and dirty tool to scrub rigs of non-exportable data, allowing for FBXs to better
+represent rigs and animations as they are imported into Unity or Unreal.
+
+## Installation:
+Unzip the entire febex folder into something that is in your maya path.
+If you'd rather put it somewhere else, you can path it like so:
+```
+import sys
+# The path where the febex folder is (change \ to /!)
+sys.path.append("install folder of febex")
+```
+Just make sure the folder where the code lives is called "febex" (If not, account for that in
+upcoming steps).
+
+## Running in Maya
+Put the following in a script editor or shelf button-- this will work if the febex folder is pathed
+correctly (see above).
+```
+import febex.ui as fb
+ui = fb.Febex_Ui()
+```
+
+## A word on 'state'
+This UI won't recall the lists of influences it just made if you close and re-open it, so try to 
+perform all your operations with the window remaining open.  You may have to reload your file after
+you've run a procedure on it.

mesh.py

@@ -33,7 +33,7 @@ def __init__(self, mesh: str):
         if cmds.objectType(mesh) == "transform":
             self.trans_node = mesh
             relatives = cmds.listRelatives(mesh, s=True)
-            if(relatives is None):
+            if relatives is None:
                 raise TypeError(f"{mesh} doesn't have a shape node.")
             else:
                 self.mesh_node = relatives[0]
@@ -43,7 +43,6 @@ def __init__(self, mesh: str):
         else:
             raise TypeError(f"{mesh} is of type {cmds.objectType(mesh)}, not 'mesh'")
 
-
     @property
     def shape(self):
         return self.mesh_node

operations.py

@@ -12,7 +12,19 @@
 from .mesh import MeshData
 
 
-def build_export_content(target_geo: MeshData, top_joint: str, new_mesh=True):
+def build_export_content(target_geo: MeshData, top_joint: str, new_mesh=True) -> tuple:
+    """This will create a group in the scene that will have save components to export as FBX to a
+    game engine.
+
+    Args:
+        target_geo (MeshData): The skin-cluster mesh (should be just one!)
+        top_joint (str): Top of the joint hierarchy.
+        new_mesh (bool, optional): Whether a mesh should be duplicated or just a skeleton.
+        Defaults to True.
+
+    Returns:
+        tuple: The new and old influences to be used in later operations.
+    """
     mesh = MeshData(target_geo)
     print(f"Mesh shape node is {mesh.mesh_node}.")
 
@@ -35,18 +47,26 @@ def build_export_content(target_geo: MeshData, top_joint: str, new_mesh=True):
         ia=["closestBone", "closestJoint", "name"],
     )
 
+    return (old_influences, new_influences)
 
 
-def bake_animated_skeleton(old_influences, new_influences):
+def bake_animated_skeleton(old_influences: list, new_influences: list):
+    """Runs a bake simulation on the influences of the exported skeleton.
+
+    Args:
+        old_influences (list): Influence list of the original rig.
+        new_influences (list): Influence list of the export skeleton.
+    """
     skeleton.bind_exported_skeleton(old_influences)
 
-    current_frame = int(cmds.currentTime(query=True))
+    start_time = cmds.playbackOptions(query=True, minTime=True)
+    end_time = cmds.playbackOptions(query=True, maxTime=True)
 
     cmds.select(new_influences, r=True)
 
     cmds.bakeResults(
         simulation=True,
-        t=(current_frame, current_frame),
+        t=(start_time, end_time),
         sampleBy=1,
         disableImplicitControl=True,
         preserveOutsideKeys=True,
@@ -57,4 +77,3 @@ def bake_animated_skeleton(old_influences, new_influences):
         controlPoints=False,
         shape=True,
     )
-

progbar.py

@@ -94,7 +94,13 @@ def copy_influence_tree(top_joint: str, inf_list: str) -> list:
 
 
 def bind_exported_skeleton(old_infs: list):
-    
+    """Binds 1:1 the original influences to the new influences with parent constraints set to
+    'no-flip'.
+
+    Args:
+        old_infs (list): The list of old influences.
+    """    
+
     print("Binding new export skeleton to old skeleton...")
     for jnt in old_infs:
         pconstraint = cmds.parentConstraint(jnt, f"{jnt}_INF", mo=False)[0]

skeleton.py

@@ -39,7 +39,7 @@ def find_cluster_node(node: str) -> str:
         node, source=True, destination=False, type="skinCluster"
     )
 
-    print(f"Clusters found are: {clusters}" )
+    print(f"Clusters found are: {clusters}")
     # Guard against no clusters or not enough clusters being found.
     if clusters is None:
         # The cluster might not exist, or there are nodes between it and out mesh.  Falling back to
@@ -53,10 +53,10 @@ def find_cluster_node(node: str) -> str:
         # Loop through the history nodes and find the skin cluster
         for node in history_nodes:
             node_type = cmds.nodeType(node)
-            if node_type == 'skinCluster':
+            if node_type == "skinCluster":
                 skin_cluster_node = node
                 break
-        if(skin_cluster_node is None):
+        if skin_cluster_node is None:
             raise AttributeError(f"There are no skinclusters attached to {node}")
         else:
             clusters = [skin_cluster_node]
@@ -126,5 +126,3 @@ def copy_skinning(old_mesh: str, new_mesh: str):
                 new_cluster, dest_vert, transformValue=(dest_joint, weight)
             )
         current_vert += 1
-
-    # cmds.copySkinWeights(ss=old_cluster, ds=new_cluster, nm=True, sa="closestPoint", ia="name")

skinning.py

@@ -108,13 +108,38 @@ def _init_ui(self):
             lambda: self._build_export_rig()
         )
 
+        self.BakeAnim_QPushButton_QPushButton.clicked.connect(
+            lambda: self._bake_skeleton()
+        )
+
         self.show()
+        self._validate_bake_button()
+        self._validate_export_rig_button()
 
     def _build_export_rig(self):
-        ops.build_export_content(self.state.selected_mesh, self.state.selected_joint)
+        """Wraps the operations.build_export_content() function.
+        """        
+        infs = ops.build_export_content(
+            self.state.selected_mesh, self.state.selected_joint
+        )
+        self.state.old_influence_list = infs[0]
+        self.state.new_influence_list = infs[1]
         self._validate_bake_button()
 
-    def _get_selection(self, type):
+    def _bake_skeleton(self):
+        """Wraps the operations.bake_animated_skeleton() function.
+        """        
+        print(f"Reviewing state:\n{self.state.old_influence_list}\n{self.state.new_influence_list}")
+        ops.bake_animated_skeleton(
+            self.state.old_influence_list, self.state.new_influence_list
+        )
+
+    def _get_selection(self, type: int):
+        """Populates a lineedit field with something selected from the scene.
+
+        Args:
+            type (int): 0 for mesh selection, 1 for joint selection.
+        """        
         selection = cmds.ls(sl=True)
 
         if len(selection) != 1:
@@ -158,14 +183,18 @@ def _get_selection(self, type):
         self._validate_export_rig_button()
 
     def _validate_bake_button(self):
-        
+        """Based on context, determine if the bake button should be usable.
+        """        
         valid = True
         if cmds.objExists("export_group") == False:
             valid = False
 
         self.BakeAnim_QPushButton_QPushButton.setEnabled(valid)
 
     def _validate_export_rig_button(self):
+        """Based on state and scene context, determines if the Build export rig button should be 
+        available.
+        """        
         valid = True
 
         mesh_object = self.SelectedMesh_QLineEdit_QLineEdit.text()
@@ -220,6 +249,9 @@ def __init__(self):
         self._last_rig_path = None
         self._last_anim_path = None
 
+        self._old_inf_list = None
+        self._new_inf_list = None
+
     @property
     def selected_mesh(self):
         return self._selected_mesh
@@ -251,4 +283,20 @@ def anim_path(self):
 
     @anim_path.setter
     def anim_path(self, value):
-        self._last_anim_path
+        self._last_anim_path = value
+
+    @property
+    def new_influence_list(self):
+        return self._new_inf_list
+
+    @new_influence_list.setter
+    def new_influence_list(self, value):
+        self._new_inf_list = value
+
+    @property
+    def old_influence_list(self):
+        return self._old_inf_list
+
+    @old_influence_list.setter
+    def old_influence_list(self, value):
+        self._old_inf_list = value

ui.py

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>656</width>
-    <height>289</height>
+    <height>187</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -19,14 +19,14 @@
      <x>9</x>
      <y>9</y>
      <width>641</width>
-     <height>266</height>
+     <height>171</height>
     </rect>
    </property>
    <layout class="QVBoxLayout" name="verticalLayout">
     <item>
      <widget class="QLabel" name="Version_QLabel">
       <property name="text">
-       <string>Febex 1.0.0</string>
+       <string>Febex - The simple FBX export prepper.</string>
       </property>
      </widget>
     </item>
@@ -129,37 +129,8 @@
         </property>
        </widget>
       </item>
-      <item>
-       <widget class="QPushButton" name="pushButton_2">
-        <property name="enabled">
-         <bool>false</bool>
-        </property>
-        <property name="toolTip">
-         <string extracomment="Exports and .FBX of the Deformable Mesh derived from the rig."/>
-        </property>
-        <property name="text">
-         <string>Export Deformable Mesh</string>
-        </property>
-       </widget>
-      </item>
-      <item>
-       <widget class="QPushButton" name="pushButton_3">
-        <property name="enabled">
-         <bool>false</bool>
-        </property>
-        <property name="toolTip">
-         <string extracomment="Exports and FBX of just the animated skeleton."/>
-        </property>
-        <property name="text">
-         <string>Export Animated Joints</string>
-        </property>
-       </widget>
-      </item>
      </layout>
     </item>
-    <item>
-     <widget class="QTextBrowser" name="Output"/>
-    </item>
    </layout>
   </widget>
  </widget>