Skip to content

extract_import_reference

ExtractImportReference

Bases: MayaExtractorPlugin, OptionalPyblishPluginMixin

Extract the scene with imported reference. The temp scene with imported reference is published for rendering if this extractor is activated

Source code in client/ayon_maya/plugins/publish/extract_import_reference.py
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class ExtractImportReference(plugin.MayaExtractorPlugin,
                             OptionalPyblishPluginMixin):
    """

        Extract the scene with imported reference.
        The temp scene with imported reference is
        published for rendering if this extractor is activated

    """

    label = "Extract Import Reference"
    order = pyblish.api.ExtractorOrder - 0.48
    families = ["renderlayer", "workfile"]
    optional = True
    tmp_format = "_tmp"

    @classmethod
    def apply_settings(cls, project_settings):
        if "deadline" not in project_settings:
            cls.enabled = False
            return
        cls.active = (
            project_settings
            ["deadline"]
            ["publish"]
            ["MayaSubmitDeadline"]
            ["import_reference"]
        )

    def process(self, instance):
        if not self.is_active(instance.data):
            return

        maya_settings = instance.context.data["project_settings"]["maya"]
        ext_mapping = {
            item["name"]: item["value"]
            for item in maya_settings["ext_mapping"]
        }
        if ext_mapping:
            self.log.debug("Looking in settings for scene type ...")
            # use extension mapping for first family found
            for family in self.families:
                try:
                    self.scene_type = ext_mapping[family]
                    self.log.debug(
                        "Using {} as scene type".format(self.scene_type))
                    break

                except KeyError:
                    # set scene type to ma
                    self.scene_type = "ma"

        _scene_type = ("mayaAscii"
                       if self.scene_type == "ma"
                       else "mayaBinary")

        dir_path = self.staging_dir(instance)
        # named the file with imported reference
        if instance.name == "Main":
            return
        tmp_name = instance.name + self.tmp_format
        current_name = cmds.file(query=True, sceneName=True)
        ref_scene_name = "{0}.{1}".format(tmp_name, self.scene_type)

        reference_path = os.path.join(dir_path, ref_scene_name)
        tmp_path = os.path.dirname(current_name) + "/" + ref_scene_name

        self.log.debug("Performing extraction..")

        # This generates script for mayapy to take care of reference
        # importing outside current session. It is passing current scene
        # name and destination scene name.
        script = ("""
# -*- coding: utf-8 -*-
'''Script to import references to given scene.'''
import maya.standalone
maya.standalone.initialize()
# scene names filled by caller
current_name = "{current_name}"
ref_scene_name = "{ref_scene_name}"
print(">>> Opening {{}} ...".format(current_name))
cmds.file(current_name, open=True, force=True)
print(">>> Processing references")
all_reference = cmds.file(q=True, reference=True) or []
for ref in all_reference:
    if cmds.referenceQuery(ref, il=True):
        cmds.file(ref, importReference=True)

        nested_ref = cmds.file(q=True, reference=True)
        if nested_ref:
            for new_ref in nested_ref:
                if new_ref not in all_reference:
                    all_reference.append(new_ref)

print(">>> Finish importing references")
print(">>> Saving scene as {{}}".format(ref_scene_name))

cmds.file(rename=ref_scene_name)
cmds.file(save=True, force=True)
print("*** Done")
        """).format(current_name=current_name, ref_scene_name=tmp_path)
        mayapy_exe = os.path.join(os.getenv("MAYA_LOCATION"), "bin", "mayapy")
        if sys.platform == "windows":
            mayapy_exe += ".exe"
            mayapy_exe = os.path.normpath(mayapy_exe)
        # can't use TemporaryNamedFile as that can't be opened in another
        # process until handles are closed by context manager.
        with tempfile.TemporaryDirectory() as tmp_dir_name:
            tmp_script_path = os.path.join(tmp_dir_name, "import_ref.py")
            self.log.debug("Using script file: {}".format(tmp_script_path))
            with open(tmp_script_path, "wt") as tmp:
                tmp.write(script)

            try:
                run_subprocess([mayapy_exe, tmp_script_path])
            except Exception:
                self.log.error("Import reference failed", exc_info=True)
                raise

        with lib.maintained_selection():
            cmds.select(all=True, noExpand=True)
            cmds.file(reference_path,
                      force=True,
                      typ=_scene_type,
                      exportSelected=True,
                      channels=True,
                      constraints=True,
                      shader=True,
                      expressions=True,
                      constructionHistory=True)

        instance.context.data["currentFile"] = tmp_path

        if "files" not in instance.data:
            instance.data["files"] = []
        instance.data["files"].append(ref_scene_name)

        if instance.data.get("representations") is None:
            instance.data["representations"] = []

        ref_representation = {
            "name": self.scene_type,
            "ext": self.scene_type,
            "files": ref_scene_name,
            "stagingDir": os.path.dirname(current_name),
            "outputName": "imported"
        }
        self.log.debug(ref_representation)

        instance.data["representations"].append(ref_representation)

        self.log.debug("Extracted instance '%s' to : '%s'" % (ref_scene_name,
                                                              reference_path))