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

    26

from __future__ import absolute_import

    27

import wx

    28

    29

from graphics.GraphicCommons import GetScaledEventPosition

    30

    31

    32

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

    33

#                               Viewer RubberBand

    34

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

    35

    36

    37

class RubberBand(object):

    38

    """

    39

    Class that implements a rubberband for graphic Viewers

    40

    """

    41

    42

    def __init__(self, viewer):

    43

        """

    44

        Constructor

    45

        @param viewer: Viewer on which rubberband must be drawn

    46

        """

    47

        self.Viewer = viewer

    48

    49

        # wx.Panel on which rubberband will be drawn

    50

        self.DrawingSurface = viewer.Editor

    51

    52

        self.Reset()

    53

    54

    def Reset(self):

    55

        """

    56

        Initialize internal attributes of rubberband

    57

        """

    58

        self.StartPoint = None

    59

        self.CurrentBBox = None

    60

        self.LastBBox = None

    61

    62

    def IsShown(self):

    63

        """

    64

        Indicate if rubberband is drawn on viewer

    65

        @return: True if rubberband is drawn

    66

        """

    67

        return self.CurrentBBox is not None

    68

    69

    def GetCurrentExtent(self):

    70

        """

    71

        Return the rubberband bounding box

    72

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

    73

        """

    74

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

    75

        # bounding box

    76

        if self.IsShown():

    77

            return self.CurrentBBox

    78

        return self.LastBBox

    79

    80

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

    81

        """

    82

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

    83

        rubberband bounding box

    84

        @param event: Mouse event

    85

        @param dc: Device Context of Viewer

    86

        @param scaling: PLCOpen scaling applied on Viewer

    87

        """

    88

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

    89

        # be modified by scroll and zoom applied on viewer

    90

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

    91

    92

        # Initialize rubberband bounding box

    93

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

    94

    95

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

    96

        # edited

    97

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

    98

    99

        self.Redraw()

   100

   101

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

   102

        """

   103

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

   104

        rubberband bounding box

   105

        @param event: Mouse event

   106

        @param dc: Device Context of Viewer

   107

        @param scaling: PLCOpen scaling applied on Viewer

   108

        """

   109

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

   110

        # and zoom applied on viewer

   111

        pos = GetScaledEventPosition(event, dc, scaling)

   112

   113

        # Save the last bounding box drawn for erasing it later

   114

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

   115

        self.LastBBox.Union(self.CurrentBBox)

   116

   117

        # Calculate new position and size of the box

   118

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

   119

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

   120

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

   121

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

   122

   123

        self.Redraw()

   124

   125

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

   126

        """

   127

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

   128

        rubberband bounding box

   129

        @param event: Mouse event

   130

        @param dc: Device Context of Viewer

   131

        @param scaling: PLCOpen scaling applied on Viewer

   132

        """

   133

        # Change viewer mouse cursor to default

   134

        self.DrawingSurface.SetCursor(wx.NullCursor)

   135

   136

        # Save the last edited bounding box

   137

        self.LastBBox = self.CurrentBBox

   138

        self.CurrentBBox = None

   139

   140

        self.Redraw()

   141

   142

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

   143

        """

   144

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

   145

        logical function

   146

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

   147

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

   148

        """

   149

        # Get viewer Device Context if not given

   150

        if dc is None:

   151

            dc = self.Viewer.GetLogicalDC()

   152

   153

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

   154

        # avoid rubberband pen to be scaled

   155

        scalex, scaley = dc.GetUserScale()

   156

        dc.SetUserScale(1, 1)

   157

   158

        # Set DC drawing style

   159

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

   160

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   161

        dc.SetLogicalFunction(wx.XOR)

   162

   163

        # Draw the bounding boxes using viewer scale factor

   164

        for bbox in bboxes:

   165

            if bbox is not None:

   166

                dc.DrawRectangle(

   167

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

   168

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

   169

   170

        dc.SetLogicalFunction(wx.COPY)

   171

   172

        # Restore Viewer scale factor

   173

        dc.SetUserScale(scalex, scaley)

   174

   175

    def Redraw(self, dc=None):

   176

        """

   177

        Redraw rubberband on Viewer

   178

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

   179

        """

   180

        # Erase last bbox and draw current bbox

   181

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

   182

   183

    def Erase(self, dc=None):

   184

        """

   185

        Erase rubberband from Viewer

   186

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

   187

        """

   188

        # Erase last bbox

   189

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

   190

   191

    def Draw(self, dc=None):

   192

        """

   193

        Draw rubberband on Viewer

   194

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

   195

        """

   196

        # Erase last bbox and draw current bbox

   197

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