Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/232.maintenance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Move streamed-render protocols out of server_renderer
2 changes: 1 addition & 1 deletion src/ansys/visor/viewer/app/trame/server_loop_bridge.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from trame_rca.view_adapter import RcaViewAdapter

from ansys.visor.viewer.app.trame.async_runner import AsyncRunner
from ansys.visor.viewer.renderer.server_renderer import FrameRequester
from ansys.visor.viewer.renderer.streamed_protocols import FrameRequester


class ServerLoopBridge(FrameRequester):
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/visor/viewer/app/trame/server_state_publisher.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from ansys.visor.viewer.app.trame.async_runner import AsyncRunner
from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState
from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState
from ansys.visor.viewer.renderer.server_renderer import ViewRecordPublisher
from ansys.visor.viewer.renderer.streamed_protocols import ViewRecordPublisher

SERVER_CAMERA_STATE_KEY: str = "server_camera_state"
"""State key carrying the server's camera record, as its camelCase fields, or None."""
Expand Down
29 changes: 5 additions & 24 deletions src/ansys/visor/viewer/renderer/server_renderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,18 @@

from __future__ import annotations

from typing import Protocol

# Registers the OpenGL2 factory overrides, so vtkRenderWindow() is a
# concrete off-screen-capable window rather than the abstract base.
import vtkmodules.vtkRenderingOpenGL2 # noqa: F401
from vtkmodules.vtkCommonCore import vtkObject
from vtkmodules.vtkRenderingCore import vtkRenderWindow

from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState
from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState
from ansys.visor.viewer.renderer.pipeline_renderer import VtkPipelineRenderer

INITIAL_WINDOW_SIZE: tuple[int, int] = (300, 300)
"""Window size before the client reports its canvas; trame-rca's pre-resize image size."""


class FrameRequester(Protocol):
"""Where a ServerRenderer asks for a streamed frame."""

def request_frame(self) -> None:
"""Ask for a streamed frame; callable from any thread."""


class ViewRecordPublisher(Protocol):
"""Where a ServerRenderer publishes its camera and cross-section plane records."""

def publish_camera(self, camera_state: VisorCameraState | None) -> None:
"""Publish the camera record to clients, or None when there is none; callable from any thread."""

def publish_cross_section(self, cross_section_state: VisorCrossSectionState | None) -> None:
"""Publish the plane record to clients, or None when there is none; callable from any thread."""
from ansys.visor.viewer.renderer.streamed_protocols import (
INITIAL_WINDOW_SIZE,
FrameRequester,
ViewRecordPublisher,
)


class ServerRenderer(VtkPipelineRenderer):
Expand Down
10 changes: 5 additions & 5 deletions src/ansys/visor/viewer/renderer/server_window.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
VisorRcaWindow
==============
trame-rca remote-controlled area over a :class:`ServerRenderer`.
trame-rca remote-controlled area over an :class:`RcaRenderTarget`.

trame-rca's scheduler reads :attr:`VisorRcaWindow.img_cols_rows` on the event
loop thread, and its resize and interaction RPCs arrive on the same thread.
Expand All @@ -25,7 +25,7 @@
from trame_rca.rca.protocol import RemoteControlledAreaProtocol

from ansys.visor.viewer.renderer.gl_context_lock import SceneLock
from ansys.visor.viewer.renderer.server_renderer import INITIAL_WINDOW_SIZE, ServerRenderer
from ansys.visor.viewer.renderer.streamed_protocols import INITIAL_WINDOW_SIZE, RcaRenderTarget

GESTURE_END_EVENT_TYPES: frozenset[str] = frozenset(
{"LeftButtonRelease", "MiddleButtonRelease", "RightButtonRelease", "MouseWheel"}
Expand All @@ -38,10 +38,10 @@


class VisorRcaWindow:
"""trame-rca area over a ServerRenderer that touches VTK only while holding the scene lock."""
"""trame-rca area over an RcaRenderTarget that touches VTK only while holding the scene lock."""

_capture: RemoteControlledAreaProtocol
_renderer: ServerRenderer
_renderer: RcaRenderTarget
_vtk_lock: SceneLock
_reschedule: Callable[[], None]
_pending_size: tuple[int, int] | None
Expand All @@ -53,7 +53,7 @@ class VisorRcaWindow:
def __init__(
self,
capture: RemoteControlledAreaProtocol,
renderer: ServerRenderer,
renderer: RcaRenderTarget,
vtk_lock: SceneLock,
reschedule: Callable[[], None],
) -> None:
Expand Down
71 changes: 71 additions & 0 deletions src/ansys/visor/viewer/renderer/streamed_protocols.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
"""
Streamed-render protocols
=========================
The names a streamed view's renderer, window, loop bridge and state publisher
share, kept apart from :mod:`ansys.visor.viewer.renderer.server_renderer` so
that importing them does not import the off-screen VTK pipeline.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, Protocol

from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState
from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState

if TYPE_CHECKING:
from vtkmodules.vtkRenderingCore import vtkRenderWindow

INITIAL_WINDOW_SIZE: tuple[int, int] = (300, 300)
"""Window size before the client reports its canvas; trame-rca's pre-resize image size."""

BACKGROUND_RGB: dict[bool, tuple[float, float, float]] = {
False: (247 / 255, 247 / 255, 247 / 255),
True: (54 / 255, 60 / 255, 67 / 255),
}
"""Viewer background per theme, keyed on dark.

The values of ``--visor-viewer-background`` in the client's
``public/css/theme-light.css`` and ``public/css/theme-dark.css``.
"""


class FrameRequester(Protocol):
"""Where a ServerRenderer asks for a streamed frame."""

def request_frame(self) -> None:
"""Ask for a streamed frame; callable from any thread."""


class ViewRecordPublisher(Protocol):
"""Where a ServerRenderer publishes its camera and cross-section plane records."""

def publish_camera(self, camera_state: VisorCameraState | None) -> None:
"""Publish the camera record to clients, or None when there is none; callable from any thread."""

def publish_cross_section(self, cross_section_state: VisorCrossSectionState | None) -> None:
"""Publish the plane record to clients, or None when there is none; callable from any thread."""


class RcaRenderTarget(Protocol):
"""The renderer surface VisorRcaWindow captures from and resizes."""

@property
def render_window(self) -> vtkRenderWindow:
"""The window the capture reads and releases."""

@property
def background_rgb(self) -> tuple[float, float, float]:
"""The colour the placeholder frame is filled with."""

def set_viewport_size(self, width: int, height: int) -> None:
"""Resize to the client canvas in device pixels."""

def set_pixel_scale(self, pixel_scale: float) -> None:
"""Take the client's device pixels per CSS pixel."""

def record_pipeline_camera(self) -> None:
"""Record and publish the camera after a gesture; caller holds the lock."""

def record_cross_section_plane(self) -> None:
"""Record and publish a dragged plane after a gesture; caller holds the lock."""
13 changes: 2 additions & 11 deletions src/ansys/visor/viewer/vtk/scene/server_scene.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,14 @@
from ansys.visor.viewer.renderer.gl_context_lock import GlContextLock
from ansys.visor.viewer.renderer.server_renderer import ServerRenderer
from ansys.visor.viewer.renderer.server_window import VisorRcaWindow
from ansys.visor.viewer.renderer.streamed_protocols import BACKGROUND_RGB
from ansys.visor.viewer.vtk.scene.base import VisorSceneBase

if TYPE_CHECKING:
from ansys.visor.viewer.app.trame.server_loop_bridge import ServerLoopBridge
from ansys.visor.viewer.models.runtime.picking.geometry_pick import GeometryPick
from ansys.visor.viewer.models.runtime.scene.runtime_app_state import RuntimeAppState
from ansys.visor.viewer.renderer.server_renderer import ViewRecordPublisher

BACKGROUND_RGB: dict[bool, tuple[float, float, float]] = {
False: (247 / 255, 247 / 255, 247 / 255),
True: (54 / 255, 60 / 255, 67 / 255),
}
"""Viewer background per theme, keyed on dark.

The values of ``--visor-viewer-background`` in the client's
``public/css/theme-light.css`` and ``public/css/theme-dark.css``.
"""
from ansys.visor.viewer.renderer.streamed_protocols import ViewRecordPublisher


class VisorServerScene(VisorSceneBase):
Expand Down
43 changes: 43 additions & 0 deletions tests/unit/renderer/test_streamed_protocols.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
"""
Unit tests for what the streamed modules load on import.

A fresh interpreter imports the trame app and the state publisher a streamed
session uses, then reports every loaded module name. Neither may pull in the
off-screen VTK pipeline, nor trame-vtklocal through it.
"""

from __future__ import annotations

import json
import subprocess
import sys

import pytest

_IMPORT_SCRIPT = (
"import json, sys\n"
"import ansys.visor.viewer.app.trame.server_app\n"
"import ansys.visor.viewer.app.trame.server_state_publisher\n"
"print(json.dumps(sorted(sys.modules)))\n"
)


@pytest.fixture(scope="module")
def loaded_modules() -> set[str]:
"""Module names loaded by a fresh interpreter after importing the streamed modules."""
result = subprocess.run(
[sys.executable, "-c", _IMPORT_SCRIPT],
capture_output=True,
text=True,
check=True,
)
# Settings loading may print first; the module list is the last line.
return set(json.loads(result.stdout.strip().splitlines()[-1]))


def test_streamed_imports_leave_server_renderer_unloaded(loaded_modules: set[str]) -> None:
assert "ansys.visor.viewer.renderer.server_renderer" not in loaded_modules


def test_streamed_imports_leave_trame_vtklocal_unloaded(loaded_modules: set[str]) -> None:
assert "trame_vtklocal" not in loaded_modules
Loading