Skip to content

load_ass

AssLoader

Bases: HoudiniLoader

Load .ass with Arnold Procedural

Source code in client/ayon_houdini/plugins/load/load_ass.py
 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
class AssLoader(plugin.HoudiniLoader):
    """Load .ass with Arnold Procedural"""

    product_types = {"ass"}
    label = "Load Arnold Procedural"
    representations = {"ass"}
    order = -10
    icon = "code-fork"
    color = "orange"

    def load(self, context, name=None, namespace=None, data=None):
        # Get the root node
        obj = hou.node("/obj")

        # Define node name
        namespace = namespace if namespace else context["folder"]["name"]
        node_name = "{}_{}".format(namespace, name) if namespace else name

        # Create a new geo node
        procedural = obj.createNode("arnold::procedural", node_name=node_name)

        procedural.setParms(
            {
                "ar_filename": self.format_path(context)
            })

        nodes = [procedural]
        self[:] = nodes

        return pipeline.containerise(
            node_name,
            namespace,
            nodes,
            context,
            self.__class__.__name__,
            suffix="",
        )

    def update(self, container, context):
        # Update the file path
        procedural = container["node"]
        procedural.setParms({
            "ar_filename": self.format_path(context),
            "representation": context["representation"]["id"]
        })

    def remove(self, container):
        node = container["node"]
        node.destroy()

    def format_path(self, context):
        """Format file path correctly for single ass.* or ass.* sequence.

        Args:
            context (dict): representation context to be loaded.

        Returns:
             str: Formatted path to be used by the input node.

        """
        path = self.filepath_from_context(context)
        # The path is either a single file or sequence in a folder.
        is_sequence = bool(context["representation"]["context"].get("frame"))
        if is_sequence:
            folder, filename = os.path.split(path)
            filename = re.sub(r"(.*)\.(\d+)\.(ass.*)", "\\1.$F4.\\3", filename)
            path = os.path.join(folder, filename)

        path = os.path.normpath(path)
        path = path.replace("\\", "/")
        return path

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

    def create_load_placeholder_node(
        self, node_name: str, placeholder_data: dict
    ) -> hou.Node:
        """Define how to create a placeholder node for this loader for the
        Workfile Template Builder system."""
        # Create node
        network = lib.find_active_network(
            category=hou.sopNodeTypeCategory(),
            default="/obj"
        )
        node = network.createNode("null", node_name=node_name)
        node.moveToGoodPosition()
        return node

create_load_placeholder_node(node_name, placeholder_data)

Define how to create a placeholder node for this loader for the Workfile Template Builder system.

Source code in client/ayon_houdini/plugins/load/load_ass.py
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def create_load_placeholder_node(
    self, node_name: str, placeholder_data: dict
) -> hou.Node:
    """Define how to create a placeholder node for this loader for the
    Workfile Template Builder system."""
    # Create node
    network = lib.find_active_network(
        category=hou.sopNodeTypeCategory(),
        default="/obj"
    )
    node = network.createNode("null", node_name=node_name)
    node.moveToGoodPosition()
    return node

format_path(context)

Format file path correctly for single ass. or ass. sequence.

Parameters:

Name Type Description Default
context dict

representation context to be loaded.

required

Returns:

Name Type Description
str

Formatted path to be used by the input node.

Source code in client/ayon_houdini/plugins/load/load_ass.py
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def format_path(self, context):
    """Format file path correctly for single ass.* or ass.* sequence.

    Args:
        context (dict): representation context to be loaded.

    Returns:
         str: Formatted path to be used by the input node.

    """
    path = self.filepath_from_context(context)
    # The path is either a single file or sequence in a folder.
    is_sequence = bool(context["representation"]["context"].get("frame"))
    if is_sequence:
        folder, filename = os.path.split(path)
        filename = re.sub(r"(.*)\.(\d+)\.(ass.*)", "\\1.$F4.\\3", filename)
        path = os.path.join(folder, filename)

    path = os.path.normpath(path)
    path = path.replace("\\", "/")
    return path