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

    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)

    78

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

    79

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

    80

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

    81

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

    82

    83

        range_sizer = wx.FlexGridSizer(cols=9, hgap=5, rows=1, vgap=0)

    84

        range_sizer.AddGrowableCol(5)

    85

        range_sizer.AddGrowableRow(0)

    86

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

    87

    88

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

    89

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

    90

    91

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

    92

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

    93

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

    95

    96

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

    97

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

    98

    99

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

   100

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

   101

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

   103

   104

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

   105

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

   106

   107

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

   108

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

   109

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

   110

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK, 

   111

              self.OnPositionChanging, self.CanvasPosition)

   112

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP, 

   113

              self.OnPositionChanging, self.CanvasPosition)

   114

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN, 

   115

              self.OnPositionChanging, self.CanvasPosition)

   116

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP, 

   117

              self.OnPositionChanging, self.CanvasPosition)

   118

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN, 

   119

              self.OnPositionChanging, self.CanvasPosition)

   120

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

   121

   125

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

   126

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

   127

   131

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

   132

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

   133

   134

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

   137

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

   138

                self.ExportGraphButton)

   139

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

   140

   141

        self.Editor.SetSizer(main_sizer)

   142

   143

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

   144

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

   145

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

   146

   147

        self.InstancePath = instancepath

   148

        self.RangeValues = None

   149

        self.CursorIdx = None

   150

        self.LastCursor = None

   151

        self.CurrentMousePos = None

   152

        self.CurrentMotionValue = None

   153

        self.Dragging = False

   154

   155

        # Initialize Viewer mode to Selection mode

   156

        self.Mode = MODE_SELECTION

   157

   158

        self.Datas = []

   159

        self.StartTick = 0

   160

        self.StartIdx = 0

   161

        self.EndIdx = 0

   162

        self.MinValue = None

   163

        self.MaxValue = None

   164

        self.YCenter = 0

   165

        self.CurrentZoom = 1

   166

        self.Fixed = False

   167

        self.Ticktime = self.DataProducer.GetTicktime()

   168

        self.RefreshCanvasRange()

   169

   170

        for zoom_txt, zoom in ZOOM_VALUES:

   171

            self.CanvasZoom.Append(zoom_txt)

   172

        self.CanvasZoom.SetSelection(0)

   173

   174

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

   175

   176

    def __del__(self):

   177

        DebugViewer.__del__(self)

   178

        self.RemoveDataConsumer(self)

   179

   180

    def GetTitle(self):

   181

        if len(self.InstancePath) > 15:

   182

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

   183

        return self.InstancePath

   184

   185

    # Changes Viewer mode

   186

    def SetMode(self, mode):

   187

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

   188

            if self.Mode == MODE_MOTION:

   189

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

   190

            self.Mode = mode

   191

        if self.Mode == MODE_MOTION:

   192

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

   193

   194

    def ResetView(self, register=False):

   195

        self.Datas = []

   196

        self.StartTick = 0

   197

        self.StartIdx = 0

   198

        self.EndIdx = 0

   199

        self.MinValue = None

   200

        self.MaxValue = None

   201

        self.CursorIdx = None

   202

        self.Fixed = False

   203

        self.Ticktime = self.DataProducer.GetTicktime()

   204

        if register:

   205

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

   206

        self.ResetLastCursor()

   207

        self.RefreshCanvasRange()

   208

        self.RefreshView()

   209

   210

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

   211

        self.RefreshView(*args, **kwargs)

   212

        DebugViewer.RefreshNewData(self)

   213

   214

    def GetNearestData(self, tick, adjust):

   215

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

   216

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

   217

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

   218

            new_cursor -= 1

   219

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

   220

            new_cursor += 1

   221

        return new_cursor

   222

   223

    def GetBounds(self):

   224

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

   225

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

   226

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

   227

   228

    def ResetBounds(self):

   229

        self.StartIdx = None

   230

        self.EndIdx = None

   231

   232

    def RefreshCanvasRange(self):

   233

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

   234

            self.RangeValues = RANGE_VALUES

   235

            self.CanvasRange.Clear()

   236

            for text, value in RANGE_VALUES:

   237

                self.CanvasRange.Append(text)

   238

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

   239

            self.CurrentRange = RANGE_VALUES[0][1]

   240

        elif self.RangeValues != TIME_RANGE_VALUES:

   241

            self.RangeValues = TIME_RANGE_VALUES

   242

            self.CanvasRange.Clear()

   243

            for text, value in TIME_RANGE_VALUES:

   244

                self.CanvasRange.Append(text)

   245

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

   246

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

   247

   248

    def RefreshView(self, force=True):

   249

        self.Freeze()

   250

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

   251

            if (self.MinValue is not None and 

   252

                self.MaxValue is not None and 

   253

                self.MinValue != self.MaxValue):

   254

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

   255

            else:

   256

                Yrange = 2. / self.CurrentZoom

   257

   258

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

   259

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

   260

                               min(self.YCenter, 

   261

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

   262

   263

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

   264

   265

            self.GetBounds()

   266

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

   267

                                                 legend=var_name, colour=colours[0])

   268

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

   269

            self.Canvas.Draw(self.GraphicsObject, 

   270

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

   271

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

   272

   273

            # Reset and draw cursor 

   274

            self.ResetLastCursor()

   275

            self.RefreshCursor()

   276

   277

        self.RefreshScrollBar()

   278

   279

        self.Thaw()

   280

   281

    def GetInstancePath(self):

   282

        return self.InstancePath

   283

   284

    def IsViewing(self, tagname):

   285

        return self.InstancePath == tagname

   286

   287

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

   288

        self.Datas.append((float(tick), {True:1., False:0.}.get(value, float(value))))

   289

        if self.MinValue is None:

   290

            self.MinValue = value

   291

        else:

   292

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

   293

        if self.MaxValue is None:

   294

            self.MaxValue = value

   295

        else:

   296

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

   297

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

   298

            self.GetBounds()

   299

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

   300

                self.StartIdx += 1

   301

            self.EndIdx += 1

   302

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

   303

        self.NewDataAvailable()

   304

   305

    def RefreshScrollBar(self):

   306

        if len(self.Datas) > 0:

   307

            self.GetBounds()

   308

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

   309

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

   310

        else:

   311

            pos = 0

   312

            range = 0

   313

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

   314

   315

    def RefreshRange(self):

   316

        if len(self.Datas) > 0:

   317

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

   318

                self.Fixed = False

   319

            self.ResetBounds()

   320

            if self.Fixed:

   321

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

   322

            else:

   323

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

   324

        self.NewDataAvailable(True)

   325

   326

    def OnRangeChanged(self, event):

   327

        try:

   328

            if self.Ticktime == 0:

   329

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

   330

            else:

   331

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

   332

        except ValueError, e:

   333

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

   334

        wx.CallAfter(self.RefreshRange)

   335

        event.Skip()

   336

   337

    def OnZoomChanged(self, event):

   338

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

   339

        wx.CallAfter(self.NewDataAvailable, True)

   340

        event.Skip()

   341

   342

    def OnPositionChanging(self, event):

   343

        self.ResetBounds()

   344

        self.StartTick = self.Datas[0][0] + event.GetPosition()

   345

        self.Fixed = True

   346

        self.NewDataAvailable(True)

   347

        event.Skip()

   348

   349

    def OnResetButton(self, event):

   350

        self.Fixed = False

   351

        self.ResetView()

   352

        event.Skip()

   353

   354

    def OnCurrentButton(self, event):

   355

        self.ResetBounds()

   356

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

   357

        self.Fixed = False

   358

        self.NewDataAvailable(True)

   359

        event.Skip()

   360

   361

    def OnExportGraphButtonClick(self, event):

   362

        data_copy = self.Datas[:]

   363

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

   364

        for tick, value in data_copy:

   365

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

   366

        self.ParentWindow.SetCopyBuffer(text)

   367

        event.Skip()

   368

   369

    def OnCanvasLeftDown(self, event):

   370

        self.Fixed = True

   371

        self.Canvas.canvas.CaptureMouse()

   372

        if len(self.Datas) > 0:

   373

            if self.Mode == MODE_SELECTION:

   374

                self.Dragging = True

   375

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

   376

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

   377

                self.RefreshCursor()

   378

            elif self.Mode == MODE_MOTION:

   379

                self.GetBounds()

   380

                self.CurrentMousePos = event.GetPosition()

   381

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

   382

        event.Skip()

   383

   384

    def OnCanvasLeftUp(self, event):

   385

        self.Dragging = False

   386

        if self.Mode == MODE_MOTION:

   387

            self.CurrentMousePos = None

   388

            self.CurrentMotionValue = None

   389

        if self.Canvas.canvas.HasCapture():

   390

            self.Canvas.canvas.ReleaseMouse()

   391

        event.Skip()

   392

   393

    def OnCanvasMotion(self, event):

   394

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

   395

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

   396

            graphics, xAxis, yAxis = self.Canvas.last_draw

   397

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

   398

            self.RefreshCursor()

   399

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

   400

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

   401

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

   402

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

   403

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

   404

            self.ResetBounds()

   405

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

   406

            self.CurrentMousePos = event.GetPosition()

   407

            self.NewDataAvailable(True)

   408

        event.Skip()

   409

   410

    def OnCanvasMouseWheel(self, event):

   411

        if self.CurrentMousePos is None:

   412

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

   413

            if event.ShiftDown():

   414

                current = self.CanvasRange.GetSelection()

   415

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

   416

                if new != current:

   417

                    if self.Ticktime == 0:

   418

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

   419

                    else:

   420

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

   421

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

   422

                    wx.CallAfter(self.RefreshRange)

   423

            else:

   424

                current = self.CanvasZoom.GetSelection()

   425

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

   426

                if new != current:

   427

                    self.CurrentZoom = ZOOM_VALUES[new][1]

   428

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

   429

                    wx.CallAfter(self.NewDataAvailable, True)

   430

        event.Skip()

   431

   432

    def OnCanvasResize(self, event):

   433

        self.ResetLastCursor()

   434

        wx.CallAfter(self.RefreshCursor)

   435

        event.Skip()

   436

   437

    ## Reset the last cursor

   438

    def ResetLastCursor(self):

   439

        self.LastCursor = None

   440

   441

    ## Draw the cursor on graphic

   442

    #  @param dc The draw canvas

   443

    #  @param cursor The cursor parameters

   444

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

   445

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

   446

            # Prepare temporary dc for drawing

   447

            width = self.Canvas._Buffer.GetWidth()

   448

            height = self.Canvas._Buffer.GetHeight()

   449

            tmp_Buffer = wx.EmptyBitmap(width, height)

   450

            dcs = wx.MemoryDC()

   451

            dcs.SelectObject(tmp_Buffer)

   452

            dcs.Clear()

   453

            dcs.BeginDrawing()

   454

   455

            dcs.SetPen(wx.Pen(wx.RED))

   456

            dcs.SetBrush(wx.Brush(wx.RED, wx.SOLID))

   457

            dcs.SetFont(self.Canvas._getFont(self.Canvas._fontSizeAxis))

   458

   459

            # Calculate clipping region

   460

            graphics, xAxis, yAxis = self.Canvas.last_draw

   461

            p1 = numpy.array([xAxis[0], yAxis[0]])

   462

            p2 = numpy.array([xAxis[1], yAxis[1]])

   463

            cx, cy, cwidth, cheight = self.Canvas._point2ClientCoord(p1, p2)

   464

   465

            px, py = self.Canvas.PositionUserToScreen((float(cursor), 0.))

   466

   467

            # Draw line cross drawing for diaplaying time cursor

   468

            dcs.DrawLine(px, cy + 1, px, cy + cheight - 1)

   469

   470

            lines = ("X:%d\nY:%f" % (cursor, value)).splitlines()

   471

   472

            wtext = 0

   473

            for line in lines:

   474

                w, h = dcs.GetTextExtent(line)

   475

                wtext = max(wtext, w)

   476

   477

            offset = 0

   478

            for line in lines:

   479

                # Draw time cursor date

   480

                dcs.DrawText(line, min(px + 3, cx + cwidth - wtext), cy + 3 + offset)

   481

                w, h = dcs.GetTextExtent(line)

   482

                offset += h

   483

   484

            dcs.EndDrawing()

   485

   486

            #this will erase if called twice

   487

            dc.Blit(0, 0, width, height, dcs, 0, 0, wx.EQUIV)  #(NOT src) XOR dst

   488

   489

    ## Refresh the variable cursor.

   490

    #  @param dc The draw canvas

   491

    def RefreshCursor(self, dc=None):

   492

        if self:

   493