Skip to content

ayon_menus

AYONMenus

Bases: MinorMode

Source code in client/ayon_openrv/startup/pkgs_source/ayon_menus/ayon_menus.py
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
227
228
229
230
231
232
233
234
235
236
237
238
239
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
class AYONMenus(MinorMode):
    def __init__(self):
        MinorMode.__init__(self)

        self.review_controller = None

        bindings: list[tuple[str, Callable, str]] = [
            # event name, callback, description
            (
                "ayon_load_container",
                on_ayon_load_container,
                "Loads an AYON representation into the session.",
            ),
            (
                "session-initialized",
                self._open_visible_panels,
                "Open visible panels on session initialization",
            ),
        ]
        if os.getenv("AYON_RV_UNSET_SESSION") == "1":
            bindings.append((
                "after-session-read",
                self._unset_session_filename,
                "Unset session after start",
            ))

        self.init(
            name="py-ayon",
            globalBindings=None,
            overrideBindings=bindings,
            menu=[
                # Menu name
                # NOTE: If it already exists it will merge with existing
                # and add submenus / menuitems to the existing one
                ("AYON", self.menu_item()),
            ],
            # initialization order
            sortKey="source_setup",
            ordering=15,
        )
        self._panel_startup_visibility = []
        self._connected_panels = set()
        self._is_closing = False
        self._session_was_unset = False

    def _unset_session_filename(self, event=None):
        # Only ever run once
        if self._session_was_unset:
            return

        self._session_was_unset = True
        logging.debug("Unsetting session filename...")
        rv.commands.setSessionFileName("")

    def _read_panel_startup_visibility(self):
        return rv.commands.readSettings("ayon", "panel_startup_visibility", [])

    def _write_panel_startup_visibility(self, panel_name: str, visible: bool):
        if self._is_closing:
            return

        if visible:
            if panel_name not in self._panel_startup_visibility:
                self._panel_startup_visibility.append(panel_name)
        else:
            if panel_name in self._panel_startup_visibility:
                self._panel_startup_visibility.remove(panel_name)
        rv.commands.writeSettings(
            "ayon", "panel_startup_visibility", self._panel_startup_visibility
        )

    def _open_visible_panels(self, event):
        """Re-open desktop review panels that were visible last session."""
        event.reject()
        if self.review_controller is None:
            return

        self._panel_startup_visibility: list[str] = (
            self._read_panel_startup_visibility()
        )

        for panel_name in self._panel_startup_visibility:
            QTimer.singleShot(
                0, partial(self.open_desktop_review_panel, panel_name)
            )

    @property
    def _parent(self):
        return rv.qtutils.sessionWindow()

    def load(self, event):
        host_tools.show_loader(parent=self._parent, use_context=True)

    def publish(self, event):
        host_tools.show_publisher(parent=self._parent, tab="publish")

    def workfiles(self, event):
        host_tools.show_workfiles(parent=self._parent)

    def scene_inventory(self, event):
        host_tools.show_scene_inventory(parent=self._parent)

    def library(self, event):
        host_tools.show_library_loader(parent=self._parent)

    def _on_app_closing(self):
        self._is_closing = True

    def open_desktop_review_panel(self, panel_name: str, *_):
        if self.review_controller is None:
            raise RuntimeError(
                "Unable to open desktop review panel because desktop review"
                " has not been initialized."
            )

        panel = self.review_controller.get_panel(panel_name)
        dock_widget = self.review_controller.set_docker_widget(
            self._parent, panel, panel_name
        )
        # get the data
        self.review_controller.set_project(get_current_project_name() or "")
        self.review_controller.load_ayon_data()

        if dock_widget and panel_name not in self._connected_panels:
            filter_ = DockCloseFilter(
                panel_name,
                self._write_panel_startup_visibility,
                parent=dock_widget,
            )
            dock_widget.installEventFilter(filter_)
            self._connected_panels.add(panel_name)

    def add_desktop_review_menu_items(self, menu):
        # Check if addon is enabled
        project_settings = get_project_settings(get_current_project_name())
        review_desktop = project_settings.get("review_desktop", {})
        if not review_desktop.get("enabled", False):
            return

        # import review desktop controller
        try:
            from ayon_review_desktop.session_controller import ReviewController
        except ImportError:
            print("Failed to import 'ayon_review_desktop.session_controller':")
            traceback.print_exc()
            return

        # Instantiate controller and add menu items.
        self.review_controller = ReviewController(host="rv")
        menu.append(("_", None))  # separator
        for k, panel_name in enumerate(
            self.review_controller.get_available_panels()
        ):
            label = panel_name.replace("_", " ").capitalize()
            menu.append(
                (
                    f"{label}...",
                    partial(self.open_desktop_review_panel, panel_name),
                    f"control shift {k + 1}",
                    None,
                )
            )

    def menu_item(self):
        menu = [
            # Menuitem name, actionHook (event), key, stateHook
            ("Load...", self.load, None, None),
            ("Publish...", self.publish, None, None),
            ("Manage...", self.scene_inventory, None, None),
            ("Library...", self.library, None, None),
            ("_", None),  # separator
            ("Work Files...", self.workfiles, None, None),
        ]
        # Add Activity Stream menu item if enabled in project settings
        self.add_desktop_review_menu_items(menu)

        # Add a callback to detect when RV is closing
        QApplication.instance().aboutToQuit.connect(self._on_app_closing)

        return menu

load_representations(representation_ids)

Load media by representation id and pick the relevant loader.

Source code in client/ayon_openrv/startup/pkgs_source/ayon_menus/ayon_menus.py
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
def load_representations(representation_ids: list[str]):
    """Load media by representation id and pick the relevant loader."""
    project_name = get_current_project_name()
    loaders_by_name = get_loaders_by_name()

    representations = get_representations(
        project_name, representation_ids=representation_ids
    )
    for representation in representations:
        ext: str = (
            representation.get("data", {}).get("context", {}).get("ext")
            or representation["name"]
        )
        ext = f".{ext}"
        if ext in VIDEO_EXTENSIONS:
            loader_name = "MovLoader"
        elif ext in IMAGE_EXTENSIONS:
            loader_name = "FramesLoader"
        else:
            # Fallback
            logging.warning(
                "Unknown media extension: %s. Falling back to 'FramesLoader'",
                ext
            )
            loader_name = "FramesLoader"
        Loader = loaders_by_name.get(loader_name)
        load_container(Loader, representation)