Skip to content

create_vray_rop

Creator plugin to create VRay ROP.

CreateVrayROP

Bases: HoudiniCreator

VRay ROP

Source code in client/ayon_houdini/plugins/create/create_vray_rop.py
 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
 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
class CreateVrayROP(plugin.HoudiniCreator):
    """VRay ROP"""

    identifier = "io.openpype.creators.houdini.vray_rop"
    label = "VRay ROP"
    product_type = "vray_rop"
    icon = "magic"
    ext = "exr"

    # Default render target
    render_target = "farm_split"

    def create(self, product_name, instance_data, pre_create_data):
        # Transfer settings from pre create to instance
        creator_attributes = instance_data.setdefault(
            "creator_attributes", dict())
        for key in ["render_target", "review"]:
            if key in pre_create_data:
                creator_attributes[key] = pre_create_data[key]

        instance_data.update({"node_type": "vray_renderer"})

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

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

        # Add IPR for Vray
        basename = instance_node.name()
        try:
            ipr_rop = instance_node.parent().createNode(
                "vray", node_name=basename + "_IPR"
            )
        except hou.OperationFailed:
            raise CreatorError(
                "Cannot create Vray render node. "
                "Make sure Vray installed and enabled!"
            )

        ipr_rop.setPosition(instance_node.position() + hou.Vector2(0, -1))
        ipr_rop.parm("rop").set(instance_node.path())

        parms = {
            "trange": 1,
            "SettingsEXR_bits_per_channel": "16"   # half precision
        }

        if pre_create_data.get("render_target") == "farm_split":
            export_dir = hou.text.expandString("$HIP/pyblish/vrscene/")
            scene_filepath = (
                f"{export_dir}{product_name}/{product_name}.$F4.vrscene"
            )
            # Setting render_export_mode to "2" because that's for
            # "Export only" ("1" is for "Export & Render")
            parms["render_export_mode"] = "2"
            parms["render_export_filepath"] = scene_filepath

        if self.selected_nodes:
            # set up the render camera from the selected node
            camera = None
            for node in self.selected_nodes:
                if node.type().name() == "cam":
                    camera = node.path()
            parms.update({
                "render_camera": camera or ""
            })

        # Enable render element
        ext = pre_create_data.get("image_format")
        instance_data["RenderElement"] = pre_create_data.get("render_element_enabled")         # noqa
        if pre_create_data.get("render_element_enabled", True):
            # Vray has its own tag for AOV file output
            renders_dir = hou.text.expandString("$HIP/pyblish/renders/")
            filepath = (
                f"{renders_dir}{product_name}/{product_name}.$AOV.$F4.{ext}"
            )

            re_rop = instance_node.parent().createNode(
                "vray_render_channels",
                node_name=basename + "_render_element"
            )
            # move the render element node next to the vray renderer node
            re_rop.setPosition(instance_node.position() + hou.Vector2(0, 1))
            re_path = re_rop.path()
            parms.update({
                "use_render_channels": 1,
                "SettingsOutput_img_file_path": filepath,
                "render_network_render_channels": re_path
            })

        else:
            renders_dir = hou.text.expandString("$HIP/pyblish/renders/")
            filepath = f"{renders_dir}{product_name}/{product_name}.$F4.{ext}"
            parms.update({
                "use_render_channels": 0,
                "SettingsOutput_img_file_path": filepath
            })

        custom_res = pre_create_data.get("override_resolution")
        if custom_res:
            parms.update({"override_camerares": 1})

        instance_node.setParms(parms)

        # lock parameters from AVALON
        to_lock = ["productType", "id"]
        self.lock_parameters(instance_node, to_lock)

    def remove_instances(self, instances):
        for instance in instances:
            node = instance.data.get("instance_node")
            # for the extra render node from the plugins
            # such as vray and redshift
            ipr_node = hou.node("{}{}".format(node, "_IPR"))
            if ipr_node:
                ipr_node.destroy()
            re_node = hou.node("{}{}".format(node,
                                             "_render_element"))
            if re_node:
                re_node.destroy()

        return super(CreateVrayROP, self).remove_instances(instances)

    def get_instance_attr_defs(self):
        """get instance attribute definitions.

        Attributes defined in this method are exposed in
            publish tab in the publisher UI.
        """


        render_target_items = {
            "local": "Local machine rendering",
            "local_no_render": "Use existing frames (local)",
            "farm": "Farm Rendering",
            "farm_split": "Farm Rendering - Split export & render jobs",
        }

        return [
            BoolDef("review",
                    label="Review",
                    tooltip="Mark as reviewable",
                    default=True),
            EnumDef("render_target",
                    items=render_target_items,
                    label="Render target",
                    default=self.render_target)
        ]

    def get_pre_create_attr_defs(self):
        image_format_enum = [
            "bmp", "cin", "exr", "jpg", "pic", "pic.gz", "png",
            "rad", "rat", "rta", "sgi", "tga", "tif",
        ]

        attrs = super(CreateVrayROP, self).get_pre_create_attr_defs()

        attrs += [
            EnumDef("image_format",
                    image_format_enum,
                    default=self.ext,
                    label="Image Format Options"),
            BoolDef("override_resolution",
                    label="Override Camera Resolution",
                    tooltip="Override the current camera "
                            "resolution, recommended for IPR.",
                    default=False),
            BoolDef("render_element_enabled",
                    label="Render Element",
                    tooltip="Create Render Element Node "
                            "if enabled",
                    default=False)
        ]
        return attrs + self.get_instance_attr_defs()

get_instance_attr_defs()

get instance attribute definitions.

Attributes defined in this method are exposed in publish tab in the publisher UI.

Source code in client/ayon_houdini/plugins/create/create_vray_rop.py
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
def get_instance_attr_defs(self):
    """get instance attribute definitions.

    Attributes defined in this method are exposed in
        publish tab in the publisher UI.
    """


    render_target_items = {
        "local": "Local machine rendering",
        "local_no_render": "Use existing frames (local)",
        "farm": "Farm Rendering",
        "farm_split": "Farm Rendering - Split export & render jobs",
    }

    return [
        BoolDef("review",
                label="Review",
                tooltip="Mark as reviewable",
                default=True),
        EnumDef("render_target",
                items=render_target_items,
                label="Render target",
                default=self.render_target)
    ]