Skip to content

Visualization controller

gradysim.simulator.extension.visualization_controller.VisualizationController

Bases: Extension

Controller for the visualization handler. Can be used to send commands to the visualization handler from a protocol. Commands can be used to affect the visualization, such as painting nodes or changing the environment's color.

Info

Every method in this class is a no-op if a visualization handler is not active. This includes when the protocol is not running on a python simulation environment.

Warning

This class is an extension and will raise an error if the protocol is not running on a python simulation.

Source code in gradysim\simulator\extension\visualization_controller.py 
 8
 9
10
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class VisualizationController(Extension):
    """
    Controller for the visualization handler. Can be used to send commands to the visualization handler from a
    protocol. Commands can be used to affect the visualization, such as painting nodes or changing the
    environment's color.

    !!!info
        Every method in this class is a no-op if a visualization handler is not active. This includes when the protocol is
        not running on a python simulation environment.

    !!!warning
        This class is an [extension][gradysim.simulator.extension] and will raise an error if the protocol is not
        running on a python simulation.
    """
    def __init__(self, protocol: IProtocol):
        super().__init__(protocol)
        if self._provider is not None:
            self._visualization_handler: Optional[VisualizationHandler] = \
                self._provider.handlers.get("visualization") if self._provider is not None else None

    def paint_node(self, node_id: int, color: Tuple[float, float, float]) -> None:
        """
        Paints a node in the visualization with a specific color.

        Args:
            node_id: ID of the node to paint
            color: RGB color of the node
        """
        if self._visualization_handler is None:
            return

        self._visualization_handler.command_queue.put({
            "command": "paint_node",
            "payload": {
                "node_id": node_id,
                "color": color
            }
        })

    def paint_environment(self, color: Tuple[float, float, float]) -> None:
        """
        Paints the environment in the visualization with a specific color.

        Args:
            color: RGB color of the environment
        """
        if self._visualization_handler is None:
            return

        self._visualization_handler.command_queue.put({
            "command": "paint_environment",
            "payload": {
                "color": color
            }
        })

    def resize_nodes(self, size: float) -> None:
        """
        Resizes the nodes in the visualization
        Args:
            size: New size of the nodes
        """
        if self._visualization_handler is None:
            return

        self._visualization_handler.command_queue.put({
            "command": "resize_nodes",
            "payload": {
                "size": size
            }
        })

    def show_node_id(self, node_id: int, show: bool):
        """
        Paints or unpaints the node_id text over the node.
        Args:
            node_id: ID of the node
            show: wheter to show the node_id or not
        """
        if self._visualization_handler is None:
            return

        self._visualization_handler.command_queue.put({
            "command": "show_node_id",
            "payload": {
                "node_id": node_id,
                "show": show,
            }
        })

paint_environment(color)

Paints the environment in the visualization with a specific color.

Parameters:

Name Type Description Default
color Tuple[float, float, float]

RGB color of the environment

 required
Source code in gradysim\simulator\extension\visualization_controller.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def paint_environment(self, color: Tuple[float, float, float]) -> None:
    """
    Paints the environment in the visualization with a specific color.

    Args:
        color: RGB color of the environment
    """
    if self._visualization_handler is None:
        return

    self._visualization_handler.command_queue.put({
        "command": "paint_environment",
        "payload": {
            "color": color
        }
    })

paint_node(node_id, color)

Paints a node in the visualization with a specific color.

Parameters:

Name Type Description Default
node_id int

ID of the node to paint

 required
color Tuple[float, float, float]

RGB color of the node

 required
Source code in gradysim\simulator\extension\visualization_controller.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def paint_node(self, node_id: int, color: Tuple[float, float, float]) -> None:
    """
    Paints a node in the visualization with a specific color.

    Args:
        node_id: ID of the node to paint
        color: RGB color of the node
    """
    if self._visualization_handler is None:
        return

    self._visualization_handler.command_queue.put({
        "command": "paint_node",
        "payload": {
            "node_id": node_id,
            "color": color
        }
    })

resize_nodes(size)

Resizes the nodes in the visualization Args: size: New size of the nodes

Source code in gradysim\simulator\extension\visualization_controller.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def resize_nodes(self, size: float) -> None:
    """
    Resizes the nodes in the visualization
    Args:
        size: New size of the nodes
    """
    if self._visualization_handler is None:
        return

    self._visualization_handler.command_queue.put({
        "command": "resize_nodes",
        "payload": {
            "size": size
        }
    })

show_node_id(node_id, show)

Paints or unpaints the node_id text over the node. Args: node_id: ID of the node show: wheter to show the node_id or not

Source code in gradysim\simulator\extension\visualization_controller.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def show_node_id(self, node_id: int, show: bool):
    """
    Paints or unpaints the node_id text over the node.
    Args:
        node_id: ID of the node
        show: wheter to show the node_id or not
    """
    if self._visualization_handler is None:
        return

    self._visualization_handler.command_queue.put({
        "command": "show_node_id",
        "payload": {
            "node_id": node_id,
            "show": show,
        }
    })