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

from plcopen.structures import IsOfType, IsEndType

    28

    29

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

    30

#                               Common constants

    31

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

    32

    33

"""

    34

Definition of constants for dimensions of graphic elements

    35

"""

    36

    37

# FBD and SFC constants

    38

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    39

CONNECTOR_SIZE = 8                      # Size of connectors

    40

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

    41

HANDLE_SIZE = 6                         # Size of the squares for handles

    42

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

    43

POINT_RADIUS = 2                        # Radius of the point of wire ends

    44

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

    45

    46

# LD constants

    47

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

    48

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

    49

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    50

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

    51

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    52

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

    53

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

    54

    55

# SFC constants

    56

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

    57

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

    58

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

    59

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

    60

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

    61

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    62

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

    63

    64

# Type definition constants for graphic elements

    65

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

    66

[CONNECTOR, CONTINUATION] = range(2)

    67

[LEFTRAIL, RIGHTRAIL] = range(2)

    68

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

    69

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

    70

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

    71

    72

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

    73

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

    74

    75

# List of value for resize handle that are valid

    76

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

    77

    78

# Contants for defining the direction of a connector

    79

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

    80

    81

# Contants for defining which mode is selected for each view 

    82

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT, 

    83

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP, 

    84

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

    85

    86

# Contants for defining alignment types for graphic group 

    87

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

    88

    89

# Contants for defining which drawing mode is selected for app

    90

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    91

    92

# Color for Highlighting

    93

HIGHLIGHTCOLOR = wx.CYAN

    94

    95

CURSORS = None

    96

    97

def ResetCursors():

    98

    global CURSORS

    99

    if CURSORS == None:

   100

        CURSORS = [wx.NullCursor, 

   101

                   wx.StockCursor(wx.CURSOR_HAND),

   102

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

   103

                   wx.StockCursor(wx.CURSOR_SIZENESW),

   104

                   wx.StockCursor(wx.CURSOR_SIZEWE),

   105

                   wx.StockCursor(wx.CURSOR_SIZENS)]

   106

   107

HANDLE_CURSORS = {

   108

    (1, 1) : 2,

   109

    (3, 3) : 2,

   110

    (1, 3) : 3,

   111

    (3, 1) : 3,

   112

    (1, 2) : 4,

   113

    (3, 2) : 4,

   114

    (2, 1) : 5,

   115

    (2, 3) : 5

   116

}

   117

   118

"""

   119

Basic vector operations for calculate wire points

   120

"""

   121

   122

# Calculate the scalar product of two vectors

   123

def product(v1, v2):

   124

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

   125

   126

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

   127

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

   128

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

   129

    if normal:

   130

        return normalize(vector)

   131

    return vector

   132

   133

# Calculate the norm of a given vector

   134

def norm(v):

   135

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

   136

   137

# Normalize a given vector

   138

def normalize(v):

   139

    v_norm = norm(v)

   140

    # Verifie if it is not a null vector

   141

    if v_norm > 0:

   142

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

   143

    else:

   144

        return v

   145

   146

   147

"""

   148

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

   149

"""

   150

   151

def GetScaledEventPosition(event, dc, scaling):

   152

    pos = event.GetLogicalPosition(dc)

   153

    if scaling:

   154

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

   155

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

   156

    return pos

   157

   158

   159

"""

   160

Function that choose a direction during the wire points generation

   161

"""

   162

   163

def DirectionChoice(v_base, v_target, dir_target):

   164

    dir_product = product(v_base, v_target)

   165

    if dir_product < 0:

   166

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

   167

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

   168

        return dir_target

   169

    return v_base

   170

   171

   172

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

   173

#                               Viewer Rubberband

   174

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

   175

   176

"""

   177

Class that implements a rubberband

   178

"""

   179

   180

class RubberBand:

   181

   182

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

   183

    def __init__(self, drawingSurface):

   184

        self.drawingSurface = drawingSurface

   185

        self.Reset()

   186

   187

    # Method that initializes the internal attributes of the rubberband

   188

    def Reset(self):

   189

        self.startPoint = None

   190

        self.currentBox = None

   191

        self.lastBox = None

   192

   193

    # Method that return if a box is currently edited

   194

    def IsShown(self):

   195

        return self.currentBox != None

   196

   197

    # Method that returns the currently edited box

   198

    def GetCurrentExtent(self):

   199

        return self.currentBox

   200

   201

    # Method called when a new box starts to be edited

   202

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

   203

        pos = GetScaledEventPosition(event, dc, scaling)

   204

        # Save the point for calculate the box position and size

   205

        self.startPoint = pos

   206

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

   207

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

   208

        self.Redraw()

   209

   210

    # Method called when dragging with a box edited

   211

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

   212

        pos = GetScaledEventPosition(event, dc, scaling)

   213

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

   214

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

   215

            self.currentBox.height)

   216

        # Calculate new position and size of the box 

   217

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

   218

            self.currentBox.x = self.startPoint.x

   219

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

   220

        else:

   221

            self.currentBox.x = pos.x

   222

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

   223

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

   224

            self.currentBox.y = self.startPoint.y

   225

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

   226

        else:

   227

            self.currentBox.y = pos.y

   228

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

   229

        self.Redraw()

   230

   231

    # Method called when dragging is stopped

   232

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

   233

        self.drawingSurface.SetCursor(wx.NullCursor)

   234

        self.lastBox = self.currentBox

   235

        self.currentBox = None

   236

        self.Redraw()

   237

   238

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

   239

    def Redraw(self, dc = None):

   240

        if not dc:

   241

            dc = self.drawingSurface.GetLogicalDC()

   242

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

   243

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   244

        dc.SetLogicalFunction(wx.XOR)

   245

        if self.lastBox:

   246

            # Erase last box

   247

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

   248

                self.lastBox.height)

   249

        if self.currentBox:

   250

            # Draw current box

   251

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

   252

                self.currentBox.height)

   253

   254

    # Erase last box

   255

    def Erase(self, dc = None):

   256

        if not dc:

   257

            dc = self.drawingSurface.GetLogicalDC()

   258

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

   259

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   260

        dc.SetLogicalFunction(wx.XOR)

   261

        if self.lastBox:

   262

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

   263

                self.lastBox.height)

   264

   265

    # Draw current box

   266

    def Draw(self, dc = None):

   267

        if not dc:

   268

            dc = self.drawingSurface.GetLogicalDC()

   269

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

   270

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   271

        dc.SetLogicalFunction(wx.XOR)

   272

        if self.currentBox:

   273

            # Draw current box

   274

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

   275

                self.currentBox.height)

   276

   277

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

   278

#                           Graphic element base class

   279

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

   280

   281

"""

   282

Class that implements a generic graphic element

   283

"""

   284

   285

class Graphic_Element:

   286

   287

    # Create a new graphic element

   288

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

   289

        self.Parent = parent

   290

        self.Id = id

   291

        self.oldPos = None

   292

        self.Handle = False

   293

        self.Dragging = False

   294

        self.Selected = False

   295

        self.Highlighted = False

   296

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

   297

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

   298

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

   299

        self.CurrentCursor = 0

   300

        ResetCursors()

   301

   302

    def GetDragging(self):

   303

        return self.Dragging

   304

   305

    # Make a clone of this element

   306

    def Clone(self):

   307

        return Graphic_Element(self.Parent, self.Id)

   308

   309

    # Changes the block position

   310

    def SetPosition(self, x, y):

   311

        self.Pos.x = x

   312

        self.Pos.y = y

   313

        self.RefreshConnected()

   314

        self.RefreshBoundingBox()

   315

   316

    # Returns the block position

   317

    def GetPosition(self):

   318

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

   319

   320

    # Changes the element size

   321

    def SetSize(self, width, height):

   322

        self.Size.SetWidth(width)

   323

        self.Size.SetHeight(height)

   324

        self.RefreshConnectors()

   325

        self.RefreshBoundingBox()

   326

   327

    # Returns the element size

   328

    def GetSize(self):

   329

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

   330

   331

    # Refresh the element Bounding Box

   332

    def RefreshBoundingBox(self):

   333

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

   334

   335

    # Refresh the element connectors position

   336

    def RefreshConnectors(self):

   337

        pass

   338

   339

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

   340

    def RefreshConnected(self):

   341

        pass

   342

   343

    # Change the parent

   344

    def SetParent(self, parent):

   345

        self.Parent = parent

   346

   347

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

   348

    def Delete(self):

   349

        pass

   350

   351

    # Returns the Id

   352

    def GetId(self):

   353

        return self.Id

   354

   355

    # Returns if the point given is in the bounding box

   356

    def HitTest(self, pt):

   357

        rect = self.BoundingBox

   358

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

   359

   360

    # Returns if the point given is in the bounding box

   361

    def IsInSelection(self, rect):

   362

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

   363

   364

    # Override this method for refreshing the bounding box

   365

    def RefreshBoundingBox(self):

   366

        pass

   367

   368

    # Returns the bounding box

   369

    def GetBoundingBox(self):

   370

        return self.BoundingBox

   371

   372

    # Returns the RedrawRect

   373

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

   374

        rect = wx.Rect()

   375

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

   376

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

   377

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

   378

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

   379

        return rect

   380

   381

    def Refresh(self, rect = None):

   382

        if rect is not None:

   383

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

   384

        else:

   385

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

   386

   387

    # Change the variable that indicates if this element is selected

   388

    def SetSelected(self, selected):

   389

        self.Selected = selected

   390

        self.Refresh()

   391

   392

    # Change the variable that indicates if this element is highlighted

   393

    def SetHighlighted(self, highlighted):

   394

        self.Highlighted = highlighted

   395

        self.Refresh()

   396

   397

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

   398

    def TestHandle(self, pt):

   399

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

   400

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

   401

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

   402

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

   403

        # Verify that this element is selected

   404

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

   405

            # Find if point is on a handle horizontally

   406

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

   407

                handle_x = 1

   408

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

   409

                handle_x = 2

   410

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

   411

                handle_x = 3

   412

            else:

   413

                handle_x = 0

   414

            # Find if point is on a handle vertically

   415

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

   416

                handle_y = 1

   417

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

   418

                handle_y = 2

   419

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

   420

                handle_y = 3

   421

            else:

   422

                handle_y = 0

   423

            # Verify that the result is valid

   424

            if (handle_x, handle_y) in VALID_HANDLES:

   425

                return handle_x, handle_y

   426

        return 0, 0

   427

   428

    # Method called when a LeftDown event have been generated

   429

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

   430

        pos = event.GetLogicalPosition(dc)

   431

        # Test if an handle have been clicked

   432

        handle = self.TestHandle(pos)

   433

        # Find which type of handle have been clicked,

   434

        # Save a resize event and change the cursor

   435

        cursor = HANDLE_CURSORS.get(handle, 1)

   436

        if cursor != self.CurrentCursor:

   437

            self.Parent.SetCursor(CURSORS[cursor])

   438

            self.CurrentCursor = cursor

   439

        if cursor > 1:

   440

            self.Handle = (HANDLE_RESIZE, handle)

   441

        else:

   442

            self.Handle = (HANDLE_MOVE, None)

   443

            self.SetSelected(False)

   444

        # Initializes the last position

   445

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

   446

   447

    # Method called when a LeftUp event have been generated

   448

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

   449

        # If a dragging have been initiated

   450

        if self.Dragging and self.oldPos:

   451

            self.RefreshModel()

   452

            self.Parent.RefreshBuffer()

   453

        if self.CurrentCursor != 0:

   454

            self.Parent.SetCursor(CURSORS[0])

   455

            self.CurrentCursor = 0

   456

        self.SetSelected(True)

   457

        self.oldPos = None

   458

   459

    # Method called when a RightDown event have been generated

   460

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

   461

        pass

   462

   463

    # Method called when a RightUp event have been generated

   464

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

   465

        if self.Dragging and self.oldPos:

   466

            self.RefreshModel()

   467

            self.Parent.RefreshBuffer()

   468

        if self.CurrentCursor != 0:

   469

            self.Parent.SetCursor(CURSORS[0])

   470

            self.CurrentCursor = 0

   471

        self.SetSelected(True)

   472

        self.oldPos = None

   473

   474

    # Method called when a LeftDClick event have been generated

   475

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

   476

        pass

   477

   478

    # Method called when a Motion event have been generated

   479

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

   480

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

   481

        if event.Dragging() and self.oldPos:

   482

            # Calculate the movement of cursor

   483

            pos = event.GetLogicalPosition(dc)

   484

            movex = pos.x - self.oldPos.x

   485

            movey = pos.y - self.oldPos.y

   486

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

   487

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

   488

                self.Dragging = True

   489

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

   490

            if self.Dragging:

   491

                dragx, dragy = self.ProcessDragging(movex, movey, scaling)

   492

                self.oldPos.x += dragx

   493

                self.oldPos.y += dragy

   494

                return dragx, dragy

   495

            return movex, movey

   496

        # If cursor just pass over the element, changes the cursor if it is on a handle

   497

        else:

   498

            pos = event.GetLogicalPosition(dc)

   499

            handle = self.TestHandle(pos)

   500

            # Find which type of handle have been clicked,

   501

            # Save a resize event and change the cursor

   502

            cursor = HANDLE_CURSORS.get(handle, 0)

   503

            if cursor != self.CurrentCursor:

   504

                self.Parent.SetCursor(CURSORS[cursor])

   505

                self.CurrentCursor = cursor

   506

            return 0, 0

   507

   508

    # Moves the element

   509

    def Move(self, dx, dy, exclude = []):

   510