1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import wx

    26

    27

from graphics.GraphicCommons import GetScaledEventPosition

    28

    29

    30

# -------------------------------------------------------------------------------

    31

#                               Viewer RubberBand

    32

# -------------------------------------------------------------------------------

    33

    34

    35

class RubberBand:

    36

    """

    37

    Class that implements a rubberband for graphic Viewers

    38

    """

    39

    40

    def __init__(self, viewer):

    41

        """

    42

        Constructor

    43

        @param viewer: Viewer on which rubberband must be drawn

    44

        """

    45

        self.Viewer = viewer

    46

    47

        # wx.Panel on which rubberband will be drawn

    48

        self.DrawingSurface = viewer.Editor

    49

    50

        self.Reset()

    51

    52

    def Reset(self):

    53

        """

    54

        Initialize internal attributes of rubberband

    55

        """

    56

        self.StartPoint = None

    57

        self.CurrentBBox = None

    58

        self.LastBBox = None

    59

    60

    def IsShown(self):

    61

        """

    62

        Indicate if rubberband is drawn on viewer

    63

        @return: True if rubberband is drawn

    64

        """

    65

        return self.CurrentBBox is not None

    66

    67

    def GetCurrentExtent(self):

    68

        """

    69

        Return the rubberband bounding box

    70

        @return: Rubberband bounding box (wx.Rect object)

    71

        """

    72

        # In case of rubberband not shown, return the last rubberband

    73

        # bounding box

    74

        if self.IsShown():

    75

            return self.CurrentBBox

    76

        return self.LastBBox

    77

    78

    def OnLeftDown(self, event, dc, scaling):

    79

        """

    80

        Called when left mouse is pressed on Viewer. Starts to edit a new

    81

        rubberband bounding box

    82

        @param event: Mouse event

    83

        @param dc: Device Context of Viewer

    84

        @param scaling: PLCOpen scaling applied on Viewer

    85

        """

    86

        # Save the point where mouse was pressed in Viewer unit, position may

    87

        # be modified by scroll and zoom applied on viewer

    88

        self.StartPoint = GetScaledEventPosition(event, dc, scaling)

    89

    90

        # Initialize rubberband bounding box

    91

        self.CurrentBBox = wx.Rect(self.StartPoint.x, self.StartPoint.y, 0, 0)

    92

    93

        # Change viewer mouse cursor to reflect a rubberband bounding box is

    94

        # edited

    95

        self.DrawingSurface.SetCursor(wx.StockCursor(wx.CURSOR_CROSS))

    96

    97

        self.Redraw()

    98

    99

    def OnMotion(self, event, dc, scaling):

   100

        """

   101

        Called when mouse is dragging over Viewer. Update the current edited

   102

        rubberband bounding box

   103

        @param event: Mouse event

   104

        @param dc: Device Context of Viewer

   105

        @param scaling: PLCOpen scaling applied on Viewer

   106

        """

   107

        # Get mouse position in Viewer unit, position may be modified by scroll

   108

        # and zoom applied on viewer

   109

        pos = GetScaledEventPosition(event, dc, scaling)

   110

   111

        # Save the last bounding box drawn for erasing it later

   112

        self.LastBBox = wx.Rect(0, 0, 0, 0)

   113

        self.LastBBox.Union(self.CurrentBBox)

   114

   115

        # Calculate new position and size of the box

   116

        self.CurrentBBox.x = min(pos.x, self.StartPoint.x)

   117

        self.CurrentBBox.y = min(pos.y, self.StartPoint.y)

   118

        self.CurrentBBox.width = abs(pos.x - self.StartPoint.x) + 1

   119

        self.CurrentBBox.height = abs(pos.y - self.StartPoint.y) + 1

   120

   121

        self.Redraw()

   122

   123

    def OnLeftUp(self, event, dc, scaling):

   124

        """

   125

        Called when mouse is release from Viewer. Erase the current edited

   126

        rubberband bounding box

   127

        @param event: Mouse event

   128

        @param dc: Device Context of Viewer

   129

        @param scaling: PLCOpen scaling applied on Viewer

   130

        """

   131

        # Change viewer mouse cursor to default

   132

        self.DrawingSurface.SetCursor(wx.NullCursor)

   133

   134

        # Save the last edited bounding box

   135

        self.LastBBox = self.CurrentBBox

   136

        self.CurrentBBox = None

   137

   138

        self.Redraw()

   139

   140

    def DrawBoundingBoxes(self, bboxes, dc=None):

   141

        """

   142

        Draw a list of bounding box on Viewer in the order given using XOR

   143

        logical function

   144

        @param bboxes: List of bounding boxes to draw on viewer

   145

        @param dc: Device Context of Viewer (default None)

   146

        """

   147

        # Get viewer Device Context if not given

   148

        if dc is None:

   149

            dc = self.Viewer.GetLogicalDC()

   150

   151

        # Save current viewer scale factors before resetting them in order to

   152

        # avoid rubberband pen to be scaled

   153

        scalex, scaley = dc.GetUserScale()

   154

        dc.SetUserScale(1, 1)

   155

   156

        # Set DC drawing style

   157

        dc.SetPen(wx.Pen(wx.WHITE, style=wx.DOT))

   158

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   159

        dc.SetLogicalFunction(wx.XOR)

   160

   161

        # Draw the bounding boxes using viewer scale factor

   162

        for bbox in bboxes:

   163

            if bbox is not None:

   164

                dc.DrawRectangle(

   165

                    bbox.x * scalex, bbox.y * scaley,

   166

                    bbox.width * scalex, bbox.height * scaley)

   167

   168

        dc.SetLogicalFunction(wx.COPY)

   169

   170

        # Restore Viewer scale factor

   171

        dc.SetUserScale(scalex, scaley)

   172

   173

    def Redraw(self, dc=None):

   174

        """

   175

        Redraw rubberband on Viewer

   176

        @param dc: Device Context of Viewer (default None)

   177

        """

   178

        # Erase last bbox and draw current bbox

   179

        self.DrawBoundingBoxes([self.LastBBox, self.CurrentBBox], dc)

   180

   181

    def Erase(self, dc=None):

   182

        """

   183

        Erase rubberband from Viewer

   184

        @param dc: Device Context of Viewer (default None)

   185

        """

   186

        # Erase last bbox

   187

        self.DrawBoundingBoxes([self.LastBBox], dc)

   188

   189

    def Draw(self, dc=None):

   190

        """

   191

        Draw rubberband on Viewer

   192

        @param dc: Device Context of Viewer (default None)

   193

        """

   194

        # Erase last bbox and draw current bbox

   195

        self.DrawBoundingBoxes([self.CurrentBBox], dc)