Skip to content

Blit manager

BlitManager

Do not use this class unless you know what blitting is and you are familiar with the rest of the code.

Source code in itfit/utils/blit_manager.py 
 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
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
class BlitManager:
    """**Do not use this class unless you know what blitting is and you are familiar with the rest of the code.**"""
    def __init__(self, app):
        """Class for managing blitting. DragObjects must be appended to `self.artists`.
        BlitManager must be manualy enabled and disabled.
        `with` statements can be used to enable or disable blitting temporaly.

        Parameters:
            app (Fitter):
                Aplication using BlitManager.
        """

        self.app = app
        self.ax = app.ax
        self.canvas = app.figure.canvas

        self.artists = []

        self._bind_motion_ : int = -1
        self._enabled_ = False
        self.background = None
        self.draw_event_connection_id = None

    def get_background(self):
        """"Gets current background and saves it, used in blitting process."""
        for a in self.artists:
            a.poly.set_visible(False)

        for a in self.ax.artists:
            self.ax.draw_artists(a)

        self.canvas.blit()

        return self.canvas.copy_from_bbox(self.ax.bbox)

    def update_background(self):
        """Updates saved background, used in blitting process."""
        self.background = self.get_background()

    def draw(self, artists_visible=True):
        """Draws the canvas using blitting."""
        if self.background is None:
            self.update_background()
        self.canvas.restore_region(self.background)

        for a in self.artists:
            try: # if custom object
                a.update()
                a.poly.set_visible(artists_visible)
                self.ax.draw_artist(a.poly)
            except AttributeError: # if matplotlib artists
                a.set_visible(artists_visible)
                self.ax.draw_artis(a)

        self.canvas.blit(self.ax.bbox)

    def on_draw(self, event):
        """Trigger for draw event."""
        self.draw()

    def enable(self):
        """Enables BlitManager."""
        if not self._enabled_:
            self.update_background()
            self._enabled_ = True
            # self.draw_event_connection_id = self.canvas.mpl_connect('draw_event', self.on_draw)

    def disable(self):
        """Disables BlitManager."""
        if self._enabled_:
            self._enabled_ = False
            # self.canvas.mpl_disconnect(self.draw_event_connection_id)
            self.draw_event_connection_id = None

    def enabled(self):
        """Enables Blit Manager and returns itself."""
        self.enable()
        return self     

    def disabled(self):
        """Disables BlitManager, redraws without DragObjects and returns itself."""
        self.disable()
        self.draw(artists_visible=False)
        return self

    @property
    def bind_motion(self):
        return self._bind_motion_

    @bind_motion.setter
    def bind_motion(self, new_id: int):
        # if (new_id is None) or (self._bind_motion_ is not None):
        if self._bind_motion_ == -1:
            self._bind_motion_ = new_id
        elif new_id is None:
            self._bind_motion_ = -1



    def __enter__(self, *_):
        pass

    def __exit__(self, *_):
        if not self._enabled_:
            self.enable()
        else:
            self.disable()

__init__(app)

Class for managing blitting. DragObjects must be appended to self.artists. BlitManager must be manualy enabled and disabled. with statements can be used to enable or disable blitting temporaly.

Parameters:

Name Type Description Default
app Fitter

Aplication using BlitManager.

 required
Source code in itfit/utils/blit_manager.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(self, app):
    """Class for managing blitting. DragObjects must be appended to `self.artists`.
    BlitManager must be manualy enabled and disabled.
    `with` statements can be used to enable or disable blitting temporaly.

    Parameters:
        app (Fitter):
            Aplication using BlitManager.
    """

    self.app = app
    self.ax = app.ax
    self.canvas = app.figure.canvas

    self.artists = []

    self._bind_motion_ : int = -1
    self._enabled_ = False
    self.background = None
    self.draw_event_connection_id = None

disable()

Disables BlitManager.

Source code in itfit/utils/blit_manager.py 
82
83
84
85
86
87
def disable(self):
    """Disables BlitManager."""
    if self._enabled_:
        self._enabled_ = False
        # self.canvas.mpl_disconnect(self.draw_event_connection_id)
        self.draw_event_connection_id = None

disabled()

Disables BlitManager, redraws without DragObjects and returns itself.

Source code in itfit/utils/blit_manager.py 
94
95
96
97
98
def disabled(self):
    """Disables BlitManager, redraws without DragObjects and returns itself."""
    self.disable()
    self.draw(artists_visible=False)
    return self

draw(artists_visible=True)

Draws the canvas using blitting.

Source code in itfit/utils/blit_manager.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def draw(self, artists_visible=True):
    """Draws the canvas using blitting."""
    if self.background is None:
        self.update_background()
    self.canvas.restore_region(self.background)

    for a in self.artists:
        try: # if custom object
            a.update()
            a.poly.set_visible(artists_visible)
            self.ax.draw_artist(a.poly)
        except AttributeError: # if matplotlib artists
            a.set_visible(artists_visible)
            self.ax.draw_artis(a)

    self.canvas.blit(self.ax.bbox)

enable()

Enables BlitManager.

Source code in itfit/utils/blit_manager.py 
75
76
77
78
79
def enable(self):
    """Enables BlitManager."""
    if not self._enabled_:
        self.update_background()
        self._enabled_ = True

enabled()

Enables Blit Manager and returns itself.

Source code in itfit/utils/blit_manager.py 
89
90
91
92
def enabled(self):
    """Enables Blit Manager and returns itself."""
    self.enable()
    return self

get_background()

"Gets current background and saves it, used in blitting process.

Source code in itfit/utils/blit_manager.py 
38
39
40
41
42
43
44
45
46
47
48
def get_background(self):
    """"Gets current background and saves it, used in blitting process."""
    for a in self.artists:
        a.poly.set_visible(False)

    for a in self.ax.artists:
        self.ax.draw_artists(a)

    self.canvas.blit()

    return self.canvas.copy_from_bbox(self.ax.bbox)

on_draw(event)

Trigger for draw event.

Source code in itfit/utils/blit_manager.py 
71
72
73
def on_draw(self, event):
    """Trigger for draw event."""
    self.draw()

update_background()

Updates saved background, used in blitting process.

Source code in itfit/utils/blit_manager.py 
50
51
52
def update_background(self):
    """Updates saved background, used in blitting process."""
    self.background = self.get_background()