wire.h

Go to the documentation of this file.

/*
  @copyright Steve Keen 2015
  @author Russell Standish
  This file is part of Minsky.

  Minsky is free software: you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  Minsky is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with Minsky.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef WIRE_H
#define WIRE_H

#include "noteBase.h"
#include "intrusiveMap.h"

#include <error.h>
#include <arrays.h>
#include <TCL_obj_base.h>
#include <accessor.h>
#include "classdesc_access.h"
#include <cairo.h>

namespace minsky
{
  class Wire;
  class Port;
  class Group;
  class Item;
  struct Units;
  using ecolab::error;
  
  struct WireAccessor: public ecolab::TCLAccessor<Wire, std::vector<float>> {WireAccessor();};
  
  class Wire: public NoteBase, public WireAccessor
  {
    CLASSDESC_ACCESS(Wire);
    friend struct SchemaHelper;

    // intermediate control point coords, relative to ports
    std::vector<float> m_coords;
    std::weak_ptr<Port> m_from, m_to;

    constexpr static float handleRadius=3;
    mutable int unitsCtr=0; 
    mutable std::vector<std::pair<float,float>> cairoCoords; 
  public:

    Wire() {}
    Wire(const std::weak_ptr<Port>& from, const std::weak_ptr<Port>& to, 
         const std::vector<float>& a_coords=std::vector<float>()); 
   ~Wire();

    std::shared_ptr<Port> from() const {return m_from.lock();}
    std::shared_ptr<Port> to() const {return m_to.lock();}

    void moveToPorts(const std::shared_ptr<Port>& from, const std::shared_ptr<Port>& to);
    void storeCairoCoords(cairo_t* cairo) const;
    
    void draw(cairo_t* cairo, bool reverseArrow=false) const;
    
    std::vector<float> coords() const;
    std::vector<float> coords(const std::vector<float>& coords);

#undef near
    bool near(float x, float y) const;
    unsigned nearestHandle(float x, float y);
    void insertHandle(unsigned position, float x, float y);
    // For ticket 1092. Reinstate delete handle user interaction
    void deleteHandle(float x, float y);    
    void editHandle(unsigned position, float x, float y);
    
    void straighten() {m_coords.clear();}

    bool visible() const;
    void moveIntoGroup(Group& dest);
    void split();
    Units units(bool) const;
  };

  typedef std::shared_ptr<Wire> WirePtr;
  typedef std::vector<WirePtr> Wires;

}

#ifdef CLASSDESC
// omit these, because weak/shared pointers cause problems, and its
// not needed anyway
#pragma omit pack minsky::Wire
#pragma omit unpack minsky::Wire
#endif
namespace classdesc_access
{
template <> struct access_pack<minsky::Wire>: 
  public classdesc::NullDescriptor<classdesc::pack_t> {};
template <> struct access_unpack<minsky::Wire>: 
  public classdesc::NullDescriptor<classdesc::unpack_t> {};
}
#include "wire.cd"
#include "wire.xcd"
#endif