Skip to content

pipeline

Pipeline tools for AYON Houdini integration.

HoudiniHost

Bases: HostBase, IWorkfileHost, ILoadHost, IPublishHost

Source code in client/ayon_houdini/api/pipeline.py
 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
class HoudiniHost(HostBase, IWorkfileHost, ILoadHost, IPublishHost):
    name = "houdini"

    def __init__(self):
        super(HoudiniHost, self).__init__()
        self._op_events = {}
        self._has_been_setup = False

    def get_app_information(self):
        from ayon_core.host import ApplicationInformation

        hou_name = hou.applicationName()
        license_name = hou.licenseCategory().name()
        if hou_name == "houdinicore":
            app_name = "Houdini Core"

        elif hou_name == "houdinifx":
            app_name = "Houdini FX"

        elif hou_name == "happrentice":
            app_name = "Houdini"
        else:
            print(f"Unknown houdini app name: {hou_name}")
            app_name = "Houdini"

        full_app_name = f"{app_name} {license_name}"

        return ApplicationInformation(
            app_name=full_app_name,
            app_version=hou.applicationVersionString(),
        )

    def install(self):
        pyblish.api.register_host("houdini")
        pyblish.api.register_host("hython")
        pyblish.api.register_host("hpython")

        pyblish.api.register_plugin_path(PUBLISH_PATH)
        register_loader_plugin_path(LOAD_PATH)
        register_creator_plugin_path(CREATE_PATH)
        register_inventory_action_path(INVENTORY_PATH)
        register_workfile_build_plugin_path(WORKFILE_BUILD_PATH)

        log.info("Installing callbacks ... ")
        # register_event_callback("init", on_init)
        self._register_callbacks()
        register_event_callback("workfile.save.before", before_workfile_save)
        register_event_callback("before.save", before_save)
        register_event_callback("save", on_save)
        register_event_callback("open", on_open)
        register_event_callback("new", on_new)
        register_event_callback("taskChanged", on_task_changed)

        self._has_been_setup = True

        # Manually call on_new callback as it doesn't get called when AYON
        # launches for the first time on a context, only when going to
        # File -> New
        on_new()

        if not IS_HEADLESS:
            import hdefereval  # noqa, hdefereval is only available in ui mode
            # Defer generation of shelves due to issue on Windows where shelf
            # initialization during start up delays Houdini UI by minutes
            # making it extremely slow to launch.
            hdefereval.executeDeferred(shelves.generate_shelves)
            hdefereval.executeDeferred(creator_node_shelves.install)
            if env_value_to_bool("AYON_WORKFILE_TOOL_ON_START"):
                hdefereval.executeDeferred(
                    lambda: host_tools.show_workfiles(
                        parent=hou.qt.mainWindow()
                    )
                )

    def workfile_has_unsaved_changes(self):
        return hou.hipFile.hasUnsavedChanges()

    def get_workfile_extensions(self):
        return [".hip", ".hiplc", ".hipnc"]

    def save_workfile(self, dst_path=None):
        # Force forwards slashes to avoid segfault
        if dst_path:
            dst_path = dst_path.replace("\\", "/")
        hou.hipFile.save(file_name=dst_path,
                         save_to_recent_files=True)
        return dst_path

    def open_workfile(self, filepath):
        # Force forwards slashes to avoid segfault
        filepath = filepath.replace("\\", "/")

        try:
            hou.hipFile.load(filepath,
                             suppress_save_prompt=True,
                             ignore_load_warnings=False)
        except hou.LoadWarning as exc:
            log.warning(exc)

        return filepath

    def get_current_workfile(self):
        current_filepath = hou.hipFile.path()
        if (os.path.basename(current_filepath) == "untitled.hip" and
                not os.path.exists(current_filepath)):
            # By default a new scene in houdini is saved in the current
            # working directory as "untitled.hip" so we need to capture
            # that and consider it 'not saved' when it's in that state.
            return None

        return current_filepath

    def get_containers(self):
        return ls()

    def _register_callbacks(self):
        for event in self._op_events.copy().values():
            if event is None:
                continue

            try:
                hou.hipFile.removeEventCallback(event)
            except RuntimeError as e:
                log.info(e)

        self._op_events[on_file_event_callback] = hou.hipFile.addEventCallback(
            on_file_event_callback
        )

    @staticmethod
    def create_context_node():
        """Helper for creating context holding node.

        Returns:
            hou.Node: context node

        """
        parent_name, name  = CONTEXT_CONTAINER.rsplit("/", 1)
        obj_network = hou.node(parent_name)
        op_ctx = obj_network.createNode("subnet",
                                        node_name=name,
                                        run_init_scripts=False,
                                        load_contents=False)

        op_ctx.moveToGoodPosition()
        op_ctx.setBuiltExplicitly(False)
        op_ctx.setCreatorState("AYON")
        op_ctx.setComment("AYON node to hold context metadata")
        op_ctx.setColor(hou.Color((0.081, 0.798, 0.810)))
        op_ctx.setDisplayFlag(False)
        op_ctx.hide(True)
        return op_ctx

    @staticmethod
    def get_context_node() -> "Optional[hou.OpNode]":
        return (
            hou.node(CONTEXT_CONTAINER)
            or hou.node(LEGACY_CONTEXT_CONTAINER)
        )

    def update_context_data(self, data, changes):
        context_node = self.get_context_node() or self.create_context_node()
        lib.imprint(context_node, data, update=True)

    def get_context_data(self) -> dict:
        context_node = self.get_context_node()
        if not context_node:
            return {}
        return lib.read(context_node)

create_context_node() staticmethod

Helper for creating context holding node.

Returns:

Type Description

hou.Node: context node

Source code in client/ayon_houdini/api/pipeline.py
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
@staticmethod
def create_context_node():
    """Helper for creating context holding node.

    Returns:
        hou.Node: context node

    """
    parent_name, name  = CONTEXT_CONTAINER.rsplit("/", 1)
    obj_network = hou.node(parent_name)
    op_ctx = obj_network.createNode("subnet",
                                    node_name=name,
                                    run_init_scripts=False,
                                    load_contents=False)

    op_ctx.moveToGoodPosition()
    op_ctx.setBuiltExplicitly(False)
    op_ctx.setCreatorState("AYON")
    op_ctx.setComment("AYON node to hold context metadata")
    op_ctx.setColor(hou.Color((0.081, 0.798, 0.810)))
    op_ctx.setDisplayFlag(False)
    op_ctx.hide(True)
    return op_ctx

containerise(name, namespace, nodes, context, loader=None, suffix='')

Bundle nodes into a subnet and imprint it with metadata

Containerisation enables a tracking of version, author and origin for loaded products.

Parameters:

Name Type Description Default
name str

Name of resulting assembly

required
namespace str

Namespace under which to host container

required
nodes list

Long names of nodes to containerise

required
context dict

Loaded product context information

required
loader str

Name of loader used to produce this container.

None
suffix str

Suffix of container, defaults to _CON.

''

Returns:

Name Type Description
container str

Name of container assembly

Source code in client/ayon_houdini/api/pipeline.py
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
def containerise(name,
                 namespace,
                 nodes,
                 context,
                 loader=None,
                 suffix=""):
    """Bundle `nodes` into a subnet and imprint it with metadata

    Containerisation enables a tracking of version, author and origin
    for loaded products.

    Arguments:
        name (str): Name of resulting assembly
        namespace (str): Namespace under which to host container
        nodes (list): Long names of nodes to containerise
        context (dict): Loaded product context information
        loader (str, optional): Name of loader used to produce this container.
        suffix (str, optional): Suffix of container, defaults to `_CON`.

    Returns:
        container (str): Name of container assembly

    """

    # Get AYON Containers subnet
    subnet = get_or_create_ayon_container()

    # Create proper container name
    container_name = "{}_{}".format(name, suffix or "CON")
    container = hou.node("/obj/{}".format(name))
    container.setName(container_name, unique_name=True)

    data = {
        "schema": "ayon:container-3.0",
        "id": AYON_CONTAINER_ID,
        "name": name,
        "namespace": namespace,
        "loader": str(loader),
        "representation": context["representation"]["id"],
        "project_name": context["project"]["name"]
    }

    lib.imprint(container, data)

    # "Parent" the container under the container network
    hou.moveNodesTo([container], subnet)

    subnet.node(container_name).moveToGoodPosition()

    return container

get_or_create_avalon_container()

Deprecated, please use get_or_create_ayon_container instead.

Source code in client/ayon_houdini/api/pipeline.py
486
487
488
489
490
491
492
493
def get_or_create_avalon_container():
    """Deprecated, please use `get_or_create_ayon_container` instead."""
    warnings.warn(
        "get_or_create_avalon_container is deprecated, "
        "please use get_or_create_ayon_container instead.",
        DeprecationWarning
    )
    return get_or_create_ayon_container()

on_new()

Set project resolution and fps when create a new file

Source code in client/ayon_houdini/api/pipeline.py
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
def on_new():
    """Set project resolution and fps when create a new file"""

    if hou.hipFile.isLoadingHipFile():
        # This event also triggers when Houdini opens a file due to the
        # new event being registered to 'afterClear'. As such we can skip
        # 'new' logic if the user is opening a file anyway
        log.debug("Skipping on new callback due to scene being opened.")
        return

    log.info("Running callback on new..")
    _set_context_settings()

    # It seems that the current frame always gets reset to frame 1 on
    # new scene. So we enforce current frame to be at the start of the playbar
    # with execute deferred
    def _enforce_start_frame():
        start = hou.playbar.playbackRange()[0]
        hou.setFrame(start)

    if hou.isUIAvailable():
        import hdefereval
        hdefereval.executeDeferred(lib.start_workfile_template_builder)
        hdefereval.executeDeferred(_enforce_start_frame)
    else:
        # Run without execute deferred when no UI is available because
        # without UI `hdefereval` is not available to import
        _enforce_start_frame()

parse_container(container)

Return the container node's full container data.

Parameters:

Name Type Description Default
container Node

A container node name.

required

Returns:

Name Type Description
dict

The container schema data for this container node.

Source code in client/ayon_houdini/api/pipeline.py
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
def parse_container(container):
    """Return the container node's full container data.

    Args:
        container (hou.Node): A container node name.

    Returns:
        dict: The container schema data for this container node.

    """
    # Read only relevant parms
    # TODO: Clean up this hack replacing `lib.read(container)`

    data = {}
    for name in ["name", "namespace", "loader", "representation", "id"]:
        parm = container.parm(name)
        if not parm:
            return {}

        value = parm.eval()

        # test if value is json encoded dict
        if isinstance(value, str) and value.startswith(JSON_PREFIX):
            try:
                value = json.loads(value[len(JSON_PREFIX):])
            except json.JSONDecodeError:
                # not a json
                pass
        data[name] = value

    # Support project name in container as optional attribute
    for name in ["project_name"]:
        parm = container.parm(name)
        if not parm:
            continue
        data[name] = parm.eval()

    # Backwards compatibility pre-schemas for containers
    data["schema"] = data.get("schema", "ayon:container-3.0")

    # Append transient data
    data["objectName"] = container.path()
    data["node"] = container

    return data