Artist Redraw and Clear

[Brian-Jiang]

Here are some properties and methods of an artist to control the rendering:

• is_visible: if this is false, the artist is not visible on the screen. Internally, the updating should also stopped.
• is_updating: if this is true, the artist's drawing will update every frame; otherwise, it will remain static in the world, meaning the position/size will not changing
• update_drawing: only needs to call this method when is_updating is False, this will update the drawing of the artist
• clear: only needs to call this method when is_updating is False, this will clear the drawing of the artist

class IArtist(ABC):
    @abstractmethod
    def set_visible(self, visible: bool) -> None:
        """
        Set the visibility of the artist.

        Args:
            visible (bool): The visibility state to set.
        """
        pass

    @abstractmethod
    def get_visible(self) -> bool:
        """
        Get the visibility of the artist.

        Returns:
            bool: The current visibility state of the artist.
        """
        pass

    @abstractmethod
    def get_is_updating(self) -> bool:
        """
        Get whether the artist is updating the drawing every frame.

        Returns:
            bool: True if the artist is updating the drawing every frame, False otherwise.
        """
        pass

    @abstractmethod
    def set_is_updating(self, is_updating: bool) -> None:
        """
        Set whether the artist is updating the drawing every frame.

        Args:
            is_updating(bool): The is_updating state to set.
        """
        pass

    @abstractmethod
    def update_drawing(self) -> None:
        """
        Update the drawing of the artist immediately. Should only call this method when the artist is not updating.
        """
        pass

    @abstractmethod
    def clear(self) -> None:
        """
        Clear the artist drawing immediately. Should only call this method when the artist is not updating.
        """
        pass

    # ...other artist APIs

[bridgesign]

In place of set_visible and get_visible, they can be renamed as visible (visible(True) or visible(False)) and is_visible. Seems more natural language like. Similarly, for set_is_updating and get_is_updating, it can be rerender(bool) and rerendering might be better. Why not just call update_drawing as draw? Plus for clear and update_drawing it should not matter if is_updating is True or False. When its true, it will be no-op and only have any effect when its false.

Also, what's the behavior if its set to not visible when its not updating every frame?

Everything else looks good.

[Brian-Jiang]

Sure, I can change names. If it's not visible and not updating, you can't see it on screen; later if you make it visible, it should be showing but remains static.