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_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

CURSORS = None

    92

    93

def ResetCursors():

    94

    global CURSORS

    95

    if CURSORS == None:

    96

        CURSORS = [wx.NullCursor, 

    97

                   wx.StockCursor(wx.CURSOR_HAND),

    98

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

    99

                   wx.StockCursor(wx.CURSOR_SIZENESW),

   100

                   wx.StockCursor(wx.CURSOR_SIZEWE),

   101

                   wx.StockCursor(wx.CURSOR_SIZENS)]

   102

   103

HANDLE_CURSORS = {

   104

    (1, 1) : 2,

   105

    (3, 3) : 2,

   106

    (1, 3) : 3,

   107

    (3, 1) : 3,

   108

    (1, 2) : 4,

   109

    (3, 2) : 4,

   110

    (2, 1) : 5,

   111

    (2, 3) : 5

   112

}

   113

   114

"""

   115

Basic vector operations for calculate wire points

   116

"""

   117

   118

# Calculate the scalar product of two vectors

   119

def product(v1, v2):

   120

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

   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

   143

"""

   144

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

   145

"""

   146

   147

def GetScaledEventPosition(event, dc, scaling):

   148

    pos = event.GetLogicalPosition(dc)

   149

    if scaling:

   150

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

   151

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

   152

    return pos

   153

   154

   155

"""

   156

Function that choose a direction during the wire points generation

   157

"""

   158

   159

def DirectionChoice(v_base, v_target, dir_target):

   160

    dir_product = product(v_base, v_target)

   161

    if dir_product < 0:

   162

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

   163

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

   164

        return dir_target

   165

    return v_base

   166

   167

   168

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

   169

#                               Viewer Rubberband

   170

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

   171

   172

"""

   173

Class that implements a rubberband

   174

"""

   175

   176

class RubberBand:

   177

   178

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

   179

    def __init__(self, drawingSurface):

   180

        self.drawingSurface = drawingSurface

   181

        self.Reset()

   182

   183

    # Method that initializes the internal attributes of the rubberband

   184

    def Reset(self):

   185

        self.startPoint = None

   186

        self.currentBox = None

   187

        self.lastBox = None

   188

   189

    # Method that return if a box is currently edited

   190

    def IsShown(self):

   191

        return self.currentBox != None

   192

   193

    # Method that returns the currently edited box

   194

    def GetCurrentExtent(self):

   195

        return self.currentBox

   196

   197

    # Method called when a new box starts to be edited

   198

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

   199

        pos = GetScaledEventPosition(event, dc, scaling)

   200

        # Save the point for calculate the box position and size

   201

        self.startPoint = pos

   202

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

   203

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

   204

        self.Redraw()

   205

   206

    # Method called when dragging with a box edited

   207

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

   208

        pos = GetScaledEventPosition(event, dc, scaling)

   209

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

   210

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

   211

            self.currentBox.height)

   212

        # Calculate new position and size of the box 

   213

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

   214

            self.currentBox.x = self.startPoint.x

   215

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

   216

        else:

   217

            self.currentBox.x = pos.x

   218

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

   219

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

   220

            self.currentBox.y = self.startPoint.y

   221

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

   222

        else:

   223

            self.currentBox.y = pos.y

   224

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

   225

        self.Redraw()

   226

   227

    # Method called when dragging is stopped

   228

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

   229

        self.drawingSurface.SetCursor(wx.NullCursor)

   230

        self.lastBox = self.currentBox

   231

        self.currentBox = None

   232

        self.Redraw()

   233

   234

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

   235

    def Redraw(self, dc = None):

   236

        if not dc:

   237

            dc = self.drawingSurface.GetLogicalDC()

   238

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

   239

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   240

        dc.SetLogicalFunction(wx.XOR)

   241

        if self.lastBox:

   242

            # Erase last box

   243

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

   244

                self.lastBox.height)

   245

        if self.currentBox:

   246

            # Draw current box

   247

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

   248

                self.currentBox.height)

   249

   250

    # Erase last box

   251

    def Erase(self, dc = None):

   252

        if not dc:

   253

            dc = self.drawingSurface.GetLogicalDC()

   254

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

   255

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   256

        dc.SetLogicalFunction(wx.XOR)

   257

        if self.lastBox:

   258

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

   259

                self.lastBox.height)

   260

   261

    # Draw current box

   262

    def Draw(self, dc = None):

   263

        if not dc:

   264

            dc = self.drawingSurface.GetLogicalDC()

   265

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

   266

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   267

        dc.SetLogicalFunction(wx.XOR)

   268

        if self.currentBox:

   269

            # Draw current box

   270

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

   271

                self.currentBox.height)

   272

   273

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

   274

#                           Graphic element base class

   275

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

   276

   277

"""

   278

Class that implements a generic graphic element

   279

"""

   280

   281

class Graphic_Element:

   282

   283

    # Create a new graphic element

   284

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

   285

        self.Parent = parent

   286

        self.Id = id

   287

        self.oldPos = None

   288

        self.Handle = False

   289

        self.Dragging = False

   290

        self.Selected = False

   291

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

   292

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

   293

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

   294

        self.CurrentCursor = 0

   295

        ResetCursors()

   296

   297

    # Make a clone of this element

   298

    def Clone(self):

   299

        return Graphic_Element(self.Parent, self.Id)

   300

   301

    # Changes the block position

   302

    def SetPosition(self, x, y):

   303

        self.Pos.x = x

   304

        self.Pos.y = y

   305

        self.RefreshConnected()

   306

        self.RefreshBoundingBox()

   307

   308

    # Returns the block position

   309

    def GetPosition(self):

   310

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

   311

   312

    # Changes the element size

   313

    def SetSize(self, width, height):

   314

        self.Size.SetWidth(width)

   315

        self.Size.SetHeight(height)

   316

        self.RefreshConnectors()

   317

        self.RefreshBoundingBox()

   318

   319

    # Returns the element size

   320

    def GetSize(self):

   321

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

   322

   323

    # Refresh the element Bounding Box

   324

    def RefreshBoundingBox(self):

   325

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

   326

   327

    # Refresh the element connectors position

   328

    def RefreshConnectors(self):

   329

        pass

   330

   331

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

   332

    def RefreshConnected(self):

   333

        pass

   334

   335

    # Change the parent

   336

    def SetParent(self, parent):

   337

        self.Parent = parent

   338

   339

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

   340

    def Delete(self):

   341

        pass

   342

   343

    # Returns the Id

   344

    def GetId(self):

   345

        return self.Id

   346

   347

    # Returns if the point given is in the bounding box

   348

    def HitTest(self, pt):

   349

        rect = self.BoundingBox

   350

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

   351

   352

    # Returns if the point given is in the bounding box

   353

    def IsInSelection(self, rect):

   354

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

   355

   356

    # Override this method for refreshing the bounding box

   357

    def RefreshBoundingBox(self):

   358

        pass

   359

   360

    # Returns the bounding box

   361

    def GetBoundingBox(self):

   362

        return self.BoundingBox

   363

   364

    # Change the variable that indicates if this element is selected

   365

    def SetSelected(self, selected):

   366

        self.Selected = selected

   367

   368

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

   369

    def TestHandle(self, pt):

   370

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

   371

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

   372

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

   373

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

   374

        # Verify that this element is selected

   375

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

   376

            # Find if point is on a handle horizontally

   377

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

   378

                handle_x = 1

   379

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

   380

                handle_x = 2

   381

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

   382

                handle_x = 3

   383

            else:

   384

                handle_x = 0

   385

            # Find if point is on a handle vertically

   386

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

   387

                handle_y = 1

   388

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

   389

                handle_y = 2

   390

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

   391

                handle_y = 3

   392

            else:

   393

                handle_y = 0

   394

            # Verify that the result is valid

   395

            if (handle_x, handle_y) in VALID_HANDLES:

   396

                return handle_x, handle_y

   397

        return 0, 0

   398

   399

    # Method called when a LeftDown event have been generated

   400

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

   401

        pos = event.GetLogicalPosition(dc)

   402

        # Test if an handle have been clicked

   403

        handle = self.TestHandle(pos)

   404

        # Find which type of handle have been clicked,

   405

        # Save a resize event and change the cursor

   406

        cursor = HANDLE_CURSORS.get(handle, 1)

   407

        if cursor != self.CurrentCursor:

   408

            self.Parent.SetCursor(CURSORS[cursor])

   409

            self.CurrentCursor = cursor

   410

        if cursor > 1:

   411

            self.Handle = (HANDLE_RESIZE, handle)

   412

        else:

   413

            self.Handle = (HANDLE_MOVE, None)

   414

            self.SetSelected(False)

   415

        # Initializes the last position

   416

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

   417

   418

    # Method called when a LeftUp event have been generated

   419

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

   420

        # If a dragging have been initiated

   421

        if self.Dragging and self.oldPos:

   422

            # Calculate the movement of cursor and refreshes the element state

   423

            pos = GetScaledEventPosition(event, dc, scaling)

   424

            movex = pos.x - self.oldPos.x

   425

            movey = pos.y - self.oldPos.y

   426

            self.ProcessDragging(movex, movey)

   427

            self.RefreshModel()

   428

            self.Parent.RefreshBuffer()

   429

        if self.CurrentCursor != 0:

   430

            self.Parent.SetCursor(CURSORS[0])

   431

            self.CurrentCursor = 0

   432

        self.SetSelected(True)

   433

        self.oldPos = None

   434

   435

    # Method called when a RightUp event have been generated

   436

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

   437

        self.SetSelected(True)

   438

        self.oldPos = None

   439

   440

    # Method called when a LeftDClick event have been generated

   441

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

   442

        pass

   443

   444

    # Method called when a Motion event have been generated

   445

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

   446

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

   447

        if event.Dragging() and self.oldPos:

   448

            # Calculate the movement of cursor

   449

            pos = GetScaledEventPosition(event, dc, scaling)

   450

            movex = pos.x - self.oldPos.x

   451

            movey = pos.y - self.oldPos.y

   452

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

   453

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

   454

                self.Dragging = True

   455

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

   456

            if self.Dragging:

   457

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

   458

                self.oldPos.x += dragx

   459

                self.oldPos.y += dragy

   460

            return True

   461

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

   462

        else:

   463

            pos = event.GetLogicalPosition(dc)

   464

            handle = self.TestHandle(pos)

   465

            # Find which type of handle have been clicked,

   466

            # Save a resize event and change the cursor

   467

            cursor = HANDLE_CURSORS.get(handle, 0)

   468

            if cursor != self.CurrentCursor:

   469

                self.Parent.SetCursor(CURSORS[cursor])

   470

                self.CurrentCursor = cursor

   471

            return False

   472

   473

    # Moves the element

   474

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

   475

        self.Pos.x += dx

   476

        self.Pos.y += dy

   477

        self.RefreshConnected(exclude)

   478

        self.RefreshBoundingBox()

   479

   480

    # Resizes the element from position and size given

   481

    def Resize(self, x, y, width, height):

   482

        self.Move(x, y)

   483

        self.SetSize(width, height)

   484

   485

    # Refreshes the element state according to move defined and handle selected

   486

    def ProcessDragging(self, movex, movey):

   487

        handle_type, handle = self.Handle

   488

        # If it is a resize handle, calculate the values from resizing

   489

        if handle_type == HANDLE_RESIZE:

   490

            x = y = start_x = start_y = 0

   491

            width, height = start_width, start_height = self.GetSize()

   492

            if handle[0] == 1:

   493

                x = movex = max(-self.BoundingBox.x, movex)

   494

                width -= movex

   495

            elif handle[0] == 3:

   496

                width += movex

   497

            if handle[1] == 1:

   498

                y = movey = max(-self.BoundingBox.y, movey)

   499

                height -= movey

   500

            elif handle[1] == 3:

   501

                height += movey

   502

            # Verify that new size is not lesser than minimum

   503

            min_width, min_height = self.GetMinSize()

   504

            if handle[0] != 2 and (width >= min_width or width > self.Size[0]):

   505

                start_x = x

   506

                start_width = width

   507

            else:

   508

                movex = 0

   509

            if handle[1] != 2 and (height >= min_height or height > self.Size[1]):

   510

                start_y = y

   511

                start_height = height

   512

            else: