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

    27

from GraphicCommons import *

    28

from plcopen.structures import *

    29

    30

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

    31

#                         Ladder Diagram PowerRail

    32

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

    33

    34

"""

    35

Class that implements the graphic representation of a power rail

    36

"""

    37

    38

class LD_PowerRail(Graphic_Element):

    39

    40

    # Create a new power rail

    41

    def __init__(self, parent, type, id = None, connectors = [True]):

    42

        Graphic_Element.__init__(self, parent)

    43

        self.Type = None

    44

        self.Connectors = []

    45

        self.RealConnectors = None

    46

        self.Id = id

    47

        self.Extensions = [LD_LINE_SIZE / 2, LD_LINE_SIZE / 2]

    48

        if len(connectors) < 1:

    49

            connectors = [True]

    50

        self.SetType(type, connectors)

    51

    52

    # Destructor

    53

    def __del__(self):

    54

        self.Connectors = []

    55

    56

    # Make a clone of this LD_PowerRail

    57

    def Clone(self, parent, id = None, pos = None):

    58

        powerrail = LD_PowerRail(parent, self.Type, id)

    59

        powerrail.SetSize(self.Size[0], self.Size[1])

    60

        if pos is not None:

    61

            powerrail.SetPosition(pos.x, pos.y)

    62

        powerrail.Connectors = []

    63

        for connector in self.Connectors:

    64

            if connector is not None:

    65

                powerrail.Connectors.append(connector.Clone(powerrail))

    66

            else:

    67

                powerrail.Connectors.append(None)

    68

        return powerrail

    69

    70

    # Returns the RedrawRect

    71

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

    72

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

    73

        for connector in self.Connectors:

    74

            if connector is not None:

    75

                rect = rect.Union(connector.GetRedrawRect(movex, movey))

    76

        if movex != 0 or movey != 0:

    77

            for connector in self.Connectors:

    78

                if connector is not None and connector.IsConnected():

    79

                    rect = rect.Union(connector.GetConnectedRedrawRect(movex, movey))

    80

        return rect

    81

    82

    # Forbids to change the power rail size

    83

    def SetSize(self, width, height):

    84

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    85

            Graphic_Element.SetSize(self, width, height)

    86

            self.RefreshConnectors()

    87

    88

    # Forbids to select a power rail

    89

    def HitTest(self, pt):

    90

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    91

            return Graphic_Element.HitTest(self, pt) or self.TestConnector(pt, False) != None

    92

        return False

    93

    94

    # Forbids to select a power rail

    95

    def IsInSelection(self, rect):

    96

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    97

            return Graphic_Element.IsInSelection(self, rect)

    98

        return False

    99

   100

    # Deletes this power rail by calling the appropriate method

   101

    def Delete(self):

   102

        self.Parent.DeletePowerRail(self)

   103

   104

    # Unconnect all connectors

   105

    def Clean(self):

   106

        for connector in self.Connectors:

   107

            if connector:

   108

                connector.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   109

   110

    # Refresh the power rail bounding box

   111

    def RefreshBoundingBox(self):

   112

        dc = wx.ClientDC(self.Parent)

   113

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

   114

   115

    # Refresh the power rail size

   116

    def RefreshSize(self):

   117

        self.Size = wx.Size(LD_POWERRAIL_WIDTH, LD_LINE_SIZE * len(self.Connectors))

   118

        self.RefreshBoundingBox()

   119

   120

    # Returns the block minimum size

   121

    def GetMinSize(self):

   122

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   123

            return LD_POWERRAIL_WIDTH, self.Extensions[0] + self.Extensions[1]

   124

        else:

   125

            return LD_POWERRAIL_WIDTH, LD_LINE_SIZE * len(self.Connectors)

   126

   127

    # Add a connector or a blank to this power rail at the last place

   128

    def AddConnector(self, connector = True):

   129

        self.InsertConnector(len(self.Connectors), connector)

   130

   131

    # Add a connector or a blank to this power rail at the place given

   132

    def InsertConnector(self, idx, connector = True):

   133

        if connector:

   134

            if self.Type == LEFTRAIL:

   135

                connector = Connector(self, "", "BOOL", wx.Point(self.Size[0], 0), EAST)

   136

            elif self.Type == RIGHTRAIL:

   137

                connector = Connector(self, "", "BOOL", wx.Point(0, 0), WEST)

   138

            self.Connectors.insert(idx, connector)

   139

        else:

   140

            self.Connectors.insert(idx, None)

   141

        self.RefreshSize()

   142

        self.RefreshConnectors()

   143

   144

    # Moves the divergence connector given

   145

    def MoveConnector(self, connector, movey):

   146

        position = connector.GetRelPosition()

   147

        connector.SetPosition(wx.Point(position.x, position.y + movey))

   148

        miny = self.Size[1]

   149

        maxy = 0

   150

        for connect in self.Connectors:

   151

            connect_pos = connect.GetRelPosition()

   152

            miny = min(miny, connect_pos.y - self.Extensions[0])

   153

            maxy = max(maxy, connect_pos.y - self.Extensions[0])

   154

        min_pos = self.Pos.y + miny

   155

        self.Pos.y = min(min_pos, self.Pos.y)

   156

        if min_pos == self.Pos.y:

   157

            for connect in self.Connectors:

   158

                connect_pos = connect.GetRelPosition()

   159

                connect.SetPosition(wx.Point(connect_pos.x, connect_pos.y - miny))

   160

        self.Connectors.sort(lambda x, y: x.Pos.y.__cmp__(y.Pos.y))

   161

        maxy = 0

   162

        for connect in self.Connectors:

   163

            connect_pos = connect.GetRelPosition()

   164

            maxy = max(maxy, connect_pos.y)

   165

        self.Size[1] = max(maxy + self.Extensions[1], self.Size[1])

   166

        connector.MoveConnected()

   167

        self.RefreshBoundingBox()

   168

   169

    # Returns the index in connectors list for the connector given

   170

    def GetConnectorIndex(self, connector):

   171

        if connector in self.Connectors:

   172

            return self.Connectors.index(connector)

   173

        return None

   174

   175

    # Returns if there is a connector in connectors list at the index given

   176

    def IsNullConnector(self, idx):

   177

        if idx < len(self.Connectors):

   178

            return self.Connectors[idx] == None

   179

        return False

   180

   181

    # Delete the connector or blank from connectors list at the index given

   182

    def DeleteConnector(self, idx):

   183

        self.Connectors.pop(idx)

   184

        self.RefreshConnectors()

   185

        self.RefreshSize()

   186

   187

    # Refresh the positions of the power rail connectors

   188

    def RefreshConnectors(self):

   189

        scaling = self.Parent.GetScaling()

   190

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   191

            height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   192

            interval = float(height) / float(max(len(self.Connectors) - 1, 1))

   193

            for i, connector in enumerate(self.Connectors):

   194

                if self.RealConnectors:

   195

                    position = self.Extensions[0] + int(round(self.RealConnectors[i] * height))

   196

                else:

   197

                    position = self.Extensions[0] + int(round(i * interval))

   198

                if scaling is not None:

   199

                    position = round(float(self.Pos.y + position) / float(scaling[1])) * scaling[1] - self.Pos.y

   200

                if self.Type == LEFTRAIL:

   201

                    connector.SetPosition(wx.Point(self.Size[0], position))

   202

                elif self.Type == RIGHTRAIL:

   203

                    connector.SetPosition(wx.Point(0, position))

   204

        else:

   205

            position = self.Extensions[0]

   206

            for connector in self.Connectors:

   207

                if connector:

   208

                    if scaling is not None:

   209

                        ypos = round(float(self.Pos.y + position) / float(scaling[1])) * scaling[1] - self.Pos.y

   210

                    else:

   211

                        ypos = position

   212

                    if self.Type == LEFTRAIL:

   213

                        connector.SetPosition(wx.Point(self.Size[0], ypos))

   214

                    elif self.Type == RIGHTRAIL:

   215

                        connector.SetPosition(wx.Point(0, ypos))

   216

                position += LD_LINE_SIZE

   217

        self.RefreshConnected()

   218

   219

    # Refresh the position of wires connected to power rail

   220

    def RefreshConnected(self, exclude = []):

   221

        for connector in self.Connectors:

   222

            if connector:

   223

                connector.MoveConnected(exclude)

   224

   225

    # Returns the power rail connector that starts with the point given if it exists 

   226

    def GetConnector(self, position, name = None):

   227

        # if a name is given

   228

        if name:

   229

            # Test each connector if it exists

   230

            for connector in self.Connectors:

   231

                if connector and name == connector.GetName():

   232

                    return connector

   233

        for connector in self.Connectors:

   234

            if connector:

   235

                connector_pos = connector.GetRelPosition()

   236

                if position.x == self.Pos.x + connector_pos.x and position.y == self.Pos.y + connector_pos.y:

   237

                    return connector

   238

        return None

   239

   240

    # Returns all the power rail connectors 

   241

    def GetConnectors(self):

   242

        return [connector for connector in self.Connectors if connector]

   243

   244

    # Test if point given is on one of the power rail connectors

   245

    def TestConnector(self, pt, exclude=True):

   246

        for connector in self.Connectors:

   247

            if connector and connector.TestPoint(pt, exclude):

   248

                return connector

   249

        return None

   250

   251

    # Returns the power rail type

   252

    def SetType(self, type, connectors):

   253

        if type != self.Type or len(self.Connectors) != len(connectors):

   254

            # Create a connector or a blank according to 'connectors' and add it in

   255

            # the connectors list

   256

            self.Type = type

   257

            self.Clean()

   258

            self.Connectors = []

   259

            for connector in connectors:

   260

                self.AddConnector(connector)

   261

            self.RefreshSize()

   262

   263

    # Returns the power rail type

   264

    def GetType(self):

   265

        return self.Type

   266

   267

    # Method called when a LeftDown event have been generated

   268

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

   269

        self.RealConnectors = []

   270

        height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   271

        for connector in self.Connectors:

   272

            position = connector.GetRelPosition()

   273

            self.RealConnectors.append(float(position.y - self.Extensions[0])/float(max(1, height)))

   274

        Graphic_Element.OnLeftDown(self, event, dc, scaling)

   275

   276

    # Method called when a LeftUp event have been generated

   277

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

   278

        Graphic_Element.OnLeftUp(self, event, dc, scaling)

   279

        self.RealConnectors = None

   280

   281

    # Method called when a LeftDown event have been generated

   282

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

   283

        pos = GetScaledEventPosition(event, dc, scaling)

   284

        # Test if a connector have been handled

   285

        connector = self.TestConnector(pos, False)

   286

        if connector:

   287

            self.Handle = (HANDLE_CONNECTOR, connector)

   288

            self.Parent.SetCursor(wx.StockCursor(wx.CURSOR_HAND))

   289

            self.Selected = False

   290

            # Initializes the last position

   291

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

   292

        else:

   293

            Graphic_Element.OnRightDown(self, event, dc, scaling)

   294

   295

    # Method called when a LeftDClick event have been generated

   296

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

   297

        # Edit the powerrail properties

   298

        self.Parent.EditPowerRailContent(self)

   299

   300

    # Method called when a RightUp event have been generated

   301

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

   302

        handle_type, handle = self.Handle

   303

        if handle_type == HANDLE_CONNECTOR:

   304

            wires = handle.GetWires()

   305

            if len(wires) == 1:

   306

                if handle == wires[0][0].StartConnected:

   307

                    block = wires[0][0].EndConnected.GetParentBlock()

   308

                else:

   309

                    block = wires[0][0].StartConnected.GetParentBlock()

   310

                block.RefreshModel(False)

   311

            Graphic_Element.OnRightUp(self, event, dc, scaling)

   312

        else:

   313

            self.Parent.PopupDefaultMenu()

   314

   315

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

   316

    def ProcessDragging(self, movex, movey, scaling):

   317

        handle_type, handle = self.Handle

   318

        # A connector has been handled

   319

        if handle_type == HANDLE_CONNECTOR:

   320

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

   321

            if scaling is not None:

   322

                position = handle.GetRelPosition()

   323

                movey = round(float(self.Pos.y + position.y + movey) / float(scaling[1])) * scaling[1] - self.Pos.y - position.y

   324

            self.MoveConnector(handle, movey)

   325

            return 0, movey

   326

        else:

   327

            return Graphic_Element.ProcessDragging(self, movex, movey, scaling)

   328

   329

    # Refreshes the power rail model

   330

    def RefreshModel(self, move=True):

   331

        self.Parent.RefreshPowerRailModel(self)

   332

        # If power rail has moved and power rail is of type LEFT, refresh the model 

   333

        # of wires connected to connectors

   334

        if move and self.Type == LEFTRAIL:

   335

            for connector in self.Connectors:

   336

                if connector:

   337

                    connector.RefreshWires()

   338

   339

    # Draws power rail

   340

    def Draw(self, dc):

   341

        Graphic_Element.Draw(self, dc)

   342

        dc.SetPen(wx.BLACK_PEN)

   343

        dc.SetBrush(wx.BLACK_BRUSH)

   344

        # Draw a rectangle with the power rail size

   345

        dc.DrawRectangle(self.Pos.x, self.Pos.y, self.Size[0] + 1, self.Size[1] + 1)

   346

        # Draw connectors

   347

        for connector in self.Connectors:

   348

            if connector:

   349

                connector.Draw(dc)

   350

   351

   352

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

   353

#                         Ladder Diagram Contact

   354

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

   355

   356

"""

   357

Class that implements the graphic representation of a contact

   358

"""

   359

   360

class LD_Contact(Graphic_Element):

   361

   362

    # Create a new contact

   363

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

   364

        Graphic_Element.__init__(self, parent)

   365

        self.Type = type

   366

        self.Name = name

   367

        self.Id = id

   368

        self.Size = wx.Size(LD_ELEMENT_SIZE[0], LD_ELEMENT_SIZE[1])

   369

        # Create an input and output connector

   370

        self.Input = Connector(self, "", "BOOL", wx.Point(0, self.Size[1] / 2 + 1), WEST)

   371

        self.Output = Connector(self, "", "BOOL", wx.Point(self.Size[0], self.Size[1] / 2 + 1), EAST)

   372

        self.RefreshNameSize()

   373

        self.RefreshTypeSize()

   374

   375

    # Destructor

   376

    def __del__(self):

   377

        self.Input = None

   378

        self.Output = None

   379

   380

    # Make a clone of this LD_Contact

   381

    def Clone(self, parent, id = None, pos = None):

   382

        contact = LD_Contact(parent, self.Type, self.Name, id)

   383

        contact.SetSize(self.Size[0], self.Size[1])

   384

        if pos is not None:

   385

            contact.SetPosition(pos.x, pos.y)

   386

        contact.Input = self.Input.Clone(contact)

   387

        contact.Output = self.Output.Clone(contact)

   388

        return contact

   389

   390

    # Returns the RedrawRect

   391

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

   392

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

   393

        rect = rect.Union(self.Input.GetRedrawRect(movex, movey))

   394

        rect = rect.Union(self.Output.GetRedrawRect(movex, movey))

   395

        if movex != 0 or movey != 0:

   396

            if self.Input.IsConnected():

   397

                rect = rect.Union(self.Input.GetConnectedRedrawRect(movex, movey))

   398

            if self.Output.IsConnected():

   399

                rect = rect.Union(self.Output.GetConnectedRedrawRect(movex, movey))

   400

        return rect

   401

   402

    # Forbids to change the contact size

   403

    def SetSize(self, width, height):

   404

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   405

            Graphic_Element.SetSize(self, width, height)

   406

            self.RefreshConnectors()

   407

   408

    # Delete this contact by calling the appropriate method

   409

    def Delete(self):

   410

        self.Parent.DeleteContact(self)

   411

   412

    # Unconnect input and output

   413

    def Clean(self):

   414

        self.Input.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   415

        self.Output.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   416

   417

    # Refresh the size of text for name

   418

    def RefreshNameSize(self):

   419

        dc = wx.ClientDC(self.Parent)

   420

        if self.Name != "":

   421

            self.NameSize = dc.GetTextExtent(self.Name)

   422

        else:

   423

            self.NameSize = 0, 0

   424

   425

    # Refresh the size of text for type

   426

    def RefreshTypeSize(self):

   427

        dc = wx.ClientDC(self.Parent)

   428

        typetext = ""

   429

        if self.Type == CONTACT_REVERSE:

   430

            typetext = "/"

   431

        elif self.Type == CONTACT_RISING:

   432

            typetext = "P"

   433

        elif self.Type == CONTACT_FALLING:

   434

            typetext = "N"

   435

        if typetext != "":

   436

            self.TypeSize = dc.GetTextExtent(typetext)

   437

        else:

   438

            self.TypeSize = 0, 0

   439

   440

    # Refresh the contact bounding box

   441

    def RefreshBoundingBox(self):

   442

        dc = wx.ClientDC(self.Parent)

   443

        # Calculate the size of the name outside the contact

   444

        text_width, text_height = dc.GetTextExtent(self.Name)

   445

        # Calculate the bounding box size

   446

        if self.Name != "":

   447

            bbx_x = self.Pos.x - max(0, (text_width - self.Size[0]) / 2)

   448

            bbx_width = max(self.Size[0], text_width)

   449

            bbx_y = self.Pos.y - (text_height + 2)

   450

            bbx_height = self.Size[1] + (text_height + 2)

   451

        else:

   452

            bbx_x = self.Pos.x

   453

            bbx_width = self.Size[0]

   454

            bbx_y = self.Pos.y

   455

            bbx_height = self.Size[1]

   456

        self.BoundingBox = wx.Rect(bbx_x, bbx_y, bbx_width + 1, bbx_height + 1)

   457

   458

    # Returns the block minimum size

   459

    def GetMinSize(self):

   460

        return LD_ELEMENT_SIZE

   461

   462

    # Refresh the position of wire connected to contact

   463

    def RefreshConnected(self, exclude = []):

   464

        self.Input.MoveConnected(exclude)

   465

        self.Output.MoveConnected(exclude)

   466

   467

    # Returns the contact connector that starts with the point given if it exists 

   468

    def GetConnector(self, position, name = None):

   469

        # if a name is given

   470

        if name:

   471

            # Test input and output connector

   472

            if name == self.Input.GetName():

   473

                return self.Input

   474

            if name == self.Output.GetName():

   475

                return self.Output

   476

        # Test input connector

   477

        input_pos = self.Input.GetRelPosition()

   478

        if position.x == self.Pos.x + input_pos.x and position.y == self.Pos.y + input_pos.y:

   479

            return self.Input

   480

        # Test output connector

   481

        output_pos = self.Output.GetRelPosition()

   482

        if position.x == self.Pos.x + output_pos.x and position.y == self.Pos.y + output_pos.y:

   483

            return self.Output

   484

        return None

   485

   486

    # Returns input and output contact connectors 

   487

    def GetConnectors(self):

   488

        return {"input":self.Input,"output":self.Output}

   489

   490

    # Test if point given is on contact input or output connector

   491

    def TestConnector(self, pt, exclude=True):

   492

        # Test input connector

   493

        if self.Input.TestPoint(pt, exclude):

   494

            return self.Input

   495

        # Test output connector

   496

        if self.Output.TestPoint(pt, exclude):

   497

            return self.Output

   498

        return None

   499

   500

    # Refresh the positions of the block connectors

   501

    def RefreshConnectors(self):

   502

        scaling = self.Parent.GetScaling()