1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import numpy

    26

import math

    27

    28

import wx

    29

import wx.lib.plot as plot

    30

import wx.lib.buttons

    31

    32

from graphics.GraphicCommons import DebugViewer, MODE_SELECTION, MODE_MOTION

    33

from controls import EditorPanel

    34

from utils.BitmapLibrary import GetBitmap

    35

    36

colours = ['blue', 'red', 'green', 'yellow', 'orange', 'purple', 'brown', 'cyan',

    37

           'pink', 'grey']

    38

markers = ['circle', 'dot', 'square', 'triangle', 'triangle_down', 'cross', 'plus', 'circle']

    39

    40

    41

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

    42

#                       Debug Variable Graphic Viewer class

    43

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

    44

    45

SECOND = 1000000000

    46

MINUTE = 60 * SECOND

    47

HOUR = 60 * MINUTE

    48

    49

ZOOM_VALUES = map(lambda x:("x %.1f" % x, x), [math.sqrt(2) ** i for i in xrange(8)])

    50

RANGE_VALUES = map(lambda x: (str(x), x), [25 * 2 ** i for i in xrange(6)])

    51

TIME_RANGE_VALUES = [("%ds" % i, i * SECOND) for i in (1, 2, 5, 10, 20, 30)] + \

    52

                    [("%dm" % i, i * MINUTE) for i in (1, 2, 5, 10, 20, 30)] + \

    53

                    [("%dh" % i, i * HOUR) for i in (1, 2, 3, 6, 12, 24)]

    54

    55

class GraphicViewer(EditorPanel, DebugViewer):

    56

    57

    def _init_Editor(self, prnt):

    58

        self.Editor = wx.Panel(prnt)

    59

    60

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

    61

        main_sizer.AddGrowableCol(0)

    62

        main_sizer.AddGrowableRow(0)

    63

    64

        self.Canvas = plot.PlotCanvas(self.Editor, name='Canvas')

    65

        def _axisInterval(spec, lower, upper):

    66

            if spec == 'border':

    67

                if lower == upper:

    68

                    return lower - 0.5, upper + 0.5

    69

                else:

    70

                    border = (upper - lower) * 0.05

    71

                    return lower - border, upper + border

    72

            else:

    73

                return plot.PlotCanvas._axisInterval(self.Canvas, spec, lower, upper)

    74

        self.Canvas._axisInterval = _axisInterval

    75

        self.Canvas.SetYSpec('border')

    76

        self.Canvas.canvas.Bind(wx.EVT_LEFT_DOWN, self.OnCanvasLeftDown)

    77

        self.Canvas.canvas.Bind(wx.EVT_LEFT_UP, self.OnCanvasLeftUp)

    80

        self.Canvas.canvas.Bind(wx.EVT_MOTION, self.OnCanvasMotion)

    81

        self.Canvas.canvas.Bind(wx.EVT_MOUSEWHEEL, self.OnCanvasMouseWheel)

    82

        self.Canvas.canvas.Bind(wx.EVT_SIZE, self.OnCanvasResize)

    83

        main_sizer.AddWindow(self.Canvas, 0, border=0, flag=wx.GROW)

    84

    86

        range_sizer.AddGrowableCol(5)

    87

        range_sizer.AddGrowableRow(0)

    88

        main_sizer.AddSizer(range_sizer, 0, border=5, flag=wx.GROW|wx.ALL)

    89

    90

        range_label = wx.StaticText(self.Editor, label=_('Range:'))

    91

        range_sizer.AddWindow(range_label, 0, border=0, flag=wx.ALIGN_CENTER_VERTICAL)

    92

    93

        self.CanvasRange = wx.ComboBox(self.Editor, 

    94

              size=wx.Size(100, 28), style=wx.CB_READONLY)

    95

        self.Bind(wx.EVT_COMBOBOX, self.OnRangeChanged, self.CanvasRange)

    96

        range_sizer.AddWindow(self.CanvasRange, 0, border=0, flag=wx.ALIGN_CENTER_VERTICAL)

    97

    98

        zoom_label = wx.StaticText(self.Editor, label=_('Zoom:'))

    99

        range_sizer.AddWindow(zoom_label, 0, border=0, flag=wx.ALIGN_CENTER_VERTICAL)

   100

   101

        self.CanvasZoom = wx.ComboBox(self.Editor, 

   102

              size=wx.Size(70, 28), style=wx.CB_READONLY)

   103

        self.Bind(wx.EVT_COMBOBOX, self.OnZoomChanged, self.CanvasZoom)

   104

        range_sizer.AddWindow(self.CanvasZoom, 0, border=0, flag=wx.ALIGN_CENTER_VERTICAL)

   105

   106

        position_label = wx.StaticText(self.Editor, label=_('Position:'))

   107

        range_sizer.AddWindow(position_label, 0, border=0, flag=wx.ALIGN_CENTER_VERTICAL)

   108

   109

        self.CanvasPosition = wx.ScrollBar(self.Editor, 

   110

              size=wx.Size(0, 16), style=wx.SB_HORIZONTAL)

   111

        self.CanvasPosition.SetScrollbar(0, 10, 100, 10)

   112

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK, 

   113

              self.OnPositionChanging, self.CanvasPosition)

   114

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP, 

   115

              self.OnPositionChanging, self.CanvasPosition)

   116

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN, 

   117

              self.OnPositionChanging, self.CanvasPosition)

   118

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP, 

   119

              self.OnPositionChanging, self.CanvasPosition)

   120

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN, 

   121

              self.OnPositionChanging, self.CanvasPosition)

   122

        range_sizer.AddWindow(self.CanvasPosition, 0, border=5, flag=wx.GROW|wx.ALL)

   123

   124

        self.ResetButton = wx.lib.buttons.GenBitmapButton(self.Editor, 

   125

              bitmap=GetBitmap("reset"), size=wx.Size(28, 28), style=wx.NO_BORDER)

   126

        self.ResetButton.SetToolTipString(_("Clear the graph values"))

   127

        self.Bind(wx.EVT_BUTTON, self.OnResetButton, self.ResetButton)

   128

        range_sizer.AddWindow(self.ResetButton, 0, border=0, flag=0)

   129

   130

        self.CurrentButton = wx.lib.buttons.GenBitmapButton(self.Editor, 

   131

              bitmap=GetBitmap("current"), size=wx.Size(28, 28), style=wx.NO_BORDER)

   132

        self.CurrentButton.SetToolTipString(_("Go to current value"))

   133

        self.Bind(wx.EVT_BUTTON, self.OnCurrentButton, self.CurrentButton)

   134

        range_sizer.AddWindow(self.CurrentButton, 0, border=0, flag=0)

   135

   143

        self.ExportGraphButton = wx.lib.buttons.GenBitmapButton(self.Editor, 

   144

              bitmap=GetBitmap("export_graph"), size=wx.Size(28, 28), style=wx.NO_BORDER)

   145

        self.ExportGraphButton.SetToolTipString(_("Export graph values to clipboard"))

   146

        self.Bind(wx.EVT_BUTTON, self.OnExportGraphButtonClick, 

   147

                self.ExportGraphButton)

   148

        range_sizer.AddWindow(self.ExportGraphButton, 0, border=0, flag=0)

   149

   150

        self.Editor.SetSizer(main_sizer)

   151

   152

    def __init__(self, parent, window, producer, instancepath = ""):

   153

        EditorPanel.__init__(self, parent, "", window, None)

   154

        DebugViewer.__init__(self, producer, True, False)

   155

   156

        self.InstancePath = instancepath

   157

        self.RangeValues = None

   158

        self.CursorIdx = None

   159

        self.LastCursor = None

   160

        self.CurrentMousePos = None

   161

        self.CurrentMotionValue = None

   162

        self.Dragging = False

   163

   164

        # Initialize Viewer mode to Selection mode

   165

        self.Mode = MODE_SELECTION

   166

   167

        self.Datas = []

   168

        self.StartTick = 0

   169

        self.StartIdx = 0

   170

        self.EndIdx = 0

   171

        self.MinValue = None

   172

        self.MaxValue = None

   173

        self.YCenter = 0

   175

        self.Fixed = False

   176

        self.Ticktime = self.DataProducer.GetTicktime()

   177

        self.RefreshCanvasRange()

   178

   179

        for zoom_txt, zoom in ZOOM_VALUES:

   180

            self.CanvasZoom.Append(zoom_txt)

   181

        self.CanvasZoom.SetSelection(0)

   182

   183

        self.AddDataConsumer(self.InstancePath.upper(), self)

   184

   185

    def __del__(self):

   186

        DebugViewer.__del__(self)

   187

        self.RemoveDataConsumer(self)

   188

   189

    def GetTitle(self):

   190

        if len(self.InstancePath) > 15:

   191

            return "..." + self.InstancePath[-12:]

   192

        return self.InstancePath

   193

   194

    # Changes Viewer mode

   195

    def SetMode(self, mode):

   196

        if self.Mode != mode or mode == MODE_SELECTION:    

   197

            if self.Mode == MODE_MOTION:

   198

                wx.CallAfter(self.Canvas.canvas.SetCursor, wx.NullCursor)

   199

            self.Mode = mode

   200

        if self.Mode == MODE_MOTION:

   201

            wx.CallAfter(self.Canvas.canvas.SetCursor, wx.StockCursor(wx.CURSOR_HAND))

   202

   203

    def ResetView(self, register=False):

   204

        self.Datas = []

   205

        self.StartTick = 0

   206

        self.StartIdx = 0

   207

        self.EndIdx = 0

   208

        self.MinValue = None

   209

        self.MaxValue = None

   210

        self.CursorIdx = None

   211

        self.Fixed = False

   212

        self.Ticktime = self.DataProducer.GetTicktime()

   213

        if register:

   214

            self.AddDataConsumer(self.InstancePath.upper(), self)

   215

        self.ResetLastCursor()

   216

        self.RefreshCanvasRange()

   217

        self.RefreshView()

   218

   219

    def RefreshNewData(self, *args, **kwargs):

   220

        self.RefreshView(*args, **kwargs)

   221

        DebugViewer.RefreshNewData(self)

   222

   223

    def GetNearestData(self, tick, adjust):

   224

        ticks = numpy.array(zip(*self.Datas)[0])

   225

        new_cursor = numpy.argmin(abs(ticks - tick))

   226

        if adjust == -1 and ticks[new_cursor] > tick and new_cursor > 0:

   227

            new_cursor -= 1

   228

        elif adjust == 1 and ticks[new_cursor] < tick and new_cursor < len(self.Datas):

   229

            new_cursor += 1

   230

        return new_cursor

   231

   232

    def GetBounds(self):

   233

        if self.StartIdx is None or self.EndIdx is None:

   234

            self.StartIdx = self.GetNearestData(self.StartTick, -1)

   235

            self.EndIdx = self.GetNearestData(self.StartTick + self.CurrentRange, 1)

   236

   237

    def ResetBounds(self):

   238

        self.StartIdx = None

   239

        self.EndIdx = None

   240

   241

    def RefreshCanvasRange(self):

   242

        if self.Ticktime == 0 and self.RangeValues != RANGE_VALUES:

   243

            self.RangeValues = RANGE_VALUES

   244

            self.CanvasRange.Clear()

   245

            for text, value in RANGE_VALUES:

   246

                self.CanvasRange.Append(text)

   247

            self.CanvasRange.SetStringSelection(RANGE_VALUES[0][0])

   248

            self.CurrentRange = RANGE_VALUES[0][1]

   249

        elif self.RangeValues != TIME_RANGE_VALUES:

   250

            self.RangeValues = TIME_RANGE_VALUES

   251

            self.CanvasRange.Clear()

   252

            for text, value in TIME_RANGE_VALUES:

   253

                self.CanvasRange.Append(text)

   254

            self.CanvasRange.SetStringSelection(TIME_RANGE_VALUES[0][0])

   255

            self.CurrentRange = TIME_RANGE_VALUES[0][1] / self.Ticktime

   256

   257

    def RefreshView(self, force=False):

   258

        self.Freeze()

   259

        if force or not self.Fixed or (len(self.Datas) > 0 and self.StartTick + self.CurrentRange > self.Datas[-1][0]):

   260

            if (self.MinValue is not None and 

   261

                self.MaxValue is not None and 

   262

                self.MinValue != self.MaxValue):

   263

                Yrange = float(self.MaxValue - self.MinValue) / self.CurrentZoom

   264

            else:

   265

                Yrange = 2. / self.CurrentZoom

   266

   267

            if not force and not self.Fixed and len(self.Datas) > 0:

   268

                self.YCenter = max(self.Datas[-1][1] - Yrange / 2, 

   269

                               min(self.YCenter, 

   270

                                   self.Datas[-1][1] + Yrange / 2))

   271

   272

            var_name = self.InstancePath.split(".")[-1]

   273

   274

            self.GetBounds()

   275

            self.VariableGraphic = plot.PolyLine(self.Datas[self.StartIdx:self.EndIdx + 1], 

   276

                                                 legend=var_name, colour=colours[0])

   277

            self.GraphicsObject = plot.PlotGraphics([self.VariableGraphic], _("%s Graphics") % var_name, _("Tick"), _("Values"))

   278

            self.Canvas.Draw(self.GraphicsObject, 

   279

                             xAxis=(self.StartTick, self.StartTick + self.CurrentRange),

   280

                             yAxis=(self.YCenter - Yrange * 1.1 / 2., self.YCenter + Yrange * 1.1 / 2.))

   281

   282

            # Reset and draw cursor 

   283

            self.ResetLastCursor()

   284

            self.RefreshCursor()

   285

   286

        self.RefreshScrollBar()

   287

   288

        self.Thaw()

   289

   290

    def GetInstancePath(self):

   291

        return self.InstancePath

   292

   293

    def IsViewing(self, tagname):

   294

        return self.InstancePath == tagname

   295

   296

    def NewValue(self, tick, value, forced=False):

   299

        if self.MinValue is None:

   300

            self.MinValue = value

   301

        else:

   302

            self.MinValue = min(self.MinValue, value)

   303

        if self.MaxValue is None:

   304

            self.MaxValue = value

   305

        else:

   306

            self.MaxValue = max(self.MaxValue, value)

   307

        if not self.Fixed or tick < self.StartTick + self.CurrentRange:

   308

            self.GetBounds()

   309

            while int(self.Datas[self.StartIdx][0]) < tick - self.CurrentRange:

   310

                self.StartIdx += 1

   311

            self.EndIdx += 1

   312

            self.StartTick = self.Datas[self.StartIdx][0]

   313

        self.NewDataAvailable()

   314

   315

    def RefreshScrollBar(self):

   316

        if len(self.Datas) > 0:

   317

            self.GetBounds()

   318

            pos = int(self.Datas[self.StartIdx][0] - self.Datas[0][0])

   319

            range = int(self.Datas[-1][0] - self.Datas[0][0])

   320

        else:

   321

            pos = 0

   322

            range = 0

   323

        self.CanvasPosition.SetScrollbar(pos, self.CurrentRange, range, self.CurrentRange)

   324

   325

    def RefreshRange(self):

   326

        if len(self.Datas) > 0:

   327

            if self.Fixed and self.Datas[-1][0] - self.Datas[0][0] < self.CurrentRange:

   328

                self.Fixed = False

   329

            self.ResetBounds()

   330

            if self.Fixed:

   331

                self.StartTick = min(self.StartTick, self.Datas[-1][0] - self.CurrentRange)

   332

            else:

   333

                self.StartTick = max(self.Datas[0][0], self.Datas[-1][0] - self.CurrentRange)

   334

        self.RefreshView(True)

   335

   336

    def OnRangeChanged(self, event):

   337

        try:

   338

            if self.Ticktime == 0:

   339

                self.CurrentRange = self.RangeValues[self.CanvasRange.GetSelection()][1]

   340

            else:

   341

                self.CurrentRange = self.RangeValues[self.CanvasRange.GetSelection()][1] / self.Ticktime

   342

        except ValueError, e:

   343

            self.CanvasRange.SetValue(str(self.CurrentRange))

   344

        wx.CallAfter(self.RefreshRange)

   345

        event.Skip()

   346

   347

    def OnZoomChanged(self, event):

   348

        self.CurrentZoom = ZOOM_VALUES[self.CanvasZoom.GetSelection()][1]

   349

        wx.CallAfter(self.RefreshView, True)

   350

        event.Skip()

   351

   352

    def OnPositionChanging(self, event):

   358

        event.Skip()

   359

   360

    def OnResetButton(self, event):

   361

        self.Fixed = False

   362

        self.ResetView()

   363

        event.Skip()

   364

   365

    def OnCurrentButton(self, event):

   381

        event.Skip()

   382

   383

    def OnExportGraphButtonClick(self, event):

   384

        data_copy = self.Datas[:]

   385

        text = "tick;%s;\n" % self.InstancePath

   386

        for tick, value in data_copy:

   387

            text += "%d;%.3f;\n" % (tick, value)

   388

        self.ParentWindow.SetCopyBuffer(text)

   389

        event.Skip()

   390

   391

    def OnCanvasLeftDown(self, event):

   392

        self.Fixed = True

   393

        self.Canvas.canvas.CaptureMouse()

   394

        if len(self.Datas) > 0:

   395

            if self.Mode == MODE_SELECTION:

   396

                self.Dragging = True

   397

                pos = self.Canvas.PositionScreenToUser(event.GetPosition())

   398

                self.CursorIdx = self.GetNearestData(pos[0], -1)

   399

                self.RefreshCursor()

   400

            elif self.Mode == MODE_MOTION:

   401

                self.GetBounds()

   402

                self.CurrentMousePos = event.GetPosition()

   403

                self.CurrentMotionValue = self.Datas[self.StartIdx][0]

   404

        event.Skip()

   406

    def OnCanvasLeftUp(self, event):

   407

        self.Dragging = False

   408

        if self.Mode == MODE_MOTION:

   409

            self.CurrentMousePos = None

   410

            self.CurrentMotionValue = None

   411

        if self.Canvas.canvas.HasCapture():

   412

            self.Canvas.canvas.ReleaseMouse()

   413

        event.Skip()

   430

   431

    def OnCanvasMotion(self, event):

   432

        if self.Mode == MODE_SELECTION and self.Dragging:

   433

            pos = self.Canvas.PositionScreenToUser(event.GetPosition())

   434

            graphics, xAxis, yAxis = self.Canvas.last_draw

   435

            self.CursorIdx = self.GetNearestData(max(xAxis[0], min(pos[0], xAxis[1])), -1)

   436

            self.RefreshCursor()

   437

        elif self.CurrentMousePos is not None and len(self.Datas) > 0:

   438

            oldpos = self.Canvas.PositionScreenToUser(self.CurrentMousePos)

   439

            newpos = self.Canvas.PositionScreenToUser(event.GetPosition())

   440

            self.CurrentMotionValue += oldpos[0] - newpos[0]

   441

            self.YCenter += oldpos[1] - newpos[1]

   442

            self.ResetBounds()

   443

            self.StartTick = max(self.Datas[0][0], min(self.CurrentMotionValue, self.Datas[-1][0] - self.CurrentRange))

   444

            self.CurrentMousePos = event.GetPosition()

   445

            self.NewDataAvailable(True)

   446

        event.Skip()

   447

   448

    def OnCanvasMouseWheel(self, event):

   449

        if self.CurrentMousePos is None:

   450

            rotation = event.GetWheelRotation() / event.GetWheelDelta()

   451

            if event.ShiftDown():

   452

                current = self.CanvasRange.GetSelection()

   453

                new = max(0, min(current - rotation, len(self.RangeValues) - 1))

   454

                if new != current:

   455

                    if self.Ticktime == 0:

   456

                        self.CurrentRange = self.RangeValues[new][1]

   457

                    else:

   458

                        self.CurrentRange = self.RangeValues[new][1] / self.Ticktime

   459

                    self.CanvasRange.SetStringSelection(self.RangeValues[new][0])

   460

                    wx.CallAfter(self.RefreshRange)

   461

            else:

   462

                current = self.CanvasZoom.GetSelection()

   463

                new = max(0, min(current + rotation, len(ZOOM_VALUES) - 1))

   464

                if new != current:

   465

                    self.CurrentZoom = ZOOM_VALUES[new][1]

   466

                    self.CanvasZoom.SetStringSelection(ZOOM_VALUES[new][0])

   467

                    wx.CallAfter(self.RefreshView, True)

   468

        event.Skip()

   469

   470

    def OnCanvasResize(self, event):

   471

        self.ResetLastCursor()

   472

        wx.CallAfter(self.RefreshCursor)

   473

        event.Skip()

   474

   475

    ## Reset the last cursor

   476

    def ResetLastCursor(self):

   477

        self.LastCursor = None

   478

   479

    ## Draw the cursor on graphic

   480

    #  @param dc The draw canvas

   481

    #  @param cursor The cursor parameters

   482

    def DrawCursor(self, dc, cursor, value):

   483

        if self.StartTick <= cursor <= self.StartTick + self.CurrentRange:

   484

            # Prepare temporary dc for drawing

   485

            width = self.Canvas._Buffer.GetWidth()

   486

            height = self.Canvas._Buffer.GetHeight()

   487

            tmp_Buffer = wx.EmptyBitmap(width, height)

   488

            dcs = wx.MemoryDC()

   489

            dcs.SelectObject(tmp_Buffer)

   490

            dcs.Clear()

   491

            dcs.BeginDrawing()

   492