exampleCharacter.py

"""Example character to showcase the rigsys module."""

import rigsys.utils.unload as unload

unload.unloadPackages(silent=True, packages=["rigsys"])

import os

import rigsys as rigsys
import rigsys.api.api_rig as api_rig
import rigsys.modules.motion as motion
import rigsys.modules.utility as utility
import rigsys.modules.export as export


class ExampleCharacter(api_rig.Rig):
    """Example character to showcase the rigsys module."""

    def __init__(self, name: str = "ExampleRig") -> None:
        """Initialize the Rig."""
        super().__init__(name)

        self.exampleCharacterFolder = os.path.abspath(os.path.join(rigsys.__file__, os.pardir, os.pardir, "example"))

        self.motionModules = {
            "M_Root": motion.Root(
                self,
                side="M",
                label="Root",
            ),
            "M_Spine": motion.TestMotionModule(
                self,
                side="M",
                label="Spine",
                parent="M_Root",
            ),
            "L_Arm": motion.TestMotionModule(
                self,
                side="L",
                label="Arm",
                mirror=True,
                parent="M_Spine",
                selectedPlug="SomePlug",
                selectedSocket="SomeSocket",
            ),
            "L_Hand": motion.TestMotionModule(
                self,
                side="L",
                label="Hand",
                mirror=True,
                parent="L_Arm",
                selectedPlug="SomePlug",
                selectedSocket="SomeSocket",
            ),
            "L_Hand_2": motion.TestMotionModule(
                self,
                side="L",
                label="Hand_2",
                mirror=True,
                parent="L_Arm",
                selectedPlug="AnotherPlug",
                selectedSocket="AnotherSocket",
            ),
            "L_Watch": motion.TestMotionModule(
                self,
                side="L",
                label="Watch",
                parent="L_Arm",
            ),
        }

        self.deformerModules = {}
        self.utilityModules = {
            # "ImportModel": utility.ImportModel(
            #     self,
            #     filePath=os.path.join(self.exampleCharacterFolder, "cube.mb"),
            #     underGroup=""
            # ),
            # "MotionModuleParenting": utility.MotionModuleParenting(
            #     self,
            # ),
            "PythonCreateSphere": utility.PythonCode(
                self,
                pythonFile=os.path.join(self.exampleCharacterFolder, "create_sphere.py"),
                label="PythonCreateSphere",
            )
        }
        self.exportModules = {
            # "FBXExport": export.FBXExport(
            #     self,
            #     exportPath=os.path.join(self.exampleCharacterFolder, "ExampleRig_export.fbx"),
            #     exportAll=True,
            #     exportSelected=False,
            #     nodesToExport=None,
            # ),
        }


if __name__ == "__main__":
    character = ExampleCharacter()
    proxyDataFile = os.path.join(character.exampleCharacterFolder, "exampleCharacter_proxies.json")

    character.build(usedSavedProxyData=True, proxyDataFile=proxyDataFile)
    # character.saveProxyTransformations(proxyDataFile)