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 wx

    26

from math import *

    27

    28

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

    29

#                               Common constants

    30

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

    31

    32

"""

    33

Definition of constants for dimensions of graphic elements

    34

"""

    35

    36

# FBD and SFC constants

    37

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    38

CONNECTOR_SIZE = 8                      # Size of connectors

    39

BLOCK_LINE_SIZE = 20                    # Minimum size of each line in a block

    40

HANDLE_SIZE = 6                         # Size of the squares for handles

    41

ANCHOR_DISTANCE = 5                     # Distance where wire is automativally attached to a connector

    42

POINT_RADIUS = 2                        # Radius of the point of wire ends

    43

MIN_SEGMENT_SIZE = 2                    # Minimum size of the endling segments of a wire

    44

    45

# LD constants

    46

LD_LINE_SIZE = 40                       # Distance between two lines in a ladder rung

    47

LD_ELEMENT_SIZE = (21, 15)              # Size (width, height) of a ladder element (contact or coil)

    48

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    49

LD_WIRECOIL_SIZE = 70                   # Size of a wire between a coil and a contact

    50

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    51

LD_OFFSET = (10, 10)                    # Distance (x, y) between each comment and rung of the ladder

    52

LD_COMMENT_DEFAULTSIZE = (600, 40)      # Size (width, height) of a comment box

    53

    54

# SFC constants

    55

SFC_STEP_DEFAULT_SIZE = (40, 30)        # Default size of a SFC step

    56

SFC_TRANSITION_SIZE = (20, 2)           # Size of a SFC transition

    57

SFC_DEFAULT_SEQUENCE_INTERVAL = 40      # Default size of the interval between two divergence branches

    58

SFC_SIMULTANEOUS_SEQUENCE_EXTRA = 20    # Size of extra lines for simultaneous divergence and convergence

    59

SFC_JUMP_SIZE = (12, 13)                # Size of a SFC jump to step

    60

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    61

SFC_ACTION_MIN_SIZE = (100, 30)         # Minimum size of an action block line

    62

    63

# Type definition constants for graphic elements

    64

[INPUT, OUTPUT, INOUT] = range(3)

    65

[CONNECTOR, CONTINUATION] = range(2)

    66

[LEFTRAIL, RIGHTRAIL] = range(2)

    67

[CONTACT_NORMAL, CONTACT_REVERSE, CONTACT_RISING, CONTACT_FALLING] = range(4)

    68

[COIL_NORMAL, COIL_REVERSE, COIL_SET, COIL_RESET] = range(4)

    69

[SELECTION_DIVERGENCE, SELECTION_CONVERGENCE, SIMULTANEOUS_DIVERGENCE, SIMULTANEOUS_CONVERGENCE] = range(4)

    70

    71

# Constants for defining the type of dragging that has been selected

    72

[HANDLE_MOVE, HANDLE_RESIZE, HANDLE_POINT, HANDLE_SEGMENT, HANDLE_CONNECTOR] = range(5)

    73

    74

# List of value for resize handle that are valid

    75

VALID_HANDLES = [(1,1), (1,2), (1,3), (2,3), (3,3), (3,2), (3,1), (2,1)]

    76

    77

# Contants for defining the direction of a connector

    78

[EAST, NORTH, WEST, SOUTH] = [(1,0), (0,-1), (-1,0), (0,1)]

    79

    80

# Contants for defining which mode is selected for each view 

    81

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT, 

    82

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP, 

    83

 MODE_TRANSITION, MODE_DIVERGENCE, MODE_JUMP, MODE_ACTION] = range(14)

    84

    85

# Contants for defining alignment types for graphic group 

    86

[ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, ALIGN_TOP, ALIGN_MIDDLE, ALIGN_BOTTOM] = range(6)

    87

    88

# Contants for defining which drawing mode is selected for app

    89

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    90

    91

# Color for Highlighting

    92

HIGHLIGHTCOLOR = wx.CYAN

    93

    94

CURSORS = None

    95

    96

def ResetCursors():

    97

    global CURSORS

    98

    if CURSORS == None:

    99

        CURSORS = [wx.NullCursor, 

   100

                   wx.StockCursor(wx.CURSOR_HAND),

   101

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

   102

                   wx.StockCursor(wx.CURSOR_SIZENESW),

   103

                   wx.StockCursor(wx.CURSOR_SIZEWE),

   104

                   wx.StockCursor(wx.CURSOR_SIZENS)]

   105

   106

HANDLE_CURSORS = {

   107

    (1, 1) : 2,

   108

    (3, 3) : 2,

   109

    (1, 3) : 3,

   110

    (3, 1) : 3,

   111

    (1, 2) : 4,

   112

    (3, 2) : 4,

   113

    (2, 1) : 5,

   114

    (2, 3) : 5

   115

}

   116

   117

"""

   118

Basic vector operations for calculate wire points

   119

"""

   120

   121

# Calculate the scalar product of two vectors

   122

def product(v1, v2):

   123

    return v1[0] * v2[0] + v1[1] * v2[1]

   124

   125

# Create a vector from two points and define if vector must be normal

   126

def vector(p1, p2, normal = True):

   127

    vector = (p2.x - p1.x, p2.y - p1.y)

   128

    if normal:

   129

        return normalize(vector)

   130

    return vector

   131

   132

# Calculate the norm of a given vector

   133

def norm(v):

   134

    return sqrt(v[0] * v[0] + v[1] * v[1])

   135

   136

# Normalize a given vector

   137

def normalize(v):

   138

    v_norm = norm(v)

   139

    # Verifie if it is not a null vector

   140

    if v_norm > 0:

   141

        return (v[0] / v_norm, v[1] / v_norm)

   142

    else:

   143

        return v

   144

   145

   146

"""

   147

Function that calculates the nearest point of the grid defined by scaling for the given point

   148

"""

   149

   150

def GetScaledEventPosition(event, dc, scaling):

   151

    pos = event.GetLogicalPosition(dc)

   152

    if scaling:

   153

        pos.x = round(float(pos.x) / float(scaling[0])) * scaling[0]

   154

        pos.y = round(float(pos.y) / float(scaling[1])) * scaling[1]

   155

    return pos

   156

   157

   158

"""

   159

Function that choose a direction during the wire points generation

   160

"""

   161

   162

def DirectionChoice(v_base, v_target, dir_target):

   163

    dir_product = product(v_base, v_target)

   164

    if dir_product < 0:

   165

        return (-v_base[0], -v_base[1])

   166

    elif dir_product == 0 and product(v_base, dir_target) != 0:

   167

        return dir_target

   168

    return v_base

   169

   170

   171

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

   172

#                               Viewer Rubberband

   173

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

   174

   175

"""

   176

Class that implements a rubberband

   177

"""

   178

   179

class RubberBand:

   180

   181

    # Create a rubberband by indicated on which window it must be drawn

   182

    def __init__(self, drawingSurface):

   183

        self.drawingSurface = drawingSurface

   184

        self.Reset()

   185

   186

    # Method that initializes the internal attributes of the rubberband

   187

    def Reset(self):

   188

        self.startPoint = None

   189

        self.currentBox = None

   190

        self.lastBox = None

   191

   192

    # Method that return if a box is currently edited

   193

    def IsShown(self):

   194

        return self.currentBox != None

   195

   196

    # Method that returns the currently edited box

   197

    def GetCurrentExtent(self):

   198

        return self.currentBox

   199

   200

    # Method called when a new box starts to be edited

   201

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

   202

        pos = GetScaledEventPosition(event, dc, scaling)

   203

        # Save the point for calculate the box position and size

   204

        self.startPoint = pos

   205

        self.currentBox = wx.Rect(pos.x, pos.y, 0, 0)

   206

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

   207

        self.Redraw()

   208

   209

    # Method called when dragging with a box edited

   210

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

   211

        pos = GetScaledEventPosition(event, dc, scaling)

   212

        # Save the last position and size of the box for erasing it

   213

        self.lastBox = wx.Rect(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   214

            self.currentBox.height)

   215

        # Calculate new position and size of the box 

   216

        if pos.x >= self.startPoint.x:

   217

            self.currentBox.x = self.startPoint.x

   218

            self.currentBox.width = pos.x - self.startPoint.x + 1

   219

        else:

   220

            self.currentBox.x = pos.x

   221

            self.currentBox.width = self.startPoint.x - pos.x + 1

   222

        if pos.y >= self.startPoint.y:

   223

            self.currentBox.y = self.startPoint.y

   224

            self.currentBox.height = pos.y - self.startPoint.y + 1

   225

        else:

   226

            self.currentBox.y = pos.y

   227

            self.currentBox.height = self.startPoint.y - pos.y + 1

   228

        self.Redraw()

   229

   230

    # Method called when dragging is stopped

   231

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

   232

        self.drawingSurface.SetCursor(wx.NullCursor)

   233

        self.lastBox = self.currentBox

   234

        self.currentBox = None

   235

        self.Redraw()

   236

   237

    # Method that erase the last box and draw the new box

   238

    def Redraw(self, dc = None):

   239

        if not dc:

   240

            dc = self.drawingSurface.GetLogicalDC()

   241

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   242

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   243

        dc.SetLogicalFunction(wx.XOR)

   244

        if self.lastBox:

   245

            # Erase last box

   246

            dc.DrawRectangle(self.lastBox.x, self.lastBox.y, self.lastBox.width,

   247

                self.lastBox.height)

   248

        if self.currentBox:

   249

            # Draw current box

   250

            dc.DrawRectangle(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   251

                self.currentBox.height)

   252

   253

    # Erase last box

   254

    def Erase(self, dc = None):

   255

        if not dc:

   256

            dc = self.drawingSurface.GetLogicalDC()

   257

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   258

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   259

        dc.SetLogicalFunction(wx.XOR)

   260

        if self.lastBox:

   261

            dc.DrawRectangle(self.lastBox.x, self.lastBox.y, self.lastBox.width,

   262

                self.lastBox.height)

   263

   264

    # Draw current box

   265

    def Draw(self, dc = None):

   266

        if not dc:

   267

            dc = self.drawingSurface.GetLogicalDC()

   268

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   269

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   270

        dc.SetLogicalFunction(wx.XOR)

   271

        if self.currentBox:

   272

            # Draw current box

   273

            dc.DrawRectangle(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   274

                self.currentBox.height)

   275

   276

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

   277

#                    Helper for highlighting error in drawn text

   278

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

   279

   280

def HighlightErrorZone(dc, x, y, width, height):

   281

    dc.SetPen(wx.TRANSPARENT_PEN)

   282

    dc.SetLogicalFunction(wx.AND)

   283

    dc.SetBrush(wx.Brush(wx.Colour(0,255,0)))

   284

    dc.DrawRectangle(x, y, width, height)

   285

    dc.SetLogicalFunction(wx.XOR)

   286

    dc.SetBrush(wx.Brush(wx.Colour(255,0,0)))

   287

    dc.DrawRectangle(x, y, width, height)

   288

    dc.SetLogicalFunction(wx.COPY)

   289

   290

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

   291

#                           Graphic element base class

   292

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

   293

   294

"""

   295

Class that implements a generic graphic element

   296

"""

   297

   298

class Graphic_Element:

   299

   300

    # Create a new graphic element

   301

    def __init__(self, parent, id = None):

   302

        self.Parent = parent

   303

        self.Id = id

   304

        self.oldPos = None

   305

        self.Handle = (None,None)

   306

        self.Dragging = False

   307

        self.Selected = False

   308

        self.Highlighted = False

   309

        self.Pos = wx.Point(0, 0)

   310

        self.Size = wx.Size(0, 0)

   311

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

   312

        self.CurrentCursor = 0

   313

        ResetCursors()

   314

   315

    def IsOfType(self, type, reference):

   316

        return self.Parent.IsOfType(type, reference)

   317

   318

    def IsEndType(self, type):

   319

        return self.Parent.IsEndType(type)

   320

   321

    def GetDragging(self):

   322

        return self.Dragging

   323

   324

    # Make a clone of this element

   325

    def Clone(self, parent):

   326

        return Graphic_Element(parent, self.Id)

   327

   328

    # Changes the block position

   329

    def SetPosition(self, x, y):

   330

        self.Pos.x = x

   331

        self.Pos.y = y

   332

        self.RefreshConnected()

   333

        self.RefreshBoundingBox()

   334

   335

    # Returns the block position

   336

    def GetPosition(self):

   337

        return self.Pos.x, self.Pos.y

   338

   339

    # Changes the element size

   340

    def SetSize(self, width, height):

   341

        self.Size.SetWidth(width)

   342

        self.Size.SetHeight(height)

   343

        self.RefreshConnectors()

   344

        self.RefreshBoundingBox()

   345

   346

    # Returns the element size

   347

    def GetSize(self):

   348

        return self.Size.GetWidth(), self.Size.GetHeight()

   349

   350

    # Refresh the element Bounding Box

   351

    def RefreshBoundingBox(self):

   352

        self.BoundingBox = wx.Rect(self.Pos.x, self.Pos.y, self.Size[0], self.Size[1])

   353

   354

    # Refresh the element connectors position

   355

    def RefreshConnectors(self):

   356

        pass

   357

   358

    # Refresh the position of wires connected to element inputs and outputs

   359

    def RefreshConnected(self):

   360

        pass

   361

   362

    # Change the parent

   363

    def SetParent(self, parent):

   364

        self.Parent = parent

   365

   366

    # Override this method for defining the method to call for deleting this element

   367

    def Delete(self):

   368

        pass

   369

   370

    # Returns the Id

   371

    def GetId(self):

   372

        return self.Id

   373

   374

    # Returns if the point given is in the bounding box

   375

    def HitTest(self, pt):

   376

        rect = self.BoundingBox

   377

        return rect.InsideXY(pt.x, pt.y)

   378

   379

    # Returns if the point given is in the bounding box

   380

    def IsInSelection(self, rect):

   381

        return rect.InsideXY(self.BoundingBox.x, self.BoundingBox.y) and rect.InsideXY(self.BoundingBox.x + self.BoundingBox.width, self.BoundingBox.y + self.BoundingBox.height)

   382

   383

    # Override this method for refreshing the bounding box

   384

    def RefreshBoundingBox(self):

   385

        pass

   386

   387

    # Returns the bounding box

   388

    def GetBoundingBox(self):

   389

        return self.BoundingBox

   390

   391

    # Returns the RedrawRect

   392

    def GetRedrawRect(self, movex = 0, movey = 0):

   393

        rect = wx.Rect()

   394

        rect.x = self.BoundingBox.x - HANDLE_SIZE - 2 - abs(movex)

   395

        rect.y = self.BoundingBox.y - HANDLE_SIZE - 2 - abs(movey)

   396

        rect.width = self.BoundingBox.width + 2 * (HANDLE_SIZE + abs(movex)) + 4

   397

        rect.height = self.BoundingBox.height + 2 * (HANDLE_SIZE + abs(movey)) + 4

   398

        return rect

   399

   400

    def Refresh(self, rect = None):

   401

        if rect is not None:

   402

            self.Parent.RefreshRect(self.Parent.GetScrolledRect(rect), False)

   403

        else:

   404

            self.Parent.RefreshRect(self.Parent.GetScrolledRect(self.GetRedrawRect()), False)

   405

   406

    # Change the variable that indicates if this element is selected

   407

    def SetSelected(self, selected):

   408

        self.Selected = selected

   409

        self.Refresh()

   410

   411

    # Change the variable that indicates if this element is highlighted

   412

    def SetHighlighted(self, highlighted):

   413

        self.Highlighted = highlighted

   414

        self.Refresh()

   415

   416

    # Test if the point is on a handle of this element

   417

    def TestHandle(self, pt):

   418

        extern_rect = wx.Rect(self.BoundingBox.x - HANDLE_SIZE - 2, self.BoundingBox.y - HANDLE_SIZE - 2, 

   419

            self.BoundingBox.width + 2 * HANDLE_SIZE + 4, self.BoundingBox.height + 2 * HANDLE_SIZE + 4)

   420

        intern_rect = wx.Rect(self.BoundingBox.x - 2, self.BoundingBox.y - 2, 

   421

            self.BoundingBox.width + 4, self.BoundingBox.height + 4)

   422

        # Verify that this element is selected

   423

        if self.Selected and extern_rect.InsideXY(pt.x, pt.y) and not intern_rect.InsideXY(pt.x, pt.y):

   424

            # Find if point is on a handle horizontally

   425

            if self.BoundingBox.x - HANDLE_SIZE - 2 <= pt.x < self.BoundingBox.x - 2:

   426

                handle_x = 1

   427

            elif self.BoundingBox.x + (self.BoundingBox.width - HANDLE_SIZE) / 2 <= pt.x < self.BoundingBox.x + (self.BoundingBox.width + HANDLE_SIZE) / 2:

   428

                handle_x = 2

   429

            elif self.BoundingBox.x + self.BoundingBox.width + 2 <= pt.x < self.BoundingBox.x + self.BoundingBox.width + HANDLE_SIZE + 2:

   430

                handle_x = 3

   431

            else:

   432

                handle_x = 0

   433

            # Find if point is on a handle vertically

   434

            if self.BoundingBox.y - HANDLE_SIZE - 2 <= pt.y < self.BoundingBox.y - 2:

   435

                handle_y = 1

   436

            elif self.BoundingBox.y + (self.BoundingBox.height - HANDLE_SIZE) / 2 <= pt.y < self.BoundingBox.y + (self.BoundingBox.height + HANDLE_SIZE) / 2:

   437

                handle_y = 2

   438

            elif self.BoundingBox.y + self.BoundingBox.height - 2 <= pt.y < self.BoundingBox.y + self.BoundingBox.height + HANDLE_SIZE + 2:

   439

                handle_y = 3

   440

            else:

   441

                handle_y = 0

   442

            # Verify that the result is valid

   443

            if (handle_x, handle_y) in VALID_HANDLES:

   444

                return handle_x, handle_y

   445

        return 0, 0

   446

   447

    # Method called when a LeftDown event have been generated

   448

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

   449

        pos = event.GetLogicalPosition(dc)

   450

        # Test if an handle have been clicked

   451

        handle = self.TestHandle(pos)

   452

        # Find which type of handle have been clicked,

   453

        # Save a resize event and change the cursor

   454

        cursor = HANDLE_CURSORS.get(handle, 1)

   455

        if cursor != self.CurrentCursor:

   456

            self.Parent.SetCursor(CURSORS[cursor])

   457

            self.CurrentCursor = cursor

   458

        if cursor > 1:

   459

            self.Handle = (HANDLE_RESIZE, handle)

   460

        else:

   461

            self.Handle = (HANDLE_MOVE, None)

   462

            self.SetSelected(False)

   463

        # Initializes the last position

   464

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

   465

   466

    # Method called when a LeftUp event have been generated

   467

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

   468

        # If a dragging have been initiated

   469

        if self.Dragging and self.oldPos:

   470

            self.RefreshModel()

   471

            self.Parent.RefreshBuffer()

   472

        if self.CurrentCursor != 0:

   473

            self.Parent.SetCursor(CURSORS[0])

   474

            self.CurrentCursor = 0

   475

        self.SetSelected(True)

   476

        self.oldPos = None

   477

   478

    # Method called when a RightDown event have been generated

   479

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

   480

        pass

   481

   482

    # Method called when a RightUp event have been generated

   483

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

   484

        if self.Dragging and self.oldPos:

   485

            self.RefreshModel()

   486

            self.Parent.RefreshBuffer()

   487

        if self.CurrentCursor != 0:

   488

            self.Parent.SetCursor(CURSORS[0])

   489

            self.CurrentCursor = 0

   490

        self.SetSelected(True)

   491

        self.oldPos = None

   492

   493

    # Method called when a LeftDClick event have been generated

   494

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

   495

        pass

   496

   497

    # Method called when a Motion event have been generated

   498

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

   499

        # If the cursor is dragging and the element have been clicked

   500

        if event.Dragging() and self.oldPos:

   501

            # Calculate the movement of cursor

   502

            pos = event.GetLogicalPosition(dc)

   503

            movex = pos.x - self.oldPos.x

   504

            movey = pos.y - self.oldPos.y

   505

            # If movement is greater than MIN_MOVE then a dragging is initiated

   506

            if not self.Dragging and (abs(movex) > MIN_MOVE or abs(movey) > MIN_MOVE):

   507

                self.Dragging = True

   508

            # If a dragging have been initiated, refreshes the element state

   509

            if self.Dragging: