wxruby3-shapes 0.9.0.pre.beta.3 → 0.9.6

data/lib/wx/shapes/shape.rb

@@ -2,6 +2,7 @@
 # Copyright (c) M.J.N. Corino, The Netherlands
 
 require 'wx/shapes/serializable'
+require 'wx/shapes/shapes/manager_shape'
 
 require 'set'
 
@@ -29,15 +30,16 @@ module Wx::SF
   # mostly triggered by a parent shape canvas.
   class Shape
 
-    include Serializable
+    include FIRM::Serializable
 
-    property :id, :active, :visibility, :style,
+    property :active, :visibility, :style,
              :accepted_children, :accepted_connections,
              :accepted_src_neighbours, :accepted_trg_neighbours,
-             :hover_colour, :relative_position,
+             :relative_position,
              :h_align, :v_align, :h_border, :v_border,
              :custom_dock_point, :connection_points,
              :user_data
+    property({ hover_colour: :serialize_hover_colour }, optional: true)
     property child_shapes: :serialize_child_shapes
 
     class SEARCHMODE < Wx::Enum
@@ -102,8 +104,10 @@ module Wx::SF
       HIGHLIGHTING = self.new(16)
       # Shape is always inside its parent
       ALWAYS_INSIDE = self.new(32)
-      # User data is destroyed at the shape deletion
-      DELETE_USER_DATA = self.new(64)
+      # Shape is not drawn. Does not apply to children.
+      # Should be combined with PROPAGATE_DRAGGING | PROPAGATE_SELECTION | PROPAGATE_INTERACTIVE_CONNECTION | PROPAGATE_HOVERING | PROPAGATE_HIGHLIGHTING | PROPAGATE_DROPPING
+      # in most cases.
+      NOT_DRAWN = self.new(64)
       # The DEL key is processed by the shape (not by the shape canvas)
       PROCESS_DEL = self.new(128)
       # Show handles if the shape is selected
@@ -124,21 +128,26 @@ module Wx::SF
       NO_FIT_TO_CHILDREN = self.new(32768)
       # Propagate hovering to parent.
       PROPAGATE_HOVERING = self.new(65536)
-      # Propagate hovering to parent.
+      # Propagate highlighting to parent.
       PROPAGATE_HIGHLIGHTING = self.new(131072)
+      # Propagate dropping to parent.
+      PROPAGATE_DROPPING = self.new(262144)
       # Default shape style
-      DEFAULT_SHAPE_STYLE = PARENT_CHANGE | POSITION_CHANGE | SIZE_CHANGE | HOVERING | HIGHLIGHTING | SHOW_HANDLES | ALWAYS_INSIDE | DELETE_USER_DATA
+      DEFAULT_SHAPE_STYLE = PARENT_CHANGE | POSITION_CHANGE | SIZE_CHANGE | HOVERING | HIGHLIGHTING | SHOW_HANDLES | ALWAYS_INSIDE
+      # Shortcut for all propagation options
+      PROPAGATE_ALL = PROPAGATE_DRAGGING | PROPAGATE_SELECTION | PROPAGATE_INTERACTIVE_CONNECTION | PROPAGATE_HOVERING | PROPAGATE_HIGHLIGHTING | PROPAGATE_DROPPING
     end
 
     # Default values
     module DEFAULT
+      class << self
+        # Default value of Wx::SF::Shape @hoverColor data member
+        def hover_colour; Wx::Colour.new(120, 120, 255); end
+      end
       # Default value of Wx::SF::Shape @visible data member
       VISIBILITY = true
       # Default value of Wx::SF::Shape @active data member
       ACTIVITY = true
-      # Default value of Wx::SF::Shape @hoverColor data member
-      HOVERCOLOUR = Wx::Colour.new(120, 120, 255) if Wx::App.is_main_loop_running
-      Wx.add_delayed_constant(self, :HOVERCOLOUR) { Wx::Colour.new(120, 120, 255) }
       # Default value of Wx::SF::Shape @relativePosition data member
       POSITION = Wx::RealPoint.new(0, 0)
       # Default value of Wx::SF::Shape @vAlign data member
@@ -172,7 +181,7 @@ module Wx::SF
     # @overload component(hash)
     #   Specifies one or more serialized component properties with associated setter/getter method ids/procs/lambda-s.
     #   @example
-    #     property(
+    #     component(
     #       prop_a: ->(obj, *val) {
     #                 obj.my_prop_a_setter(val.first) unless val.empty?
     #                 obj.my_prop_a_getter
@@ -227,35 +236,24 @@ module Wx::SF
             protected :from_serialized
           end
           include ComponentSerializerMethods
-          __CODE
+        __CODE
       end
     end
 
-    # @overload initialize()
-    #   default constructor
-    # @overload initialize(pos, manager)
-    #   @param [Wx::RealPoint] pos Initial relative position
-    #   @param [Diagram] diagram containing diagram
-    def initialize(*args)
-      pos, diagram = args
+    # Constructor
+    # @param [Wx::RealPoint, Wx::Point] pos Initial relative position
+    # @param [Diagram] diagram containing diagram
+    def initialize(pos = DEFAULT::POSITION, diagram: nil)
       ::Kernel.raise ArgumentError, "Invalid arguments pos: #{pos}, diagram: #{diagram}" unless
-        args.empty? || (Wx::RealPoint === pos && (diagram.nil? || Wx::SF::Diagram === diagram))
+        Wx::RealPoint === pos && (diagram.nil? || Wx::SF::Diagram === diagram)
 
-      @id = Serializable::ID.new
       @diagram = diagram
       @parent_shape = nil
       @child_shapes = ShapeList.new
       @components = ::Set.new
 
-      if @diagram
-        if @diagram.shape_canvas
-          @hover_color = @diagram.shape_canvas.hover_colour
-        else
-          @hover_color = DEFAULT::HOVERCOLOUR;
-        end
-      else
-        @hover_color = DEFAULT::HOVERCOLOUR;
-      end
+      # by default the common canvas hover colour will be used
+      @hover_color = nil
 
       @selected = false
       @mouse_over = false
@@ -273,11 +271,7 @@ module Wx::SF
       @h_border = DEFAULT::HBORDER
       @custom_dock_point = DEFAULT::DOCK_POINT
 
-      if pos && get_parent_shape
-        @relative_position = pos.to_real_point - get_parent_absolute_position
-      else
-        @relative_position = DEFAULT::POSITION.dup
-      end
+      @relative_position = Wx::RealPoint === pos ? pos.dup : pos.to_real_point
 
       @handles = []
       @connection_pts = []
@@ -288,20 +282,6 @@ module Wx::SF
       @accepted_trg_neighbours = ::Set.new
     end
 
-    # Get the shape's id
-    # @return [Wx::SF::Serializable::ID]
-    def get_id
-      @id
-    end
-    alias :id :get_id
-
-    # Set the shape's id. Deserialization only.
-    # @param [Wx::SF::Serializable::ID] id
-    def set_id(id)
-      @id = id
-    end
-    private :set_id
-
     # Set managing diagram
     # @param [Wx::SF::Diagram] diagram
     def set_diagram(diagram)
@@ -343,9 +323,10 @@ module Wx::SF
     # @param [Wx::SF::Shape] child child shape to add
     # @return [Wx::SF::Shape,nil] added child shape or nil if not accepted
     def add_child_shape(child)
+      raise SFException, 'Illegal attempt to add self as Shape child' if child == self
       if is_child_accepted(child.class)
         if child.get_diagram
-          child.get_diagram.reparent_shape(child, shape)
+          child.get_diagram.reparent_shape(child, self)
         else
           child.set_parent_shape(self)
         end
@@ -355,12 +336,24 @@ module Wx::SF
       nil
     end
 
+
+    # Returns true if the given shape is included in the child shapes list.
+    # Performs a recursive search in case :recursive is true.
+    # @param [shape] shape shape to match
+    # @param [Boolean] recursive pass true to search recursively, false for non-recursive
+    # @return [Boolean] true if included, otherwise false
+    def include_child_shape?(shape, recursive = false)
+      @child_shapes.include?(shape, recursive)
+    end
+
     # Set parent shape object.
     # @param [Wx::SF::Shape] parent
     # @note Note that this does not check this shape against the acceptance list of the parent. Use #add_child_shape if that is required.
     # @note Note that this does not add (if parent == nil) or remove (if parent != nil) the shape from the diagram's
     # toplevel shapes. Use Diagram#reparent_shape when that is needed.
     def set_parent_shape(parent)
+      raise SFException, 'Illegal to set Shape parent to self' if parent == self
+      raise SFException, 'Illegal to set Shape parent to (grand-)child of self' if parent && include_child_shape?(parent, true)
       @parent_shape.send(:remove_child, self) if @parent_shape
       parent.send(:add_child, self) if parent
       set_diagram(parent.get_diagram) if parent
@@ -383,7 +376,7 @@ module Wx::SF
     alias :grand_parent_shape :get_grand_parent_shape
 
     # Refresh (redraw) the shape
-    # @param [Boolean] delayed If true then the shape canvas will be rather invalidated than refreshed.
+    # @param [Boolean] delayed If true then the shape canvas will be invalidated rather than refreshed.
     # @see ShapeCanvas#invalidate_rect
     # @see ShapeCanvas#refresh_invalidated_rect
     def refresh(delayed = false)
@@ -400,25 +393,29 @@ module Wx::SF
       return unless @diagram && @diagram.shape_canvas
       return unless @visible
 
-      # draw the shape shadow if required
-      draw_shadow(dc) if !@selected && has_style?(STYLE::SHOW_SHADOW)
+      unless has_style?(STYLE::NOT_DRAWN)
+
+        # draw the shape shadow if required
+        draw_shadow(dc) if !@selected && has_style?(STYLE::SHOW_SHADOW)
 
-      # first, draw itself
-      if @mouse_over && (@highlight_parent || has_style?(STYLE::HOVERING))
-        if @highlight_parent
-          draw_highlighted(dc)
-          @highlight_parent = false
+        # first, draw itself
+        if @mouse_over && (@highlight_parent || has_style?(STYLE::HOVERING))
+          if @highlight_parent
+            draw_highlighted(dc)
+            @highlight_parent = false
+          else
+            draw_hover(dc)
+          end
         else
-          draw_hover(dc)
+          draw_normal(dc)
         end
-      else
-        draw_normal(dc)
-      end
 
-      draw_selected(dc) if @selected
+        draw_selected(dc) if @selected
 
-      # ... then draw connection points ...
-      @connection_pts.each { |cpt| cpt.draw(dc) }
+        # ... then draw connection points ...
+        @connection_pts.each { |cpt| cpt.draw(dc) } unless has_style?(STYLE::PROPAGATE_INTERACTIVE_CONNECTION)
+
+      end
 
       # ... then draw child shapes
       if children
@@ -460,11 +457,10 @@ module Wx::SF
     # @return [Wx::RealPoint] Shape's position
     def get_absolute_position
       # HINT: overload it for custom actions...
-      parent_shape = get_parent_shape
-      if parent_shape
+      if @parent_shape
         @relative_position + get_parent_absolute_position
       else
-        @relative_position.dup
+        @relative_position
       end
     end
 
@@ -501,7 +497,7 @@ module Wx::SF
 
     # Set shape's style.
     #
-    # Default value is STYLE::PARENT_CHANGE | STYLE::POSITION_CHANGE | STYLE::SIZE_CHANGE | STYLE::HOVERING | STYLE::HIGHLIGHTING | STYLE::SHOW_HANDLES | STYLE::ALWAYS_INSIDE | STYLE::DELETE_USER_DATA
+    # Default value is STYLE::PARENT_CHANGE | STYLE::POSITION_CHANGE | STYLE::SIZE_CHANGE | STYLE::HOVERING | STYLE::HIGHLIGHTING | STYLE::SHOW_HANDLES | STYLE::ALWAYS_INSIDE
     # @param [Integer] style Combination of the shape's styles
     # @see STYLE
     def set_style(style)
@@ -523,7 +519,7 @@ module Wx::SF
       @style &= ~style
     end
     def contains_style(style)
-      (@style & style) != 0
+      @style.allbits?(style)
     end
     alias :contains_style? :contains_style
     alias :has_style? :contains_style
@@ -610,7 +606,7 @@ module Wx::SF
     end
 
 	  # Get shape's bounding box which includes also associated child shapes and connections.
-	  # @param [Wx::Rect] rct bounding rectangle
+	  # @param [Wx::Rect, nil] rct bounding rectangle
 	  # @param [BBMODE] mask Bit mask of object types which should be included into calculation
     # @return [Wx::Rect] returned bounding box
 	  # @see BBMODE
@@ -689,17 +685,31 @@ module Wx::SF
       @diagram.set_modified(true) if @diagram
     end
 
-    # Update the shape's position in order to its alignment
-    def do_alignment
-      parent = get_parent_shape
+    # Returns true if this shape manages (size/position/alignment) of it's child shapes.
+    # Returns false by default.
+    # @return [Boolean]
+    def is_manager
+      false
+    end
+    alias :manager? :is_manager
+
+    # Returns true if this shape is managed (size/position/alignment) by it's parent shape.
+    # @return [Boolean]
+    def is_managed
+      !!@parent_shape&.is_manager
+    end
+    alias :managed? :is_managed
 
-      if parent && !parent.is_a?(Wx::SF::GridShape)
 
-        if parent.is_a?(Wx::SF::LineShape)
+    # Update the shape's position in order to its alignment
+    def do_alignment
+      # align to parent unless parent is manager
+      unless @parent_shape.nil? || managed?
+        if @parent_shape.is_a?(Wx::SF::LineShape)
           line_pos = get_parent_absolute_position
           parent_bb = Wx::Rect.new(line_pos.x.to_i, line_pos.y.to_i, 1, 1)
         else
-          parent_bb = parent.get_bounding_box
+          parent_bb = @parent_shape.get_bounding_box
         end
 
         shape_bb = get_bounding_box
@@ -722,8 +732,8 @@ module Wx::SF
           end
 
         when VALIGN::LINE_START
-          if parent.is_a?(Wx::SF::LineShape)
-            line_start, line_end = parent.get_line_segment(0)
+          if @parent_shape.is_a?(Wx::SF::LineShape)
+            line_start, line_end = @parent_shape.get_line_segment(0)
 
             if line_end.y >= line_start.y
               @relative_position.y = line_start.y - line_pos.y + @v_border
@@ -733,8 +743,8 @@ module Wx::SF
           end
 
         when VALIGN::LINE_END
-          if parent.is_a?(Wx::SF::LineShape)
-            line_start, line_end = parent.get_line_segment(parent.get_control_points.get_count)
+          if @parent_shape.is_a?(Wx::SF::LineShape)
+            line_start, line_end = @parent_shape.get_line_segment(parent.get_control_points.get_count)
 
             if line_end.y >= line_start.y
               @relative_position.y = line_end.y - line_pos.y - shape_bb.height - @v_border
@@ -762,8 +772,8 @@ module Wx::SF
           end
 
         when HALIGN::LINE_START
-          if parent.is_a?(Wx::SF::LineShape)
-            line_start, line_end = parent.get_line_segment(0)
+          if @parent_shape.is_a?(Wx::SF::LineShape)
+            line_start, line_end = @parent_shape.get_line_segment(0)
 
             if line_end.x >= line_start.x
 
@@ -774,8 +784,8 @@ module Wx::SF
           end
 
         when HALIGN::LINE_END
-          if parent.is_a?(Wx::SF::LineShape)
-            line_start, line_end = parent.get_line_segment(parent.get_control_points.get_count)
+          if @parent_shape.is_a?(Wx::SF::LineShape)
+            line_start, line_end = @parent_shape.get_line_segment(@parent_shape.get_control_points.get_count)
 
             if line_end.x >= line_start.x
               @relative_position.x = line_end.x - line_pos.x - shape_bb.width - @h_border
@@ -788,7 +798,7 @@ module Wx::SF
     end
 
     # Update shape (align all child shapes and resize it to fit them)
-    def update
+    def update(recurse = true)
       # do self-alignment
       do_alignment
 
@@ -799,8 +809,8 @@ module Wx::SF
       fit_to_children unless has_style?(STYLE::NO_FIT_TO_CHILDREN)
 
       # do it recursively on all parent shapes
-      if (parent = get_parent_shape)
-        parent.update
+      if recurse && (parent = get_parent_shape)
+        parent.update(recurse)
       end
     end
 
@@ -814,11 +824,17 @@ module Wx::SF
       @selected
     end
 
+    # Returns true if any (grand-)parent is selected?
+    def has_selected_parent?
+      @parent_shape&.selected? || @parent_shape&.has_selected_parent?
+    end
+    alias :selected_parent? :has_selected_parent?
+
     # Set the shape as a selected/deselected one
     # @param [Boolean] state Selection state (true is selected, false is deselected)
     def select(state)
       @selected = state
-      show_handles(state && (@style & STYLE::SHOW_HANDLES) != 0)
+      show_handles(state && has_style?(STYLE::SHOW_HANDLES))
     end
 
     # Set shape's relative position. Absolute shape's position is then calculated
@@ -840,7 +856,7 @@ module Wx::SF
     # @return [Wx::RealPoint] Current relative position
     # @see #get_absolute_position
     def get_relative_position
-      @relative_position.dup
+      @relative_position
     end
 
 	  # Set vertical alignment of this shape inside its parent
@@ -942,7 +958,7 @@ module Wx::SF
     # Associate user data with the shape.
     # If the data object is properly set then its marked properties will be serialized
     # together with the parent shape. This means the user data must either be a serializable
-    # core type or a Wx::SF::Serializable.
+    # core type or a FIRM::Serializable.
     # @param [Object] data user data
     def set_user_data(data)
       @user_data = data
@@ -990,7 +1006,7 @@ module Wx::SF
 	  # Get shape's hover color
     # @return [Wx::Colour] Current hover color
     def get_hover_colour
-      @hover_color
+      @hover_color || (@diagram&.shape_canvas ? @diagram.shape_canvas.hover_colour : DEFAULT.hover_colour)
     end
     alias :hover_colour :get_hover_colour
 
@@ -1030,10 +1046,10 @@ module Wx::SF
     def accept_currently_dragged_shapes
       return false unless get_shape_canvas
 
-      unless is_child_accepted(ACCEPT_ALL)
+      unless @accepted_children.include?(ACCEPT_ALL)
         lst_selection = get_shape_canvas.get_selected_shapes
 
-        return false if lst_selection.any? { |shape| !@accepted_children.include?(shape.class.name) }
+        return false if lst_selection.any? { |shape| !@accepted_children.include?(shape.class) }
       end
       true
     end
@@ -1044,7 +1060,7 @@ module Wx::SF
     # @param [Class] type Class of accepted shape object
     # @see #is_child_accepted
     def accept_child(type)
-      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class) || type == ACCEPT_ALL
+      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class)
       @accepted_children << type
     end
 
@@ -1056,6 +1072,14 @@ module Wx::SF
     end
     alias :accepted_children :get_accepted_children
 
+    # Tells whether the shape does not accept ANY children
+    # @return [Boolean] true if no children accepted, false otherwise
+    def does_not_accept_children?
+      @accepted_children.empty?
+    end
+    alias :no_children_accepted? :does_not_accept_children?
+    alias :accepts_no_children? :does_not_accept_children?
+
     # Tells whether the given connection type is accepted by this shape (it means
     # whether this shape can be connected to another one by a connection of given type).
     #
@@ -1073,7 +1097,7 @@ module Wx::SF
     # @param [Class] type Class of accepted connection object
     # @see #is_connection_accepted
     def accept_connection(type)
-      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class) || type == ACCEPT_ALL
+      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class)
       @accepted_connections << type
     end
 
@@ -1102,7 +1126,7 @@ module Wx::SF
     # @param [Class] type Class of accepted connection object
     # @see #is_src_neighbour_accepted
     def accept_src_neighbour(type)
-      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class) || type == ACCEPT_ALL
+      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class)
       @accepted_src_neighbours << type
     end
 
@@ -1131,7 +1155,7 @@ module Wx::SF
     # @param [Class] type Class of accepted connection object
     # @see #is_trg_neighbour_accepted
     def accept_trg_neighbour(type)
-      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class) || type == ACCEPT_ALL
+      ::Kernel.raise ArgumentError, 'Class or ACCEPT_ALL expected' unless type.is_a?(::Class)
       @accepted_trg_neighbours << type
     end
 
@@ -1214,10 +1238,10 @@ module Wx::SF
 
     # Get connection point of given type assigned to the shape.
 	  # @param [Wx::SF::ConnectionPoint::CPTYPE] type Connection point type
-	  # @param [Integer] id Optional connection point ID
+	  # @param [Integer, nil] id Optional connection point ID
 	  # @return [Wx::SF::ConnectionPoint,nil] connection point if exists, otherwise nil
 	  # @see Wx::SF::ConnectionPoint::CPTYPE
-    def get_connection_point(type, id = -1)
+    def get_connection_point(type, id = nil)
       @connection_pts.find { |cp| cp.type == type && cp.id == id }
     end
     alias :connection_point :get_connection_point
@@ -1242,16 +1266,16 @@ module Wx::SF
     # @overload add_connection_point(type, persistent: true)
     #   @param [Wx::SF::ConnectionPoint::CPTYPE] type Connection point type
 	  #   @param [Boolean] persistent true if the connection point should be serialized
-	  #   @return [Wx::SF::ConnectionPoint] new connection point
+	  #   @return [Wx::SF::ConnectionPoint, nil] new connection point if succeeded, otherwise nil
     # @overload add_connection_point(relpos, id=-1, persistent: true)
     #   @param [Wx::RealPoint] relpos Relative position in percentages
     #   @param [Integer] id connection point ID
     #   @param [Boolean] persistent true if the connection point should be serialized
-    #   @return [Wx::SF::ConnectionPoint] new connection point
+    #   @return [Wx::SF::ConnectionPoint, nil] new connection point if succeeded, otherwise nil
     # @overload add_connection_point(cp, persistent: true)
     #   @param [Wx::SF::ConnectionPoint] cp connection point (shape will take the ownership)
     #   @param [Boolean] persistent true if the connection point should be serialized
-    #   @return [Wx::SF::ConnectionPoint] added connection point
+    #   @return [Wx::SF::ConnectionPoint, nil] added connection point if succeeded, otherwise nil
 	  # @see Wx::SF::ConnectionPoint::CPTYPE
     def add_connection_point(arg, *rest, persistent: true)
       cp = nil
@@ -1292,7 +1316,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_LEFT_DOWN, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_LEFT_DOWN, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1310,7 +1334,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_RIGHT_DOWN, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_RIGHT_DOWN, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1328,7 +1352,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_LEFT_DCLICK, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_LEFT_DCLICK, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1346,7 +1370,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_RIGHT_DCLICK, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_RIGHT_DCLICK, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1364,7 +1388,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG_BEGIN, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG_BEGIN, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1382,7 +1406,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1400,7 +1424,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG_END, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_DRAG_END, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1417,7 +1441,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE_BEGIN, self.id)
+        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE_BEGIN, self.object_id)
         evt.set_shape(self)
         evt.set_handle(handle)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1434,7 +1458,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE, self.id)
+        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE, self.object_id)
         evt.set_shape(self)
         evt.set_handle(handle)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1451,7 +1475,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE_END, self.id)
+        evt = Wx::SF::ShapeHandleEvent.new(Wx::SF::EVT_SF_SHAPE_HANDLE_END, self.object_id)
         evt.set_shape(self)
         evt.set_handle(handle)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1468,7 +1492,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_ENTER, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_ENTER, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1485,7 +1509,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_OVER, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_OVER, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1502,7 +1526,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_LEAVE, self.id)
+        evt = Wx::SF::ShapeMouseEvent.new(Wx::SF::EVT_SF_SHAPE_MOUSE_LEAVE, self.object_id)
         evt.set_shape(self)
         evt.set_mouse_position(pos)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1522,7 +1546,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeKeyEvent.new(Wx::SF::EVT_SF_SHAPE_KEYDOWN, self.id)
+        evt = Wx::SF::ShapeKeyEvent.new(Wx::SF::EVT_SF_SHAPE_KEYDOWN, self.object_id)
         evt.set_shape(self)
         evt.set_key_code(key)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1542,7 +1566,7 @@ module Wx::SF
       # HINT: overload it for custom actions...
 
       if has_style?(STYLE::EMIT_EVENTS) && get_shape_canvas
-        evt = Wx::SF::ShapeChildDropEvent.new(Wx::SF::EVT_SF_SHAPE_CHILD_DROP, self.id)
+        evt = Wx::SF::ShapeChildDropEvent.new(Wx::SF::EVT_SF_SHAPE_CHILD_DROP, self.object_id)
         evt.set_shape(self)
         evt.set_child_shape(child)
         get_shape_canvas.get_event_handler.process_event(evt)
@@ -1550,7 +1574,7 @@ module Wx::SF
     end
 
     def to_s
-      "#<#{self.class}:#{id.to_i}#{parent_shape ? " parent=#{parent_shape.id.to_i}" : ''}>"
+      "#<#{self.class}:#{self.object_id}#{@parent_shape ? " parent=#{@parent_shape.object_id}" : ''}>"
     end
 
     def inspect
@@ -1559,6 +1583,13 @@ module Wx::SF
 
     protected
 
+    # called after the shape has been newly imported/pasted/dropped
+    # allows for checking stale links
+    # by default does nothing
+    def on_import
+      # nothing
+    end
+
 	  # Draw the shape in the normal way. The function can be overridden if necessary.
 	  # @param [Wx::DC] _dc Reference to device context where the shape will be drawn to
     def draw_normal(_dc)
@@ -1614,11 +1645,11 @@ module Wx::SF
 	  # Get absolute position of the shape parent.
 	  # @return [Wx::RealPoint] Absolute position of the shape parent if exists, otherwise 0,0
     def get_parent_absolute_position
-      if parent = get_parent_shape
-        if parent.is_a?(Wx::SF::LineShape) && @custom_dock_point != DEFAULT::DOCK_POINT
-          return parent.get_dock_point_position(@custom_dock_point)
+      if @parent_shape
+        if @parent_shape.is_a?(Wx::SF::LineShape) && @custom_dock_point != DEFAULT::DOCK_POINT
+          return @parent_shape.get_dock_point_position(@custom_dock_point)
         else
-          return parent.get_absolute_position
+          return @parent_shape.get_absolute_position
         end
       end
 
@@ -1628,7 +1659,7 @@ module Wx::SF
     private
 
     # Auxiliary function called by GetNeighbours function.
-	  # @param [Class,nil] shapeInfo Line object type
+	  # @param [Class,nil] shape_info Line object type
 	  # @param [CONNECTMODE] condir Connection direction
 	  # @param [Boolean] direct Set this flag to TRUE if only closest shapes should be found,
 	  #     otherwise also shapes connected by forked lines will be found (also
@@ -1649,16 +1680,16 @@ module Wx::SF
         lst_connections.each do |line|
           case condir
           when CONNECTMODE::STARTING
-            opposite = @diagram.find_shape(line.get_trg_shape_id)
+            opposite = line.get_trg_shape
 
           when CONNECTMODE::ENDING
-            opposite = @diagram.find_shape(line.get_src_shape_id)
+            opposite = line.get_src_shape
 
           when CONNECTMODE::BOTH
-            if @id == line.get_src_shape_id
-              opposite = @diagram.find_shape(line.get_trg_shape_id)
+            if self == line.get_src_shape
+              opposite = line.get_trg_shape
             else
-              opposite = @diagram.find_shape(line.get_src_shape_id)
+              opposite = line.get_src_shape
             end
           end
 
@@ -1674,7 +1705,7 @@ module Wx::SF
             if opposite.is_a?(Wx::SF::LineShape)
               case condir
               when CONNECTMODE::STARTING
-                opposite = @diagram.find_shape(opposite.get_src_shape_id)
+                opposite = opposite.get_src_shape
 
                 if  opposite.is_a?(Wx::SF::LineShape)
                   opposite.__send__(:_get_neighbours, shape_info, condir, direct, neighbours, processed)
@@ -1683,7 +1714,7 @@ module Wx::SF
                 end
 
               when CONNECTMODE::ENDING
-                opposite = @diagram.find_shape(opposite.get_trg_shape_id)
+                opposite = opposite.get_trg_shape
 
                 if opposite.is_a?(Wx::SF::LineShape)
                   opposite.__send__(:_get_neighbours, shape_info, condir, direct, neighbours, processed)
@@ -1692,14 +1723,14 @@ module Wx::SF
                 end
 
               when CONNECTMODE::BOTH
-                opposite = @diagram.find_shape(opposite.get_src_shape_id)
+                opposite = opposite.get_src_shape
                 if opposite.is_a?(Wx::SF::LineShape)
                   opposite.__send__(:_get_neighbours, shape_info, condir, direct, neighbours, processed)
                 elsif !neighbours.include?(opposite)
                   neighbours << opposite
                 end
 
-                opposite = @diagram.find_shape(opposite.get_trg_shape_id)
+                opposite = opposite.get_trg_shape
                 if opposite.is_a?(Wx::SF::LineShape)
                   opposite.__send__(:_get_neighbours, shape_info, condir, direct, neighbours, processed)
                 elsif !neighbours.include?(opposite)
@@ -1715,7 +1746,7 @@ module Wx::SF
     end
 
     # Auxiliary function called by GetCompleteBoundingBox function.
-	  # @param [Wx::Rect] rct bounding rectangle to update
+	  # @param [Wx::Rect, nil] rct bounding rectangle to update
 	  # @param [BBMODE] mask Bit mask of object types which should be included into calculation
     # @param [Set<Wx::SF::Shape] processed set to keep track of processed shapes
     # @return [Wx::Rect] bounding rectangle
@@ -1727,14 +1758,18 @@ module Wx::SF
       processed << self
 
       # first, get bounding box of the current shape
-      if (mask & BBMODE::SELF) != 0
-        if rct.is_empty
-          rct.assign(get_bounding_box.inflate!(@h_border.abs.to_i, @v_border.abs.to_i))
+      if mask.allbits?(BBMODE::SELF)
+        if rct.nil?
+          rct = get_bounding_box.inflate!(@h_border.abs.to_i, @v_border.abs.to_i)
         else
-          rct.union!(get_bounding_box.inflate!(@h_border.abs.to_i, @v_border.abs.to_i))
+          if rct.empty?
+            rct += get_bounding_box.inflate!(@h_border.abs.to_i, @v_border.abs.to_i)
+          else
+            rct.union!(get_bounding_box.inflate!(@h_border.abs.to_i, @v_border.abs.to_i))
+          end
 
           # add also shadow offset if necessary
-          if (mask & BBMODE::SHADOW) != 0 && has_style?(STYLE::SHOW_SHADOW) && get_parent_canvas
+          if mask.allbits?(BBMODE::SHADOW) && has_style?(STYLE::SHOW_SHADOW) && !has_style(STYLE::NOT_DRAWN) && get_parent_canvas
             n_offset = get_parent_canvas.get_shadow_offset
 
             if n_offset.x < 0
@@ -1758,7 +1793,7 @@ module Wx::SF
 
       # get list of all connection lines assigned to the shape and find their child shapes
       lst_children = []
-      if (mask & BBMODE::CONNECTIONS) != 0
+      if mask.allbits?(BBMODE::CONNECTIONS)
         lst_lines = get_assigned_connections(Wx::SF::LineShape, CONNECTMODE::BOTH)
 
         lst_lines.each do |line|
@@ -1771,15 +1806,15 @@ module Wx::SF
       end
 
       # get children of this shape
-      if (mask & BBMODE::CHILDREN) != 0
+      if mask.allbits?(BBMODE::CHILDREN)
         get_child_shapes(ANY, NORECURSIVE, SEARCHMODE::BFS, lst_children)
 
         # now, call this function for all children recursively...
         lst_children.each do |child|
-          child.send(:_get_complete_bounding_box, rct, mask, processed)
+          rct = child.send(:_get_complete_bounding_box, rct, mask, processed)
         end
       end
-      rct
+      rct || Wx::Rect.new
     end
 
     # Original protected event handler called when the mouse pointer is moving around the shape canvas.
@@ -1800,7 +1835,7 @@ module Wx::SF
         @handles.each { |h| h.__send__(:_on_mouse_move, pos) }
 
         # send the event to the connection points too...
-        @connection_pts.each { |cp| cp.__send__(:_on_mouse_move, pos) }
+        @connection_pts.each { |cp| cp.__send__(:_on_mouse_move, pos) } unless has_style?(STYLE::PROPAGATE_INTERACTIVE_CONNECTION)
 
         # determine, whether the shape should be highlighted for any reason
         if canvas
@@ -1872,8 +1907,8 @@ module Wx::SF
       @first_move = true
       on_begin_drag(pos)
 
-      if get_parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
-          get_parent_shape.__send__(:_on_begin_drag, pos)
+      if @parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
+        @parent_shape.__send__(:_on_begin_drag, pos)
       end
     end
 
@@ -1891,7 +1926,7 @@ module Wx::SF
         end
 
         # get shape BB BEFORE movement and combine it with BB of assigned lines
-        prev_bb = get_complete_bounding_box(Wx::Rect.new, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
+        prev_bb = get_complete_bounding_box(nil, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
 
         move_to(pos.x - @mouse_offset.x, pos.y - @mouse_offset.y)
         on_dragging(pos)
@@ -1901,7 +1936,7 @@ module Wx::SF
         lst_child_ctrls.each { |ctrl| ctrl.update_control }
 
         # get shape BB AFTER movement and combine it with BB of assigned lines
-        curr_bb = get_complete_bounding_box(Wx::Rect.new, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
+        curr_bb = get_complete_bounding_box(nil, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
 
         # update canvas
         refresh_rect(prev_bb.union!(curr_bb), DELAYED)
@@ -1909,8 +1944,8 @@ module Wx::SF
         @first_move = false
       end
 
-      if get_parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
-        get_parent_shape.__send__(:_on_dragging, pos)
+      if @parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
+        @parent_shape.__send__(:_on_dragging, pos)
       end
     end
 
@@ -1924,8 +1959,8 @@ module Wx::SF
 
       on_end_drag(pos)
 
-      if get_parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
-        get_parent_shape.__send__(:_on_end_drag, pos)
+      if @parent_shape && has_style?(STYLE::PROPAGATE_DRAGGING)
+        @parent_shape.__send__(:_on_end_drag, pos)
       end
     end
 
@@ -1946,8 +1981,8 @@ module Wx::SF
         f_refresh_all = false
 
         if canvas.has_style?(Wx::SF::ShapeCanvas::STYLE::GRID_USE)
-          dx = canvas.get_grid_size.x
-          dy = canvas.get_grid_size.y
+          dx = canvas.get_grid_size
+          dy = canvas.get_grid_size
         end
 
         lst_selection = canvas.get_selected_shapes
@@ -1955,8 +1990,8 @@ module Wx::SF
           f_refresh_all = true
         end
 
-        prev_bb = Wx::Rect.new
-        if !f_refresh_all
+        prev_bb = nil
+        unless f_refresh_all
           prev_bb = get_complete_bounding_box(prev_bb, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
         end
 
@@ -1977,10 +2012,9 @@ module Wx::SF
         end
 
         if !f_refresh_all
-          curr_bb = get_complete_bounding_box(Wx::Rect.new, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
+          curr_bb = get_complete_bounding_box(prev_bb, BBMODE::SELF | BBMODE::CONNECTIONS | BBMODE::CHILDREN | BBMODE::SHADOW)
 
-          prev_bb.union!(curr_bb)
-          refresh_rect(prev_bb, DELAYED)
+          refresh_rect(curr_bb, DELAYED)
         else
           canvas.refresh(false)
         end
@@ -1995,9 +2029,9 @@ module Wx::SF
       return unless @diagram
 
       if @parent_shape
-        prev_bb = get_grand_parent_shape.get_complete_bounding_box(Wx::Rect.new)
+        prev_bb = get_grand_parent_shape.get_complete_bounding_box(nil)
       else
-        prev_bb = get_complete_bounding_box(Wx::Rect.new)
+        prev_bb = get_complete_bounding_box(nil)
       end
 
       # call appropriate user-defined handler
@@ -2014,9 +2048,9 @@ module Wx::SF
       update
 
       if @parent_shape
-        curr_bb = get_grand_parent_shape.get_complete_bounding_box(Wx::Rect.new)
+        curr_bb = get_grand_parent_shape.get_complete_bounding_box(nil)
       else
-        curr_bb = get_complete_bounding_box(Wx::Rect.new)
+        curr_bb = get_complete_bounding_box(nil)
       end
 
       # refresh shape
@@ -2062,7 +2096,6 @@ module Wx::SF
     def update_child_parents
       @child_shapes.each do |shape|
         shape.instance_variable_set(:@parent_shape, self)
-        shape.send(:update_child_parents)
       end
     end
 
@@ -2070,11 +2103,21 @@ module Wx::SF
     def serialize_child_shapes(*val)
       unless val.empty?
         @child_shapes = val.first
+        # @parent_shape is not serialized, instead we rely on child shapes being (de-)serialized
+        # by their parent (child shapes restored before restoring parent child list) and let
+        # the parent reset the @parent_shape attributes of their children.
+        # That way the links never get out of sync.
         update_child_parents
       end
       @child_shapes
     end
 
+    # (de-)serialize hover colour; allows for nil values
+    def serialize_hover_colour(*val)
+      @hover_colour = val.first unless val.empty?
+      @hover_colour
+    end
+
     public
 
     # Returns intersection point of two lines (if any)
@@ -2103,10 +2146,10 @@ module Wx::SF
       xi = (b1*c2 - c1*b2) / (a1*b2 - a2*b1)
       yi = -(a1*c2 - a2*c1) / (a1*b2 - a2*b1)
 
-      if( ((from1.x - xi)*(xi - to1.x) >= 0.0) &&
-        ((from2.x - xi)*(xi - to2.x) >= 0.0) &&
-        ((from1.y - yi)*(yi - to1.y) >= 0.0) &&
-        ((from2.y - yi)*(yi - to2.y) >= 0.0) )
+      if ((from1.x - xi) * (xi - to1.x) >= 0.0) &&
+        ((from2.x - xi) * (xi - to2.x) >= 0.0) &&
+        ((from1.y - yi) * (yi - to1.y) >= 0.0) &&
+        ((from2.y - yi) * (yi - to2.y) >= 0.0)
         return Wx::RealPoint.new(xi, yi)
       end