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): 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

#Lesser 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

from wxPython.wx import *

    26

import wx

    27

from math import *

    28

    29

    30

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

    31

#                               Common constants

    32

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

    33

    34

"""

    35

Definition of constants for dimensions of graphic elements

    36

"""

    37

    38

# FBD and SFC constants

    39

MIN_MOVE = 5            # Minimum move before starting a element dragging

    40

CONNECTOR_SIZE = 8      # Size of connectors

    41

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

    42

HANDLE_SIZE = 6         # Size of the squares for handles

    43

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

    44

POINT_RADIUS = 2        # Radius of the point of wire ends

    45

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

    46

    47

# LD constants

    48

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

    49

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

    50

LD_WIRE_SIZE = 30                   # Size of a wire between two contact

    51

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

    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

    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, MODE_WIRE,

    89

    90

"""

    91

Basic vector operations for calculate wire points

    92

"""

    93

    94

# Calculate the scalar product of two vectors

    95

def product(v1, v2):

    96

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

    97

    98

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

    99

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

   100

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

   101

    if normal:

   102

        return normalize(vector)

   103

    return vector

   104

   105

# Calculate the norm of a given vector

   106

def norm(v):

   107

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

   108

   109

# Normalize a given vector

   110

def normalize(v):

   111

    v_norm = norm(v)

   112

    # Verifie if it is not a null vector

   113

    if v_norm > 0:

   114

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

   115

    else:

   116

        return v

   117

   118

   119

"""

   120

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

   121

"""

   122

   125

    if scaling:

   126

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

   127

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

   128

    return pos

   129

   130

   131

"""

   132

Function that choose a direction during the wire points generation

   133

"""

   134

   135

def DirectionChoice(v_base, v_target, dir_target):

   136

    dir_product = product(v_base, v_target)

   137

    if dir_product < 0:

   138

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

   139

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

   140

        return dir_target

   141

    return v_base

   142

   143

   144

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

   145

#                               Viewer Rubberband

   146

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

   147

   148

"""

   149

Class that implements a rubberband

   150

"""

   151

   152

class RubberBand:

   153

   154

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

   155

    def __init__(self, drawingSurface):

   156

        self.drawingSurface = drawingSurface

   157

        self.Reset()

   158

   159

    # Method that initializes the internal attributes of the rubberband

   160

    def Reset(self):

   161

        self.startPoint = None

   162

        self.currentBox = None

   163

        self.lastBox = None

   164

   165

    # Method that return if a box is currently edited

   166

    def IsShown(self):

   167

        return self.currentBox != None

   168

   169

    # Method that returns the currently edited box

   170

    def GetCurrentExtent(self):

   171

        return self.currentBox

   172

   173

    # Method called when a new box starts to be edited

   176

        # Save the point for calculate the box position and size

   177

        self.startPoint = pos

   178

        self.currentBox = wxRect(pos.x, pos.y, 0, 0)

   179

        self.drawingSurface.SetCursor(wxStockCursor(wxCURSOR_CROSS))

   180

        self.Redraw()

   181

   182

    # Method called when dragging with a box edited

   185

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

   186

        self.lastBox = wxRect(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   187

            self.currentBox.height)

   188

        # Calculate new position and size of the box 

   189

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

   190

            self.currentBox.x = self.startPoint.x

   191

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

   192

        else:

   193

            self.currentBox.x = pos.x

   194

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

   195

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

   196

            self.currentBox.y = self.startPoint.y

   197

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

   198

        else:

   199

            self.currentBox.y = pos.y

   200

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

   201

        self.Redraw()

   202

   203

    # Method called when dragging is stopped

   205

        self.drawingSurface.SetCursor(wxNullCursor)

   206

        self.lastBox = self.currentBox

   207

        self.currentBox = None

   208

        self.Redraw()

   209

   210

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

   211

    def Redraw(self):

   213

        dc.SetPen(wxPen(wxWHITE, 1, wxDOT))

   214

        dc.SetBrush(wxTRANSPARENT_BRUSH)

   215

        dc.SetLogicalFunction(wxXOR)

   216

        if self.lastBox:

   217

            # Erase last box

   218

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

   219

                self.lastBox.height)

   220

        if self.currentBox:

   221

            # Draw current box

   222

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

   223

                self.currentBox.height)

   224

   246

   247

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

   248

#                           Graphic element base class

   249

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

   250

   251

"""

   252

Class that implements a generic graphic element

   253

"""

   254

   255

class Graphic_Element:

   256

   257

    # Create a new graphic element

   258

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

   259

        self.Parent = parent

   260

        self.Id = id

   261

        self.oldPos = None

   262

        self.Handle = False

   263

        self.Dragging = False

   264

        self.Selected = False

   265

        self.Pos = wxPoint(0, 0)

   266

        self.Size = wxSize(0, 0)

   267

        self.BoundingBox = wxRect(0, 0, 0, 0)

   268

   269

    # Make a clone of this element

   270

    def Clone(self):

   271

        return Graphic_Element(self.Parent, self.Id)

   272

   273

    # Changes the block position

   274

    def SetPosition(self, x, y):

   275

        self.Pos.x = x

   276

        self.Pos.y = y

   277

        self.RefreshConnected()

   278

        self.RefreshBoundingBox()

   279

   280

    # Returns the block position

   281

    def GetPosition(self):

   282

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

   283

   284

    # Changes the element size

   285

    def SetSize(self, width, height):

   286

        self.Size.SetWidth(width)

   287

        self.Size.SetHeight(height)

   288

        self.RefreshConnectors()

   289

        self.RefreshBoundingBox()

   290

   291

    # Returns the element size

   292

    def GetSize(self):

   293

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

   294

   295

    # Refresh the element Bounding Box

   296

    def RefreshBoundingBox(self):

   297

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

   298

   299

    # Refresh the element connectors position

   300

    def RefreshConnectors(self):

   301

        pass

   302

   303

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

   304

    def RefreshConnected(self):

   305

        pass

   306

   307

    # Change the parent

   308

    def SetParent(self, parent):

   309

        self.Parent = parent

   310

   311

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

   312

    def Delete(self):

   313

        pass

   314

   315

    # Returns the Id

   316

    def GetId(self):

   317

        return self.Id

   318

   319

    # Returns if the point given is in the bounding box

   320

    def HitTest(self, pt):

   321

        rect = self.BoundingBox

   322

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

   323

   324

    # Override this method for refreshing the bounding box

   325

    def RefreshBoundingBox(self):

   326

        pass

   327

   328

    # Returns the bounding box

   329

    def GetBoundingBox(self):

   330

        return self.BoundingBox

   331

   332

    # Change the variable that indicates if this element is selected

   333

    def SetSelected(self, selected):

   334

        self.Selected = selected

   335

   336

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

   337

    def TestHandle(self, pt):

   338

        # Verify that this element is selected

   339

        if self.Selected:

   340

            # Find if point is on a handle horizontally

   341

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

   342

                handle_x = 1

   343

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

   344

                handle_x = 2

   345

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

   346

                handle_x = 3

   347

            else:

   348

                handle_x = 0

   349

            # Find if point is on a handle vertically

   350

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

   351

                handle_y = 1

   352

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

   353

                handle_y = 2

   354

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

   355

                handle_y = 3

   356

            else:

   357

                handle_y = 0

   358

            # Verify that the result is valid

   359

            if (handle_x, handle_y) in VALID_HANDLES:

   360

                return handle_x, handle_y

   361

        return 0, 0

   362

   363

    # Method called when a LeftDown event have been generated

   366

        # Test if an handle have been clicked

   367

        result = self.TestHandle(pos)

   368

        # Find which type of handle have been clicked,

   369

        # Save a resize event and change the cursor

   370

        if result == (1, 1) or result == (3, 3):

   371

            self.Handle = (HANDLE_RESIZE, result)

   372

            self.Parent.SetCursor(wxStockCursor(wxCURSOR_SIZENWSE))

   373

        elif result == (1, 3) or result == (3, 1):

   374

            self.Handle = (HANDLE_RESIZE, result)

   375

            self.Parent.SetCursor(wxStockCursor(wxCURSOR_SIZENESW))

   376

        elif result == (1, 2) or result == (3, 2):

   377

            self.Handle = (HANDLE_RESIZE, result)

   378

            self.Parent.SetCursor(wxStockCursor(wxCURSOR_SIZEWE))

   379

        elif result == (2, 1) or result == (2, 3):

   380

            self.Handle = (HANDLE_RESIZE, result)

   381

            self.Parent.SetCursor(wxStockCursor(wxCURSOR_SIZENS))

   382

        # If no handle have been clicked, save a move event, and change the cursor

   383

        else:

   384

            self.Handle = (HANDLE_MOVE, None)

   385

            self.Parent.SetCursor(wxStockCursor(wxCURSOR_HAND))

   386

            self.SetSelected(False)

   387

        # Initializes the last position

   389

   390

    # Method called when a LeftUp event have been generated

   392

        # If a dragging have been initiated

   393

        if self.Dragging and self.oldPos:

   394

            # Calculate the movement of cursor and refreshes the element state

   396

            movex = pos.x - self.oldPos.x

   397

            movey = pos.y - self.oldPos.y

   398

            self.ProcessDragging(movex, movey)

   399

            self.RefreshModel()

   400

        self.SetSelected(True)

   401

        self.oldPos = None

   402

   403

    # Method called when a RightUp event have been generated

   405

        self.SetSelected(True)

   406

        self.oldPos = None

   407

   408

    # Method called when a LeftDClick event have been generated

   410

        pass

   411

   412

    # Method called when a Motion event have been generated

   414

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

   415

        if event.Dragging() and self.oldPos:

   416

            # Calculate the movement of cursor

   418

            movex = pos.x - self.oldPos.x

   419

            movey = pos.y - self.oldPos.y

   420

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

   421

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

   422

                self.Dragging = True

   423

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

   424

            if self.Dragging:

   425

                self.oldPos = pos

   426

                self.ProcessDragging(movex, movey)

   427

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

   428

        else:

   430

            handle = self.TestHandle(pos)

   431

            if handle == (1, 1) or handle == (3, 3):

   432

                wxCallAfter(self.Parent.SetCursor, wxStockCursor(wxCURSOR_SIZENWSE))

   433

            elif handle == (1, 3) or handle == (3, 1):

   434

                wxCallAfter(self.Parent.SetCursor, wxStockCursor(wxCURSOR_SIZENESW))

   435

            elif handle == (1, 2) or handle == (3, 2):

   436

                wxCallAfter(self.Parent.SetCursor, wxStockCursor(wxCURSOR_SIZEWE))

   437

            elif handle == (2, 1) or handle == (2, 3):

   438

                wxCallAfter(self.Parent.SetCursor, wxStockCursor(wxCURSOR_SIZENS))

   439

            else:

   440

                wxCallAfter(self.Parent.SetCursor, wxNullCursor)

   441

   442

    # Moves the element

   443

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

   444

        self.Pos.x += dx

   445

        self.Pos.y += dy

   446

        self.RefreshConnected(exclude)

   447

        self.RefreshBoundingBox()

   448

   449

    # Resizes the element from position and size given

   450

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

   451

        self.Move(x, y)

   452

        self.SetSize(width, height)

   453

   454

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

   455

    def ProcessDragging(self, movex, movey):

   456

        handle_type, handle = self.Handle

   457

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

   458

        if handle_type == HANDLE_RESIZE:

   459

            x, y = 0, 0

   460

            width, height = self.GetSize()

   461

            if handle[0] == 1:

   462

                x = movex

   463

                width -= movex

   464

            elif handle[0] == 3:

   465

                width += movex

   466

            if handle[1] == 1:

   467

                y = movey

   468

                height -= movey

   469

            elif handle[1] == 3:

   470

                height += movey

   471

            # Verify that new size is not lesser than minimum

   472

            min_width, min_height = self.GetMinSize()

   473

            if width >= min_width and height >= min_height:

   474

                self.Resize(x, y, width, height)

   475

        # If it is a move handle, Move this element

   476

        elif handle_type == HANDLE_MOVE:

   477

            self.Move(movex, movey)

   478

   479

    # Override this method for defining the method to call for refreshing the model of this element

   480

    def RefreshModel(self, move=True):

   481

        pass

   482

   483

    # Draws the handles of this element if it is selected

   484

    def Draw(self, dc):

   485

        if self.Selected:

   486

            dc.SetPen(wxBLACK_PEN)

   487

            dc.SetBrush(wxBLACK_BRUSH)

   488

            dc.DrawRectangle(self.BoundingBox.x - HANDLE_SIZE - 2, self.BoundingBox.y - HANDLE_SIZE - 2, HANDLE_SIZE, HANDLE_SIZE)

   489

            dc.DrawRectangle(self.BoundingBox.x + (self.BoundingBox.width - HANDLE_SIZE) / 2,

   490

                self.BoundingBox.y - HANDLE_SIZE - 2, HANDLE_SIZE, HANDLE_SIZE)

   491

            dc.DrawRectangle(self.BoundingBox.x + self.BoundingBox.width + 2, 

   492

                self.BoundingBox.y - HANDLE_SIZE - 2, HANDLE_SIZE, HANDLE_SIZE)

   493

            dc.DrawRectangle(self.BoundingBox.x + self.BoundingBox.width + 2, 

   494

                self.BoundingBox.y + (self.BoundingBox.height - HANDLE_SIZE) / 2, HANDLE_SIZE, HANDLE_SIZE)

   495

            dc.DrawRectangle(self.BoundingBox.x + self.BoundingBox.width + 2, 

   496

                self.BoundingBox.y + self.BoundingBox.height + 2, HANDLE_SIZE, HANDLE_SIZE)

   497

            dc.DrawRectangle(self.BoundingBox.x + (self.BoundingBox.width - HANDLE_SIZE) / 2, 

   498

                self.BoundingBox.y + self.BoundingBox.height + 2, HANDLE_SIZE, HANDLE_SIZE)

   499

            dc.DrawRectangle(self.BoundingBox.x - HANDLE_SIZE - 2, self.BoundingBox.y + self.BoundingBox.height + 2, HANDLE_SIZE, HANDLE_SIZE)

   500

            dc.DrawRectangle(self.BoundingBox.x - HANDLE_SIZE - 2, self.BoundingBox.y + (self.BoundingBox.height - HANDLE_SIZE) / 2, HANDLE_SIZE, HANDLE_SIZE)

   501

            dc.SetBrush(wxWHITE_BRUSH)

   502

   503

   504

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

   505

#                           Group of graphic elements

   506

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

   507

   508

"""

   509

Class that implements a group of graphic elements

   510

"""

   511

   512

class Graphic_Group(Graphic_Element):

   513

   514

    # Create a new group of graphic elements

   515

    def __init__(self, parent):

   516

        Graphic_Element.__init__(self, parent)

   517

        self.Elements = []

   518

        self.RefreshBoundingBox()

   519

   520

    # Destructor

   521

    def __del__(self):

   522

        self.Elements = []

   523

   524