Skip to content

ae_host_tools

AEHostToolsHelper

Bases: HostToolsHelper

After Effects host tools wrapper with addon-local tools.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
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
class AEHostToolsHelper(HostToolsHelper):
    """After Effects host tools wrapper with addon-local tools."""

    def __init__(self, parent=None):
        super().__init__(parent=parent)
        self._run_scripts_tool = None

    def get_run_scripts_tool(self, parent=None):
        """Create, cache, and return the run scripts dialog.

        Args:
            parent: Optional parent widget.

        Returns:
            Cached run scripts dialog.
        """
        if self._run_scripts_tool is None:
            self._run_scripts_tool = RunScriptsWindow(
                service=get_script_service(),
                parent=parent or self._parent,
            )
        return self._run_scripts_tool

    def show_run_scripts_tool(self, parent=None):
        """Show the manual run scripts dialog.

        Args:
            parent: Optional parent widget.
        """
        with qt_app_context():
            window = self.get_run_scripts_tool(parent)
            window.refresh()
            raise_window_to_front(window)

    def get_tool_by_name(self, tool_name, parent=None, *args, **kwargs):
        """Return a cached tool window by name.

        Args:
            tool_name: Tool identifier.
            parent: Optional parent widget.
            *args: Unused positional arguments passed through.
            **kwargs: Unused keyword arguments passed through.

        Returns:
            Cached tool instance.
        """
        if tool_name == _TOOL_RUN_SCRIPTS:
            return self.get_run_scripts_tool(parent)
        return super().get_tool_by_name(tool_name, parent, *args, **kwargs)

    def show_tool_by_name(self, tool_name, parent=None, *args, **kwargs):
        """Show a tool window by name.

        Args:
            tool_name: Tool identifier.
            parent: Optional parent widget.
            *args: Positional arguments passed through.
            **kwargs: Keyword arguments passed through.
        """
        if tool_name == _TOOL_RUN_SCRIPTS:
            self.show_run_scripts_tool(parent)
            return
        super().show_tool_by_name(tool_name, parent, *args, **kwargs)

get_run_scripts_tool(parent=None)

Create, cache, and return the run scripts dialog.

Parameters:

Name Type Description Default
parent

Optional parent widget.

None

Returns:

Type Description

Cached run scripts dialog.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def get_run_scripts_tool(self, parent=None):
    """Create, cache, and return the run scripts dialog.

    Args:
        parent: Optional parent widget.

    Returns:
        Cached run scripts dialog.
    """
    if self._run_scripts_tool is None:
        self._run_scripts_tool = RunScriptsWindow(
            service=get_script_service(),
            parent=parent or self._parent,
        )
    return self._run_scripts_tool

get_tool_by_name(tool_name, parent=None, *args, **kwargs)

Return a cached tool window by name.

Parameters:

Name Type Description Default
tool_name

Tool identifier.

required
parent

Optional parent widget.

None
*args

Unused positional arguments passed through.

()
**kwargs

Unused keyword arguments passed through.

{}

Returns:

Type Description

Cached tool instance.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def get_tool_by_name(self, tool_name, parent=None, *args, **kwargs):
    """Return a cached tool window by name.

    Args:
        tool_name: Tool identifier.
        parent: Optional parent widget.
        *args: Unused positional arguments passed through.
        **kwargs: Unused keyword arguments passed through.

    Returns:
        Cached tool instance.
    """
    if tool_name == _TOOL_RUN_SCRIPTS:
        return self.get_run_scripts_tool(parent)
    return super().get_tool_by_name(tool_name, parent, *args, **kwargs)

show_run_scripts_tool(parent=None)

Show the manual run scripts dialog.

Parameters:

Name Type Description Default
parent

Optional parent widget.

None
Source code in client/ayon_aftereffects/api/ae_host_tools.py
34
35
36
37
38
39
40
41
42
43
def show_run_scripts_tool(self, parent=None):
    """Show the manual run scripts dialog.

    Args:
        parent: Optional parent widget.
    """
    with qt_app_context():
        window = self.get_run_scripts_tool(parent)
        window.refresh()
        raise_window_to_front(window)

show_tool_by_name(tool_name, parent=None, *args, **kwargs)

Show a tool window by name.

Parameters:

Name Type Description Default
tool_name

Tool identifier.

required
parent

Optional parent widget.

None
*args

Positional arguments passed through.

()
**kwargs

Keyword arguments passed through.

{}
Source code in client/ayon_aftereffects/api/ae_host_tools.py
61
62
63
64
65
66
67
68
69
70
71
72
73
def show_tool_by_name(self, tool_name, parent=None, *args, **kwargs):
    """Show a tool window by name.

    Args:
        tool_name: Tool identifier.
        parent: Optional parent widget.
        *args: Positional arguments passed through.
        **kwargs: Keyword arguments passed through.
    """
    if tool_name == _TOOL_RUN_SCRIPTS:
        self.show_run_scripts_tool(parent)
        return
    super().show_tool_by_name(tool_name, parent, *args, **kwargs)

get_tool_by_name(tool_name, parent=None, *args, **kwargs)

Return an After Effects host tool by name.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
86
87
88
def get_tool_by_name(tool_name, parent=None, *args, **kwargs):
    """Return an After Effects host tool by name."""
    return _get_helper().get_tool_by_name(tool_name, parent, *args, **kwargs)

show_run_scripts_tool(parent=None)

Show the manual run scripts tool.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
96
97
98
def show_run_scripts_tool(parent=None):
    """Show the manual run scripts tool."""
    _get_helper().show_tool_by_name(_TOOL_RUN_SCRIPTS, parent)

show_tool_by_name(tool_name, parent=None, *args, **kwargs)

Show an After Effects host tool by name.

Source code in client/ayon_aftereffects/api/ae_host_tools.py
91
92
93
def show_tool_by_name(tool_name, parent=None, *args, **kwargs):
    """Show an After Effects host tool by name."""
    _get_helper().show_tool_by_name(tool_name, parent, *args, **kwargs)