Skip to content

load_layout

LayoutLoader

Bases: Loader

Layout Loader (json)

Source code in client/ayon_maya/plugins/load/load_layout.py
 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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
class LayoutLoader(plugin.Loader):
    """Layout Loader (json)"""

    product_types = {"layout"}
    representations = {"json"}

    label = "Load Layout"
    order = -10
    icon = "code-fork"
    color = "orange"

    def _get_repre_entities_by_version_id(self, data):
        version_ids = {
            element.get("version")
            for element in data
        }
        version_ids.discard(None)

        output = collections.defaultdict(list)
        if not version_ids:
            return output

        project_name = get_current_project_name()
        repre_entities = ayon_api.get_representations(
            project_name,
            representation_names={"fbx", "abc"},
            version_ids=version_ids,
            fields={"id", "versionId", "name"}
        )
        for repre_entity in repre_entities:
            version_id = repre_entity["versionId"]
            output[version_id].append(repre_entity)
        return output

    @staticmethod
    def _get_loader(loaders, product_type):
        name = ""
        if product_type in {
            "rig", "model", "camera",
            "animation", "staticMesh",
            "skeletalMesh"}:
                name = "ReferenceLoader"

        if name == "":
            return None

        for loader in loaders:
            if loader.__name__ == name:
                return loader

        return None

    def get_asset(self, containers):
        # TODO: Improve this logic to support multiples of same asset
        #  and to avoid bugs with containers getting renamed by artists
        # Find container names that starts with 'instance name'
        containers = [con for con in containers]
        # Get the highest root node from the loaded container
        for container in containers:
            members = get_container_members(container)
            transforms = cmds.ls(members, transforms=True)
            roots = get_highest_in_hierarchy(transforms)
            root = next(iter(roots), None)
            if root is not None:
                return root

    def _process_element(self, element, repre_entities_by_version_id):
        repre_id = None
        repr_format = None
        version_id = element.get("version")
        if version_id:
            repre_entities = repre_entities_by_version_id[version_id]
            if not repre_entities:
                self.log.error(
                    "No valid representation found for version"
                    f" {version_id}")
                return
            # always use the first representation to load
            # If reference is None, this element is skipped, as it cannot be
            # imported in Maya, repre_entities must always be the first one
            repre_entity = repre_entities[0]
            repre_id = repre_entity["id"]
            repr_format = repre_entity["name"]

        # If reference is None, this element is skipped, as it cannot be
        # imported in Maya
        if not repr_format:
            self.log.warning(f"Representation name not defined for element: {element}")
            return


        instance_name: str = element['instance_name']
        all_loaders = discover_loader_plugins()
        product_type = element.get("product_type")
        if product_type is None:
            product_type = element.get("family")
        loaders = loaders_from_representation(
            all_loaders, repre_id)

        loader = self._get_loader(loaders, product_type)

        if not loader:
            self.log.error(
                f"No valid loader found for {repre_id}")
            return
        options = {
            # "asset_dir": asset_dir
        }
        assets = load_container(
            loader,
            repre_id,
            namespace=instance_name,
            options=options
        )

        self.set_transformation(assets, element)
        return assets

    def set_transformation(self, assets, element):
        asset = self.get_asset(assets)
        unreal_import = True if "unreal" in element.get("host", []) else False
        if unreal_import:
            transform = element["transform"]
            self._set_transformation(asset, transform)
        else:
            transform = element["transform_matrix"]
            # flatten matrix to a list
            maya_transform_matrix = [element for row in transform for element in row]
            self._set_transformation_by_matrix(asset, maya_transform_matrix)

    def _set_transformation(self, asset, transform):
        translation = [
            transform["translation"]["x"],
            transform["translation"]["z"],
            transform["translation"]["y"]
            ]

        rotation = [
            math.degrees(transform["rotation"]["x"]),
            -math.degrees(transform["rotation"]["z"]),
            math.degrees(transform["rotation"]["y"]),
        ]
        scale = [
            transform["scale"]["x"],
            transform["scale"]["z"],
            transform["scale"]["y"]
        ]
        cmds.xform(
            asset,
            translation=translation,
            rotation=rotation,
            scale=scale
        )

    def _set_transformation_by_matrix(self, asset, transform):
        """Set transformation with transform matrix and rotation data
        for the imported asset.

        Args:
            transform (list): Transformations of the asset
        """
        transform_mm = om.MMatrix(transform)
        convert_transform = om.MTransformationMatrix(transform_mm)
        convert_translation = convert_transform.translation(om.MSpace.kWorld)
        convert_scale = convert_transform.scale(om.MSpace.kWorld)
        convert_rotation = convert_transform.rotation()
        rotation_degrees = [om.MAngle(convert_rotation.x).asDegrees(),
                            om.MAngle(convert_rotation.z).asDegrees(),
                            om.MAngle(convert_rotation.y).asDegrees()]
        translation = [
            convert_translation.x,
            convert_translation.z,
            convert_translation.y
        ]
        cmds.xform(
            asset,
            translation=translation,
            rotation=rotation_degrees,
            scale=[convert_scale[0], convert_scale[2], convert_scale[1]]
        )


    def load(self, context, name, namespace, options):
        path = self.filepath_from_context(context)
        self.log.info(f">>> loading json [ {path} ]")
        with open(path, "r") as fp:
            data = json.load(fp)

        # get the list of representations by using version id
        repre_entities_by_version_id = self._get_repre_entities_by_version_id(
            data
        )
        assets = []
        for element in data:
            elements = self._process_element(element, repre_entities_by_version_id)
            assets.extend(elements)

        folder_name = context["folder"]["name"]
        namespace = namespace or unique_namespace(
            folder_name + "_",
            prefix="_" if folder_name[0].isdigit() else "",
            suffix="_",
        )

        return containerise(
            name=name,
            namespace=namespace,
            nodes=assets,
            context=context,
            loader=self.__class__.__name__)

    def update(self, container, context):
        repre_entity = context["representation"]
        path = self.filepath_from_context(context)
        self.log.info(f">>> loading json [ {path} ]")
        with open(path, "r") as fp:
            data = json.load(fp)
        # TODO: Supports to load non-existing containers
        for element in data:
            self.set_transformation(container["nodes"], element)
        # Update metadata
        node = container["objectName"]
        cmds.setAttr("{}.representation".format(node),
                     repre_entity["id"],
                     type="string")

    def switch(self, container, context):
        self.update(container, context)

    def remove(self, container):
        members = cmds.sets(container['objectName'], query=True)
        cmds.lockNode(members, lock=False)
        cmds.delete([container['objectName']] + members)
        # Clean up the namespace
        try:
            cmds.namespace(removeNamespace=container['namespace'],
                        deleteNamespaceContent=True)
        except RuntimeError:
            pass