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 types import *

    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, COIL_RISING, COIL_FALLING] = range(6)

    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

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

   123

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

   124

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

   125

    if normal:

   126

        return normalize(vector)

   127

    return vector

   128

   129

# Calculate the norm of a given vector

   130

def norm(v):

   131

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

   132

   133

# Normalize a given vector

   134

def normalize(v):

   135

    v_norm = norm(v)

   136

    # Verifie if it is not a null vector

   137

    if v_norm > 0:

   138

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

   139

    else:

   140

        return v

   141

   142

# Calculate the scalar product of two vectors

   143

def is_null_vector(v):

   144

    return v == (0, 0)

   145

   146

# Calculate the scalar product of two vectors

   147

def add_vectors(v1, v2):

   148

    return (v1[0] + v2[0], v1[1] + v2[1])

   149

   150

# Calculate the scalar product of two vectors

   151

def product(v1, v2):

   152

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

   153

   154

   155

"""

   156

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

   157

"""

   158

   159

def GetScaledEventPosition(event, dc, scaling):

   160

    pos = event.GetLogicalPosition(dc)

   161

    if scaling:

   162

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

   163

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

   164

    return pos

   165

   166

   167

"""

   168

Function that choose a direction during the wire points generation

   169

"""

   170

   171

def DirectionChoice(v_base, v_target, dir_target):

   172

    dir_product = product(v_base, v_target)

   173

    if dir_product < 0:

   174

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

   175

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

   176

        return dir_target

   177

    return v_base

   178

   179

   180

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

   181

#                               Viewer Rubberband

   182

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

   183

   184

"""

   185

Class that implements a rubberband

   186

"""

   187

   188

class RubberBand:

   189

   190

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

   191

    def __init__(self, drawingSurface):

   192

        self.drawingSurface = drawingSurface

   193

        self.Reset()

   194

   195

    # Method that initializes the internal attributes of the rubberband

   196

    def Reset(self):

   197

        self.startPoint = None

   198

        self.currentBox = None

   199

        self.lastBox = None

   200

   201

    # Method that return if a box is currently edited

   202

    def IsShown(self):

   203

        return self.currentBox != None

   204

   205

    # Method that returns the currently edited box

   206

    def GetCurrentExtent(self):

   207

        return self.currentBox

   208

   209

    # Method called when a new box starts to be edited

   210

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

   211

        pos = GetScaledEventPosition(event, dc, scaling)

   212

        # Save the point for calculate the box position and size

   213

        self.startPoint = pos

   214

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

   215

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

   216

        self.Redraw()

   217

   218

    # Method called when dragging with a box edited

   219

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

   220

        pos = GetScaledEventPosition(event, dc, scaling)

   221

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

   222

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

   223

            self.currentBox.height)

   224

        # Calculate new position and size of the box 

   225

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

   226

            self.currentBox.x = self.startPoint.x

   227

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

   228

        else:

   229

            self.currentBox.x = pos.x

   230

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

   231

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

   232

            self.currentBox.y = self.startPoint.y

   233

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

   234

        else:

   235

            self.currentBox.y = pos.y

   236

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

   237

        self.Redraw()

   238

   239

    # Method called when dragging is stopped

   240

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

   241

        self.drawingSurface.SetCursor(wx.NullCursor)

   242

        self.lastBox = self.currentBox

   243

        self.currentBox = None

   244

        self.Redraw()

   245

   246

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

   247

    def Redraw(self, dc = None):

   248

        if not dc:

   249

            dc = self.drawingSurface.GetLogicalDC()

   250

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

   251

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   252

        dc.SetLogicalFunction(wx.XOR)

   253

        if self.lastBox:

   254

            # Erase last box

   255

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

   256

                self.lastBox.height)

   257

        if self.currentBox:

   258

            # Draw current box

   259

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

   260

                self.currentBox.height)

   261

   262

    # Erase last box

   263

    def Erase(self, dc = None):

   264

        if not dc:

   265

            dc = self.drawingSurface.GetLogicalDC()

   266

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

   267

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   268

        dc.SetLogicalFunction(wx.XOR)

   269

        if self.lastBox:

   270

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

   271

                self.lastBox.height)

   272

   273

    # Draw current box

   274

    def Draw(self, dc = None):

   275

        if not dc:

   276

            dc = self.drawingSurface.GetLogicalDC()

   277

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

   278

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   279

        dc.SetLogicalFunction(wx.XOR)

   280

        if self.currentBox:

   281

            # Draw current box

   282

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

   283

                self.currentBox.height)

   284

   285

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

   286

#                    Helper for highlighting error in drawn text

   287

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

   288

   289

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

   290

    dc.SetPen(wx.TRANSPARENT_PEN)

   291

    dc.SetLogicalFunction(wx.AND)

   292

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

   293

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

   294

    dc.SetLogicalFunction(wx.XOR)

   295

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

   296

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

   297

    dc.SetLogicalFunction(wx.COPY)

   298

   299

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

   300

#                           Graphic element base class

   301

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

   302

   303

"""

   304

Class that implements a generic graphic element

   305

"""

   306

   307

class Graphic_Element:

   308

   309

    # Create a new graphic element

   310

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

   311

        self.Parent = parent

   312

        self.Id = id

   313

        self.oldPos = None

   314

        self.Handle = (None,None)

   315

        self.Dragging = False

   316

        self.Selected = False

   317

        self.Highlighted = False

   318

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

   319

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

   320

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

   321

        self.Visible = False

   322

        self.CurrentCursor = 0

   323

        ResetCursors()

   324

   325

    def TestVisible(self, screen):

   326

        self.Visible = self.GetRedrawRect().Intersects(screen)

   327

   328

    def IsVisible(self):

   329

        return self.Visible

   330

   331

    def SpreadCurrent(self):

   332

        pass

   333

   334

    def GetConnectorTranslation(self, element):

   335

        return {}

   336

   337

    def IsOfType(self, type, reference):

   338

        return self.Parent.IsOfType(type, reference)

   339

   340

    def IsEndType(self, type):

   341

        return self.Parent.IsEndType(type)

   342

   343

    def GetDragging(self):

   344

        return self.Dragging

   345

   346

    # Make a clone of this element

   347

    def Clone(self, parent):

   348

        return Graphic_Element(parent, self.Id)

   349

   350

    # Changes the block position

   351

    def SetPosition(self, x, y):

   352

        self.Pos.x = x

   353

        self.Pos.y = y

   354

        self.RefreshConnected()

   355

        self.RefreshBoundingBox()

   356

   357

    # Returns the block position

   358

    def GetPosition(self):

   359

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

   360

   361

    # Changes the element size

   362

    def SetSize(self, width, height):

   363

        self.Size.SetWidth(width)

   364

        self.Size.SetHeight(height)

   365

        self.RefreshConnectors()

   366

        self.RefreshBoundingBox()

   367

   368

    # Returns the element size

   369

    def GetSize(self):

   370

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

   371

   372

    # Refresh the element Bounding Box

   373

    def RefreshBoundingBox(self):

   374

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

   375

   376

    # Refresh the element connectors position

   377

    def RefreshConnectors(self):

   378

        pass

   379

   380

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

   381

    def RefreshConnected(self):

   382

        pass

   383

   384

    # Change the parent

   385

    def SetParent(self, parent):

   386

        self.Parent = parent

   387

   388

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

   389

    def Delete(self):

   390

        pass

   391

   392

    # Returns the Id

   393

    def GetId(self):

   394

        return self.Id

   395

   396

    # Returns if the point given is in the bounding box

   397

    def HitTest(self, pt):

   398

        rect = self.BoundingBox

   399

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

   400

   401

    # Returns if the point given is in the bounding box

   402

    def IsInSelection(self, rect):

   403

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

   404

   405

    # Override this method for refreshing the bounding box

   406

    def RefreshBoundingBox(self):

   407

        pass

   408

   409

    # Returns the bounding box

   410

    def GetBoundingBox(self):

   411

        return self.BoundingBox

   412

   413

    # Returns the RedrawRect

   414

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

   415

        rect = wx.Rect()

   416

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

   417

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

   418

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

   419

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

   420

        return rect

   421

   422

    def Refresh(self, rect = None):

   423

        if rect is not None:

   424

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

   425

        else:

   426

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

   427

   428

    # Change the variable that indicates if this element is selected

   429

    def SetSelected(self, selected):

   430

        self.Selected = selected

   431

        self.Refresh()

   432

   433

    # Change the variable that indicates if this element is highlighted

   434

    def SetHighlighted(self, highlighted):

   435

        self.Highlighted = highlighted

   436

        self.Refresh()

   437

   438

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

   439

    def TestHandle(self, pt):

   440

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

   441

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

   442

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

   443

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

   444

        # Verify that this element is selected

   445

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

   446

            # Find if point is on a handle horizontally

   447

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

   448

                handle_x = 1

   449

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

   450

                handle_x = 2

   451

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

   452

                handle_x = 3

   453

            else:

   454

                handle_x = 0

   455

            # Find if point is on a handle vertically

   456

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

   457

                handle_y = 1

   458

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

   459

                handle_y = 2

   460

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

   461

                handle_y = 3

   462

            else:

   463

                handle_y = 0

   464

            # Verify that the result is valid

   465

            if (handle_x, handle_y) in VALID_HANDLES:

   466

                return handle_x, handle_y

   467

        return 0, 0

   468

   469

    # Method called when a LeftDown event have been generated

   470

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

   471

        pos = event.GetLogicalPosition(dc)

   472

        # Test if an handle have been clicked

   473

        handle = self.TestHandle(pos)

   474

        # Find which type of handle have been clicked,

   475

        # Save a resize event and change the cursor

   476

        cursor = HANDLE_CURSORS.get(handle, 1)

   477

        if cursor != self.CurrentCursor:

   478

            self.Parent.SetCursor(CURSORS[cursor])

   479

            self.CurrentCursor = cursor

   480

        if cursor > 1:

   481

            self.Handle = (HANDLE_RESIZE, handle)

   482

        else:

   483

            self.Handle = (HANDLE_MOVE, None)

   484

            self.SetSelected(False)

   485

        # Initializes the last position

   486

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

   487

   488

    # Method called when a LeftUp event have been generated

   489

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

   490

        # If a dragging have been initiated

   491

        if self.Dragging and self.oldPos:

   492

            self.RefreshModel()

   493

            self.Parent.RefreshBuffer()

   494

        if self.CurrentCursor != 0:

   495

            self.Parent.SetCursor(CURSORS[0])

   496

            self.CurrentCursor = 0

   497

        self.SetSelected(True)

   498

        self.oldPos = None

   499

   500

    # Method called when a RightDown event have been generated

   501

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

   502

        pass

   503

   504

    # Method called when a RightUp event have been generated

   505

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

   506

        if self.Dragging and self.oldPos:

   507

            self.RefreshModel()

   508

            self.Parent.RefreshBuffer()