Skip to content

validate_mesh_arnold_attributes

ValidateMeshArnoldAttributes

Bases: MayaInstancePlugin, OptionalPyblishPluginMixin

Validate the mesh has default Arnold attributes.

It compares all Arnold attributes from a default mesh. This is to ensure later published looks can discover non-default Arnold attributes.

Source code in client/ayon_maya/plugins/publish/validate_mesh_arnold_attributes.py
 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
class ValidateMeshArnoldAttributes(plugin.MayaInstancePlugin,
                                   OptionalPyblishPluginMixin):
    """Validate the mesh has default Arnold attributes.

    It compares all Arnold attributes from a default mesh. This is to ensure
    later published looks can discover non-default Arnold attributes.
    """

    order = ValidateMeshOrder
    hosts = ["maya"]
    families = ["model"]
    label = "Mesh Arnold Attributes"
    actions = [
        ayon_maya.api.action.SelectInvalidAction,
        RepairAction
    ]

    optional = True

    # cache (will be `dict` when cached)
    arnold_mesh_defaults = None

    @classmethod
    def get_default_attributes(cls):

        if cls.arnold_mesh_defaults is not None:
            # Use from cache
            return cls.arnold_mesh_defaults

        # Get default arnold attribute values for mesh type.
        defaults = {}
        with delete_after() as tmp:
            transform = cmds.createNode("transform", skipSelect=True)
            tmp.append(transform)

            mesh = cmds.createNode("mesh", parent=transform, skipSelect=True)
            arnold_attributes = cmds.listAttr(mesh,
                                              string="ai*",
                                              fromPlugin=True) or []
            for attr in arnold_attributes:
                plug = "{}.{}".format(mesh, attr)
                try:
                    defaults[attr] = get_attribute(plug)
                except PublishValidationError:
                    cls.log.debug("Ignoring arnold attribute: {}".format(attr))

        cls.arnold_mesh_defaults = defaults  # assign cache
        return defaults

    @classmethod
    def get_invalid_attributes(cls, instance, compute=False):
        invalid = []

        if compute:

            meshes = cmds.ls(instance, type="mesh", long=True)
            if not meshes:
                return []

            # Compare the values against the defaults
            defaults = cls.get_default_attributes()
            for mesh in meshes:
                for attr_name, default_value in defaults.items():
                    plug = "{}.{}".format(mesh, attr_name)
                    if get_attribute(plug) != default_value:
                        invalid.append(plug)

            instance.data["nondefault_arnold_attributes"] = invalid

        return instance.data.get("nondefault_arnold_attributes", [])

    @classmethod
    def get_invalid(cls, instance):
        invalid_attrs = cls.get_invalid_attributes(instance, compute=False)
        invalid_nodes = set(attr.split(".", 1)[0] for attr in invalid_attrs)
        return sorted(invalid_nodes)

    @classmethod
    def repair(cls, instance):
        with maintained_selection():
            with undo_chunk():
                defaults = cls.get_default_attributes()
                attributes = cls.get_invalid_attributes(
                    instance, compute=False
                )
                for attr in attributes:
                    node, attr_name = attr.split(".", 1)
                    value = defaults[attr_name]
                    set_attribute(
                        node=node,
                        attribute=attr_name,
                        value=value
                    )

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

        if not cmds.pluginInfo("mtoa", query=True, loaded=True):
            # Arnold attributes only exist if plug-in is loaded
            return

        invalid = self.get_invalid_attributes(instance, compute=True)
        if invalid:
            raise PublishValidationError(
                "Non-default Arnold attributes found in instance:"
                " {0}".format(invalid)
            )