wxruby3-shapes 0.9.0.pre.beta.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e87fc628c22cdd597cdffbcd842d207cee3542b4b18c599abb2240b56a1b623f
+  data.tar.gz: aca8560f77c6f20e25a25a9905ea0e2f84b6b2d4293dd8341f772882acf52880
+SHA512:
+  metadata.gz: 96cedb90feb6f2bf21044f17c45e55be647e34f20f14035742cf8fa0aa6e9671d732dd8d6f7878900a799d696d29aa1975434674468de15f0038a29c3b68c423
+  data.tar.gz: 95c952c4a3c94e492eac23f854b6465dd185c063266b975ec68ec8929877d4de3302bba71dce5b9e06238ded4828cffbdeb74e258ff23f02cd256e20fa3156a2

data/.yardopts

@@ -0,0 +1,12 @@
+--load rakelib/yard/yard-relative_markdown_links.rb
+--load rakelib/yard/yard-custom-templates.rb
+--charset UTF-8
+--readme README.md
+--title "wxruby3/shapes API Documentation"
+--output-dir rdoc
+--protected
+lib/wx/shapes/**/*.rb
+-
+CREDITS.md
+INSTALL.md
+LICENSE

data/CREDITS.md

@@ -0,0 +1,18 @@
+
+# Credits
+
+## wxRuby3/Shapes
+
+Martin Corino established the wxRuby3/Shapes project in 2023.
+
+### Lead Maintainer
+
+Martin Corino: mcorino at m2c-software dot nl
+
+## wxShapeFramework
+
+In 2002 Michal Bliznak established the [wxShapeFramework](https://sourceforge.net/projects/wxsf/) project. The last
+contribution to this project dates back 7 years.
+
+wxruby3/shapes has been ported from the code base of [this](https://github.com/danselmi/wxShapeFramework) Github fork
+for which the last contribution dates back 4 years. 

data/INSTALL.md

@@ -0,0 +1,39 @@
+<!--
+# @markup markdown
+-->
+
+# Installation of wxRuby3/Shapes
+
+## Installation of a wxRuby3/Shapes Gem
+
+The wxRuby3/Shapes project provides gems on [RubyGems](https://rubygems.org) which can be installed with the
+standard `gem install` command line this:
+
+```sh
+gem install wxruby3-shapes
+ ```
+
+This will install the wxruby3-shapes gem on any system supporting Ruby and wxRuby.
+As wxRuby3/Shapes has a dependency on wxRuby3 the wxRuby3 gem will be attempted to be installed if (the required version is) 
+not yet installed. This will be attempted using a default installation of the wxRuby3 gem. As this is a gem building 
+a native extension (except for Windows where the default install will be a prebuilt binary extension gem) this can take quite a
+while. 
+
+Due to the dependencies of the wxRuby3 gem itself it might be preferable to install that gem separately beforehand. See the
+[INSTALL](https://github.com/mcorino/wxRuby3/blob/master/INSTALL.md) document of the wxRuby3 project for more details.
+
+## Building from source
+
+When installing from source the following basic requirements apply:
+
+- Git version control toolkit
+- Ruby 2.5 or later
+
+Checkout the wxRuby3/Shapes sources from [GitHub](https://github.com/mcorino/wxRuby3-shapes).
+
+The wxRuby3/Shapes project provides a Rake based build system. Call `rake help` to get an overview of the available commands.
+
+Execute the `rake gem` command to build the wxruby-shapes gem. This will create a gem file in the `./pkg` folder.
+
+Install the created gem by executing the command `gem install pkg/wxruby3-shapes-<version>.gem`. Everything described 
+above for [Installation of a wxRuby3/Shapes Gem](#installation-of-a-wxruby3shapes-gem) applies.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 mcorino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+[![Linux wxGTK](https://github.com/mcorino/wxRuby3-shapes/actions/workflows/linux.yml/badge.svg)](https://github.com/mcorino/wxRuby3-shapes/actions/workflows/linux.yml)
+[![Windows wxMSW](https://github.com/mcorino/wxRuby3-shapes/actions/workflows/msw.yml/badge.svg)](https://github.com/mcorino/wxRuby3-shapes/actions/workflows/msw.yml)
+[![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](LICENSE)
+[![Gem Version](https://badge.fury.io/rb/wxruby3-shapes.svg)](https://badge.fury.io/rb/wxruby3-shapes)
+
+[![Documentation](https://img.shields.io/badge/docs-pages-blue.svg)](https://mcorino.github.io/wxRuby3-shapes)
+
+# wxRuby3/Shapes - A wxRuby3 2D shapes and diagramming framework
+
+![wxRuby3/Shapes demo](assets/screenshot.png)
+
+## Introduction
+
+**wxRuby3/Shapes** (Wx::SF) is a pure Ruby software library/framework based on wxRuby3 which allows
+easy development of software applications manipulating graphical objects (shapes) like various CASE 
+tools, technological processes modeling tools, etc. This library is a pure Ruby implementation based
+on the excellent [wxShapeFramework](https://sourceforge.net/projects/wxsf/) C++ library based on 
+wxWidgets.
+
+The library consists of several classes encapsulating a so called 'Shape canvas' (visual
+GUI control used for management of diagrams) providing the following features:
+
+- Create charts (diagrams) interactively in your wxRuby3 applications
+- Serialize/deserialize charts to file or any io stream in multiple formats (currently supported formats are JSON and YAML)
+- Support for Clipboard operations (Cut/Paste) and Drag&Drop of diagram components (shapes)
+- Support for Undo/Redo operations
+- Support for alignment of diagram components.
+- Support for printing of diagrams (including preview)
+- Support for diagram export to bitmap (any supported type)
+- Support for Thumbnail view of diagram
+- A standard collection of diagram components
+  - Shapes: basic rectangular, square, circle, ellipse, rounded rectangle, grid, flexible grid, text, editable text, polygonal, diamond, bitmap
+  - Lines: straight, curved, orthogonal, rounded orthogonal
+  - Line arrows: solid, open, diamond, circle
+- Highly customizable and extendable
+
+The shape framework (and shape canvas) allows to define the relationship between various
+shape types (for example which shape can be a child of another one, which shape types
+can be connected together by which connection type, how do various connections look
+like, etc) and provides an extensive set of events for customizing the interactive creation 
+of diagrams.
+
+More over, the library source code is pure Ruby based on wxRuby3 GUI toolkit, so it will
+run on any platform that supports Ruby and wxRuby3.
+
+## wxRuby3/Shapes licence
+
+wxruby3/shapes is free and open-source. It is distributed under the liberal
+MIT licence which is compatible with both free and commercial development.
+See [LICENSE](LICENSE) for more details.
+
+See the [wxRuby3](https://github.com/mcorino/wxRuby3) project for more information
+concerning licensing of wxRuby3.
+
+### Required Credits and Attribution
+
+Generally, neither wxRuby3 nor wxRuby3/Shapes require attribution, beyond
+retaining existing copyright notices. 
+See [here](CREDITS.md) for more details and acknowledgements.
+
+## FAQ
+
+### What platforms and operating systems are supported in wxRuby3/Shapes?
+
+All platforms supporting Ruby and wxRuby3. See the [wxRuby3](https://github.com/mcorino/wxRuby3) 
+project for more information 
+
+### Where can I ask a question, or report a bug?
+
+Use GitHUb Issues.
+
+When asking a question, if something is not working as you expect,
+please provide a *minimal*, *runnable* sample of code that demonstrates
+the problem, and say what you expected to happen, and what actually
+happened. Please also provide basic details of your platform, Ruby,
+wxRuby3/Shapes, wxRuby and wxWidgets version, and make a reasonable effort 
+to find answers in the archive and documentation before posting. People are mostly happy
+to help, but it's too much to expect them to guess what you're trying to
+do, or try and debug 1,000 lines of your application.
+Very important also; do not use offensive language and be **polite**.
+
+### How can I learn to use wxRuby3/Shapes?
+
+The wxRuby3/Shapes API has a lot of features and takes some time to learn. 
+The wxRuby3/Shapes distribution comes with several samples which illustrate how 
+to use many specific parts of the API. Good one's to start with are the
+basic samples (samples/sample1|2|3|4) which provide insights in various basic 
+features. The samples also include a fairly advanced and complete diagramming
+demo application showcasing most of the features of wxRuby3/Shapes.
+
+Complete (more or less) wxRuby3/Shapes API documentation should be part of any
+complete wxRuby3/Shapes build. This tends to focus on providing a reference
+of all available modules, classes ad methods and how to use specific
+classes and methods, rather than on how to construct an application
+overall.
+This documentation (for the latest release) is also available online
+[here](https://mcorino.github.io/wxRuby3-shapes/index.html).
+
+### How does wxRuby3/Shapes compare to wxShapeFramework?
+
+**wxRuby3/Shapes** is not a straight port of wxShapeFramework although much of the structure is maintained 
+with the following major implementation differences:
+
+- wxRuby3/Shapes implements a totally different serialization scheme in which none of the XML serializer 
+code has been ported. In fact wxRuby3/Shapes does not offer any XML serialization out of the box but instead 
+provides a more adaptable implementation with (for now) two supported output formats; JSON and YAML.
+- Related to this the internal management of shape references has been changed as well as this was tightly 
+linked to the serialization implementation.
+- The API has been Ruby-fied with respect to constant names, method names and argument passing and return
+values.
+- The ScaledDC class has been integrated with wxRuby3 and is not part of wxRuby3/Shapes.
+
+In addition many small tweaks, improvements and also bugfixes have been implemented as part of the port. 
+
+### I am getting an error trying to install wxRuby3/Shapes
+
+Please double-check the [INSTALL](INSTALL.md) documents, and search issue archives. If
+this doesn't help, please post your question using GitHub Issues.

data/bin/wx-shapes

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#---------------------------------
+# This file is generated
+#---------------------------------
+module WxShapes
+  ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end
+require 'wx/wx-shapes/base'
+WxShapes.run

data/lib/wx/shapes/arrow_base.rb

@@ -0,0 +1,86 @@
+# Wx::SF::ArrowBase - arrow base class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes/serializable'
+require 'wx/shapes/shape'
+
+module Wx::SF
+
+  class ArrowBase
+
+    include Wx::SF::Serializable
+
+    module DEFAULT
+      FILL = Wx::Brush.new(Wx::WHITE) if Wx::App.is_main_loop_running
+      Wx.add_delayed_constant(self, :FILL) { Wx::Brush.new(Wx::WHITE) }
+      BORDER = Wx::Pen.new(Wx::BLACK) if Wx::App.is_main_loop_running
+      Wx.add_delayed_constant(self, :BORDER) { Wx::Pen.new(Wx::BLACK) }
+    end
+
+    # Constructor
+    # @param [Wx::SF::Shape] parent parent shape
+    def initialize(parent=nil)
+      @parent_shape = parent
+    end
+
+	  # Set a parent of the arrow shape.
+	  # @param [Wx::SF::Shape] parent parent shape
+    def set_parent_shape(parent)
+      @parent_shape = parent
+    end
+    alias :parent_shape= :set_parent_shape
+
+	  # Get pointer to a parent shape.
+	  # @return [Wx::SF::Shape] parent shape if exists, otherwise nil
+    def get_parent_shape
+      @parent_shape
+    end
+    alias :parent_shape :get_parent_shape
+
+	  # Draw arrow shape at the end of a virtual line.
+	  # @param [Wx::RealPoint] from Start of the virtual line
+	  # @param [Wx::RealPoint] to End of the virtual line
+	  # @param [Wx::DC] dc Device context for drawing
+    def draw(from, to, dc)
+      # needs to be overridden
+    end
+
+    protected
+
+    # Rotate and move arrow's vertices in accordance of virtual line at which end the arrow will be placed.
+	  # @param [Array<Wx::RealPoint>] src array of source vertices
+	  # @param [Wx::RealPoint] from Start of the virtual line
+	  # @param [Wx::RealPoint] to End of the virtual line
+    # @param [Array<Wx::Point>] trg array where translated vertices will be stored
+    # @return [Array<Wx::Point>] array with translated vertices
+    def translate_arrow(src, from, to, trg = [])
+      # calculate distance between line points
+      from = from.to_real_point; to = to.to_real_point
+      dist = from.distance_to(to)
+
+      if dist == 0.0
+        src.each do |pt|
+          trg << Wx::Point.new(((pt.x-pt.y)+to.x).to_i,
+                               ((pt.x+pt.y)+to.y).to_i)
+        end
+      else
+        # calculate sin and cos of given line segment
+        sina = (from.y - to.y)/dist
+        cosa = (from.x - to.x)/dist
+
+        # rotate arrow
+        src.each do |pt|
+          trg << Wx::Point.new(((pt.x*cosa-pt.y*sina)+to.x).to_i,
+                               ((pt.x*sina+pt.y*cosa)+to.y).to_i)
+        end
+      end
+      trg
+    end
+
+  end
+
+end
+
+Dir[File.join(__dir__, 'arrows', '*.rb')].each do |f|
+  require "wx/shapes/arrows/#{File.basename(f, '.rb')}"
+end

data/lib/wx/shapes/arrows/circle_arrow.rb

@@ -0,0 +1,39 @@
+# Wx::SF::CircleArrow - circle arrow class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes/arrows/solid_arrow'
+
+module Wx::SF
+
+  class CircleArrow < SolidArrow
+
+    # Default circle radius.
+    RADIUS = 4
+
+    property :radius
+
+    # Constructor
+    # @param [Wx::SF::Shape] parent parent shape
+    def initialize(parent=nil)
+      super
+      @radius = 4
+    end
+
+    # Get or set the circle radius
+    attr_accessor :radius
+
+    # Draw arrow shape at the end of a virtual line.
+    # @param [Wx::RealPoint] from Start of the virtual line
+    # @param [Wx::RealPoint] to End of the virtual line
+    # @param [Wx::DC] dc Device context for drawing
+    def draw(from, to, dc)
+      dc.with_pen(@pen) do |dc|
+        dc.with_brush(@fill) do |dc|
+          dc.draw_circle(to.to_point, @radius)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/wx/shapes/arrows/diamond_arrow.rb

@@ -0,0 +1,33 @@
+# Wx::SF::DiamondArrow - diamond arrow class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes/arrows/solid_arrow'
+
+module Wx::SF
+
+  class DiamondArrow < SolidArrow
+
+    class << self
+
+      def diamond_arrow
+        @diamond_arrow ||= [Wx::RealPoint.new(0,0), Wx::RealPoint.new(10,4), Wx::RealPoint.new(20,0), Wx::RealPoint.new(10,-4)]
+      end
+
+    end
+
+    # Draw arrow shape at the end of a virtual line.
+    # @param [Wx::RealPoint] from Start of the virtual line
+    # @param [Wx::RealPoint] to End of the virtual line
+    # @param [Wx::DC] dc Device context for drawing
+    def draw(from, to, dc)
+      rarrow = translate_arrow(DiamondArrow.diamond_arrow, from, to)
+      dc.with_pen(@pen) do |dc|
+        dc.with_brush(@fill) do |dc|
+          dc.draw_polygon(rarrow)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/wx/shapes/arrows/open_arrow.rb

@@ -0,0 +1,56 @@
+# Wx::SF::OpenArrow - open arrow class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes/arrow_base'
+
+module Wx::SF
+
+  # Class extends the wxSFArrowBase class and encapsulates
+  # arrow shape consisting of single two lines leading from the end of the
+  # parent line shape.
+  class OpenArrow < ArrowBase
+
+    class << self
+      def open_arrow
+        @open_arrow ||= [Wx::RealPoint.new(0,0), Wx::RealPoint.new(10,4), Wx::RealPoint.new(10,-4)]
+      end
+    end
+
+    property :arrow_pen
+
+    # Constructor
+    # @param [Wx::SF::Shape] parent parent shape
+    def initialize(parent=nil)
+      super
+      @pen = DEFAULT::BORDER
+    end
+
+    # Get arrow border pen
+    # @return [Wx::Pen]
+    def get_arrow_pen
+      @pen
+    end
+    alias :arrow_pen :get_arrow_pen
+
+    # Set arrow border pen
+    # @param [Wx::Pen] pen
+    def set_arrow_pen(pen)
+      @pen = pen
+    end
+    alias :arrow_pen= :set_arrow_pen
+
+	  # Draw arrow shape at the end of a virtual line.
+	  # @param [Wx::RealPoint] from Start of the virtual line
+	  # @param [Wx::RealPoint] to End of the virtual line
+	  # @param [Wx::DC] dc Device context for drawing
+    def draw(from, to, dc)
+      rarrow = translate_arrow(OpenArrow.open_arrow, from, to)
+      dc.with_pen(@pen) do |dc|
+        dc.draw_line(rarrow[0], rarrow[1])
+        dc.draw_line(rarrow[0], rarrow[2])
+      end
+    end
+
+  end
+
+end

data/lib/wx/shapes/arrows/solid_arrow.rb

@@ -0,0 +1,69 @@
+# Wx::SF::SolidArrow - solid arrow class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes/arrow_base'
+
+module Wx::SF
+
+  class SolidArrow < ArrowBase
+
+    class << self
+      def solid_arrow
+        @solid_arrow ||= [Wx::RealPoint.new(0,0), Wx::RealPoint.new(10,4), Wx::RealPoint.new(10,-4)]
+      end
+    end
+
+    property :arrow_fill, :arrow_pen
+
+    # Constructor
+    # @param [Wx::SF::Shape] parent parent shape
+    def initialize(parent=nil)
+      super
+      @fill = DEFAULT::FILL
+      @pen = DEFAULT::BORDER
+    end
+
+    # Get arrow fill brush
+    # @return [Wx::Brush]
+    def get_arrow_fill
+      @fill
+    end
+    alias :arrow_fill :get_arrow_fill
+    
+    # Set arrow fill brush
+    # @param [Wx::Brush] brush
+    def set_arrow_fill(brush)
+      @fill = brush
+    end
+    alias :arrow_fill= :set_arrow_fill
+
+    # Get arrow border pen
+    # @return [Wx::Pen]
+    def get_arrow_pen
+      @pen
+    end
+    alias :arrow_pen :get_arrow_pen
+
+    # Set arrow border pen
+    # @param [Wx::Pen] pen
+    def set_arrow_pen(pen)
+      @pen = pen
+    end
+    alias :arrow_pen= :set_arrow_pen
+
+	  # Draw arrow shape at the end of a virtual line.
+	  # @param [Wx::RealPoint] from Start of the virtual line
+	  # @param [Wx::RealPoint] to End of the virtual line
+	  # @param [Wx::DC] dc Device context for drawing
+    def draw(from, to, dc)
+      rarrow = translate_arrow(SolidArrow.solid_arrow, from, to)
+      dc.with_pen(@pen) do |dc|
+        dc.with_brush(@fill) do |dc|
+          dc.draw_polygon(rarrow)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/wx/shapes/art/shape_canvas/page.xpm

@@ -0,0 +1,73 @@
+/* XPM */
+static char * page_xpm[] = {
+"32 32 37 1",
+"5 c #7198D9",
+", c #769CDA",
+"2 c #DCE6F6",
+"i c #FFFFFF",
+"e c #779DDB",
+": c #9AB6E4",
+"9 c #EAF0FA",
+"- c #B1C7EB",
+"$ c #6992D7",
+"y c #F7F9FD",
+"= c #BED0EE",
+"q c #F0F5FC",
+"; c #A8C0E8",
+"@ c #366BC2",
+"  c None",
+"u c #FDFEFF",
+"8 c #5987D3",
+"* c #C4D5F0",
+"7 c #7CA0DC",
+"O c #487BCE",
+"< c #6B94D7",
+"& c #CCDAF2",
+"> c #89A9DF",
+"3 c #5584D1",
+"w c #82A5DE",
+"1 c #3F74CB",
+"+ c #3A70CA",
+". c #3569BF",
+"% c #D2DFF4",
+"# c #3366BB",
+"r c #F5F8FD",
+"0 c #FAFCFE",
+"4 c #DFE8F7",
+"X c #5E8AD4",
+"o c #5282D0",
+"t c #B8CCEC",
+"6 c #E5EDF9",
+"                                ",
+"                                ",
+"                                ",
+"                                ",
+"                                ",
+"       .XXXooOO++@#             ",
+"       $%&*=-;::>,<1            ",
+"       $2%&*=-;::><:3           ",
+"       $42%&*=-;::<&:3          ",
+"       56477<<<<8<<9&:X         ",
+"       59642%&*=-;<09&:5        ",
+"       5q9642%&*=-<<<<<#        ",
+"       5qqw777<<<<<88:>+        ",
+"       erqq9642%&*=t;::+        ",
+"       eyrqq9642%&*=t;:O        ",
+"       eyywwww777<<<<t;O        ",
+"       e0yyrqq9642%&*=to        ",
+"       e00yyrqq9642%&*=o        ",
+"       eu0wwwwwww777<&*X        ",
+"       euu00yyrqq9642%&X        ",
+"       eiuu00yyrqq9642%X        ",
+"       eiiwwwwwwwwww742$        ",
+"       eiiiuu00yyrqq964$        ",
+"       eiiiiuu00yyrqq96$        ",
+"       eiiiiiuu00yyrqq95        ",
+"       eiiiiiiuu00yyrqq5        ",
+"       eeeeeeeeeeeeee55e        ",
+"                                ",
+"                                ",
+"                                ",
+"                                ",
+"                                "
+};