Skip to content

create_arnold_ass

Creator plugin for creating Arnold ASS files.

CreateArnoldAss

Bases: HoudiniCreator

Export Arnold .ass archive

Source code in client/ayon_houdini/plugins/create/create_arnold_ass.py 
 7
 8
 9
10
11
12
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
class CreateArnoldAss(plugin.HoudiniCreator):
    """Export Arnold .ass archive"""

    identifier = "io.openpype.creators.houdini.ass"
    label = "Arnold ASS"
    product_type = "ass"
    product_base_type = "ass"
    icon = "magic"
    description = __doc__

    # Default extension: `.ass` or `.ass.gz`
    # however calling HoudiniCreator.create()
    # will override it by the value in the project settings
    ext = ".ass"

    # If true the rop will be shown in the RenderView rop dropdown
    show_in_viewport_menu = False

    # Default render target
    render_target = "local"

    def get_publish_families(self):
        return ["ass", "publish.hou"]

    def create(self, product_name, instance_data, pre_create_data):
        import hou

        instance_data.update({"node_type": "arnold"})
        creator_attributes = instance_data.setdefault(
            "creator_attributes", dict())
        creator_attributes["render_target"] = pre_create_data["render_target"]

        instance = super(CreateArnoldAss, self).create(
            product_name,
            instance_data,
            pre_create_data)

        instance_node = hou.node(instance.get("instance_node"))

        # Hide Properties Tab on Arnold ROP since that's used
        # for rendering instead of .ass Archive Export
        parm_template_group = instance_node.parmTemplateGroup()
        parm_template_group.hideFolder("Properties", True)
        instance_node.setParmTemplateGroup(parm_template_group)

        parms = {
            # Render frame range
            "trange": 1,
            # Arnold ROP settings
            "ar_ass_export_enable": 1,
            "soho_viewport_menu": self.show_in_viewport_menu,
        }

        instance_node.setParms(parms)

        # Lock any parameters in this list
        to_lock = [
            "ar_ass_export_enable",
            "productBaseType",
            "productType",
            "id"
        ]
        self.lock_parameters(instance_node, to_lock)

    def set_node_staging_dir(
            self, node, staging_dir, instance, pre_create_data):
        node.parm("ar_ass_file").set(f"{staging_dir}/$OS.$F4{self.ext}")

    def get_instance_attr_defs(self):
        render_target_items = {
            "local": "Local machine rendering",
            "local_no_render": "Use existing frames (local)",
            "farm": "Farm Rendering",
        }

        return [
            EnumDef("render_target",
                    items=render_target_items,
                    label="Render target",
                    default=self.render_target)
        ]

    def get_pre_create_attr_defs(self):
        attrs = super().get_pre_create_attr_defs()
        # Use same attributes as for instance attributes
        return attrs + self.get_instance_attr_defs()