glimmer-dsl-gtk 0.0.5 → 0.0.6

data/lib/glimmer/gtk/shape.rb

@@ -57,6 +57,8 @@
 #
 # If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
 
+require 'glimmer/gtk/transformable'
+
 module Glimmer
   module Gtk
     # Represents Gtk shape objects drawn on area widget, like rectangle, arc, and path
@@ -103,11 +105,25 @@ module Glimmer
           accumulator
         end
         
-        def normalize_one_based_color(rgb)
+        def one_based_color_rgb(rgb)
+          return rgb if rgb.is_a?(Cairo::Pattern) || rgb.first.is_a?(Cairo::ImageSurface)
           rgb.each_with_index.map {|single_color, i| i == 3 ? single_color : single_color / 255.0}
         end
+        
+        def set_source_dynamically(cairo_context, source_args)
+          source_args = one_based_color_rgb(source_args)
+          if source_args.is_a?(Cairo::Pattern) || source_args.first.is_a?(Cairo::ImageSurface)
+            cairo_context.set_source(*source_args)
+          elsif source_args.size == 3
+            cairo_context.set_source_rgb(*source_args)
+          elsif source_args.size == 4
+            cairo_context.set_source_rgba(*source_args)
+          end
+        end
       end
       
+      prepend Transformable
+      
       SHAPE_FILL_PROPERTIES = [:fill_rule]
       SHAPE_STROKE_PROPERTIES = [:dash, :font_face, :font_matrix, :font_options, :font_size, :line_cap, :line_join, :line_width, :miter_limit, :scaled_font]
       SHAPE_GENERAL_PROPERTIES = [:matrix, :operator, :tolerance]
@@ -166,46 +182,44 @@ module Glimmer
       #
       # Subclasses can override
       def draw_shape(drawing_area_widget, cairo_context)
+        previous_matrix = cairo_context.matrix
+        apply_transforms(cairo_context, target: :shape)
         class_symbol = self.class.name.split('::').last
         keyword = self.class.keyword(class_symbol)
         cairo_context.send(keyword, *args)
+        cairo_context.set_matrix(previous_matrix)
       end
       
       def draw_fill(drawing_area_widget, cairo_context)
-        the_fill = normalize_one_based_color(fill)
-        if the_fill.size == 3
-          cairo_context.set_source_rgb(*the_fill)
-        elsif the_fill.size == 4
-          cairo_context.set_source_rgba(*the_fill)
-        end
+        previous_matrix = cairo_context.matrix
+        apply_transforms(cairo_context, target: :fill)
+        self.class.set_source_dynamically(cairo_context, fill)
         (SHAPE_FILL_PROPERTIES + SHAPE_GENERAL_PROPERTIES).each do |property|
-          cairo_context.send("set_#{property}", send(property)) if send(property)
+          cairo_context.send("set_#{property}", *send(property)) if send(property)
         end
         cairo_context.fill
+        cairo_context.set_matrix(previous_matrix)
       end
       
       def draw_stroke(drawing_area_widget, cairo_context)
-        the_stroke = normalize_one_based_color(stroke)
-        if the_stroke.size == 3
-          cairo_context.set_source_rgb(*the_stroke)
-        elsif the_stroke.size == 4
-          cairo_context.set_source_rgba(*the_stroke)
-        end
+        previous_matrix = cairo_context.matrix
+        apply_transforms(cairo_context, target: :stroke)
+        self.class.set_source_dynamically(cairo_context, stroke)
         (SHAPE_STROKE_PROPERTIES + SHAPE_GENERAL_PROPERTIES).each do |property|
-          cairo_context.send("set_#{property}", send(property)) if send(property)
+          cairo_context.send("set_#{property}", *send(property)) if send(property)
         end
         cairo_context.stroke
+        cairo_context.set_matrix(previous_matrix)
       end
       
       def draw_clip(drawing_area_widget, cairo_context)
+        previous_matrix = cairo_context.matrix
+        apply_transforms(cairo_context, target: :clip)
         SHAPE_GENERAL_PROPERTIES.each do |property|
-          cairo_context.send("set_#{property}", send(property)) if send(property)
+          cairo_context.send("set_#{property}", *send(property)) if send(property)
         end
         cairo_context.clip
-      end
-      
-      def normalize_one_based_color(rgb)
-        self.class.normalize_one_based_color(rgb)
+        cairo_context.set_matrix(previous_matrix)
       end
       
       def respond_to?(method_name, include_private = false, &block)

data/lib/glimmer/gtk/transformable.rb

@@ -0,0 +1,93 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# GNU LESSER GENERAL PUBLIC LICENSE
+# Version 3, 29 June 2007
+#
+# Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
+#
+# Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+#
+# This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+#
+# 0. Additional Definitions.
+# As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+#
+# “The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+#
+# An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+#
+# A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+#
+# The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+#
+# The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+#
+# 1. Exception to Section 3 of the GNU GPL.
+# You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+#
+# 2. Conveying Modified Versions.
+# If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+#
+# a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+# b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+# 3. Object Code Incorporating Material from Library Header Files.
+# The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+#
+# a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+# b) Accompany the object code with a copy of the GNU GPL and this license document.
+# 4. Combined Works.
+# You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+#
+# a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+# b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+# c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+# d) Do one of the following:
+# 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+# 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+# e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+# 5. Combined Libraries.
+# You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+#
+# a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+# b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+# 6. Revised Versions of the GNU Lesser General Public License.
+# The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+#
+# Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+#
+# If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
+
+module Glimmer
+  module Gtk
+    # Represents transformable view elements like shapes and drawing_area
+    module Transformable
+      def initialize(keyword, parent, args, &block)
+        @transforms = []
+        super
+      end
+      
+      # applies transform on target type (:shape, :drawing_area, :fill, :stroke, :clip)
+      def apply_transforms(cairo_context, target: )
+        @transforms.each do |transform|
+          operation = transform.first
+          args = transform.last.dup
+          options = args.pop
+          excluded_types = [options[:exclude]].flatten
+          cairo_context.send(operation, *args) if !excluded_types.include?(target)
+        end
+      end
+      
+      def translate(x, y, options = {})
+        @transforms << [:translate, [x, y, options]]
+      end
+      
+      def scale(x, y, options = {})
+        @transforms << [:scale, [x, y, options]]
+      end
+      
+      def rotate(angle, options = {})
+        @transforms << [:rotate, [angle, options]]
+      end
+    end
+  end
+end

data/lib/glimmer/gtk/widget_proxy/drawing_area_proxy.rb

@@ -57,6 +57,8 @@
 #
 # If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
 
+require 'glimmer/gtk/transformable'
+
 module Glimmer
   module Gtk
     class WidgetProxy
@@ -64,6 +66,8 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class DrawingAreaProxy < WidgetProxy
+        prepend Transformable
+      
         attr_reader :shapes
   
         def initialize(keyword, parent, args, &block)
@@ -75,8 +79,11 @@ module Glimmer
           super
           @gtk.signal_connect(:draw) do |drawing_area_widget, cairo_context|
             if @paint
-              cairo_context.set_source_rgb(Shape.normalize_one_based_color(@paint))
+              previous_matrix = cairo_context.matrix
+              apply_transforms(cairo_context, target: :drawing_area)
+              Shape.set_source_dynamically(cairo_context, @paint)
               cairo_context.paint
+              cairo_context.set_matrix(previous_matrix)
             end
             
             shapes.each do |shape|

data/samples/cairo/arc.rb

@@ -0,0 +1,44 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Hello, Drawing Area!'
+  default_size 256, 256
+  
+  drawing_area {
+    # Surface Paint
+    paint 242.25, 242.25, 242.25
+    
+    # Set up the parameters
+    xc = 128.0
+    yc = 128.0
+    radius = 100.0
+    angle1 = 45.0  * (Math::PI/180.0) # angles are specified
+    angle2 = 180.0  * (Math::PI/180.0) # in radians
+    
+    # The main arc
+    arc(xc, yc, radius, angle1, angle2) {
+      stroke 0, 0, 0
+      line_width 10
+    }
+    
+    # Draw helping lines
+    
+    # First, the circle at the centre
+    arc(xc, yc, 10.0, 0, 2*Math::PI) {
+      fill 255, 51, 51, 0.6
+    }
+    
+    # Then, the lines reaching out
+    path {
+      arc xc, yc, radius, angle1, angle1
+      line_to xc, yc
+      arc xc, yc, radius, angle2, angle2
+      line_to xc, yc
+      
+      stroke 255, 51, 51, 0.6
+      line_width 6
+    }
+  }
+}.show

data/samples/cairo/arc_negative.rb

@@ -0,0 +1,44 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Arc Negative'
+  default_size 256, 256
+  
+  drawing_area {
+    # Surface Paint
+    paint 255, 255, 255
+    
+    # Set up the parameters
+    xc = 128.0
+    yc = 128.0
+    radius = 100.0
+    angle1 = 45.0  * (Math::PI/180.0) # angles are specified
+    angle2 = 180.0  * (Math::PI/180.0) # in radians
+    
+    # The main negative arc
+    arc_negative(xc, yc, radius, angle1, angle2) {
+      stroke 0, 0, 0
+      line_width 10
+    }
+    
+    # Draw helping lines
+    
+    # First, the circle at the centre
+    arc(xc, yc, 10.0, 0, 2*Math::PI) {
+      fill 255, 51, 51, 0.6
+    }
+    
+    # Then, the lines reaching out
+    path {
+      arc(xc, yc, radius, angle1, angle1)
+      line_to(xc, yc)
+      arc(xc, yc, radius, angle2, angle2)
+      line_to(xc, yc)
+      
+      stroke 255, 51, 51, 0.6
+      line_width 6
+    }
+  }
+}.show

data/samples/cairo/clip.rb

@@ -0,0 +1,34 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Clip'
+  default_size 256, 256
+  
+  drawing_area {
+    # Surface Paint
+    paint 255, 255, 255
+    
+    # Designate arc as the clipping area
+    arc(128.0, 128.0, 76.8, 0, 2 * Math::PI) {
+      clip true
+    }
+    
+    # Rectangle will get clipped by arc
+    rectangle(0, 0, 256, 256) {
+      fill 0, 0, 0
+    }
+    
+    # Path will get clipped by arc
+    path {
+      move_to 0, 0
+      line_to 256, 256
+      move_to 256, 0
+      line_to 0, 256
+      
+      stroke 0, 255, 0
+      line_width 10
+    }
+  }
+}.show

data/samples/cairo/clip_image.rb

@@ -0,0 +1,28 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Clip Image'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+
+    arc(128.0, 128.0, 76.8, 0, 2 * Math::PI) {
+      clip true # designate arc as the clipping area
+    }
+
+    rectangle(0, 0, 256, 256) {
+      # Source image is from:
+      # - https://www.publicdomainpictures.net/en/view-image.php?image=7683&picture=breaking-blue-wave
+      # Converted to PNG before using it
+      image = Cairo::ImageSurface.from_png(File.expand_path(File.join('..', '..', 'images', 'breaking-blue-wave.png'), __dir__))
+      w = image.width
+      h = image.height
+  
+      scale 256.0/w, 256.0/h, exclude: :shape # applies scale to fill source image only
+      fill image, 0, 0
+    }
+  }
+}.show

data/samples/cairo/curve_to.rb

@@ -0,0 +1,39 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Curve to'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    x=25.6
+    y=128.0
+    x1=102.4
+    y1=230.4
+    x2=153.6
+    y2=25.6
+    x3=230.4
+    y3=128.0
+    
+    path {
+      move_to x, y
+      curve_to x1, y1, x2, y2, x3, y3
+      
+      line_width 10
+      stroke 0, 0, 0
+    }
+    
+    path {
+      move_to x,y
+      line_to x1,y1
+      move_to x2,y2
+      line_to x3,y3
+      
+      line_width 6
+      stroke 255, 51, 51, 0.6
+    }
+  }
+}.show

data/samples/cairo/dashes.rb

@@ -0,0 +1,30 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Dashes'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+
+    dashes = [ 50.0, # ink
+                       10.0,  # skip
+                       10.0,  # ink
+                       10.0   # skip
+            ]
+    offset = -50.0
+    
+    path {
+      move_to 128.0, 25.6
+      line_to 230.4, 230.4
+      rel_line_to -102.4, 0.0
+      curve_to 51.2, 230.4, 51.2, 128.0, 128.0, 128.0
+      
+      line_width 10
+      dash dashes, offset
+      stroke 0, 0, 0
+    }
+  }
+}.show

data/samples/cairo/fill_and_stroke2.rb

@@ -0,0 +1,36 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Fill and Stroke 2'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    path {
+      move_to 128.0, 25.6
+      line_to 230.4, 230.4
+      rel_line_to -102.4, 0.0
+      curve_to 51.2, 230.4, 51.2, 128.0, 128.0, 128.0
+      close_path
+
+      fill 0, 0, 255
+      stroke 0, 0, 0
+      line_width 10
+    }
+    
+    path {
+      move_to 64.0, 25.6
+      rel_line_to 51.2, 51.2
+      rel_line_to -51.2, 51.2
+      rel_line_to -51.2, -51.2
+      close_path
+
+      fill 0, 0, 255
+      stroke 0, 0, 0
+      line_width 10
+    }
+  }
+}.show

data/samples/cairo/fill_style.rb

@@ -0,0 +1,43 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Fill Style'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    path {
+      rectangle 12, 12, 232, 70
+      path { # sub-path
+        arc 64, 64, 40, 0, 2*Math::PI
+      }
+      path { # sub-path
+        arc_negative 192, 64, 40, 0, -2*Math::PI
+      }
+      
+      fill_rule Cairo::FILL_RULE_EVEN_ODD
+      line_width 6
+      fill 0, 178.5, 0
+      stroke 0, 0, 0
+    }
+    
+    path {
+      rectangle 12, 12, 232, 70
+      path { # sub-path
+        arc 64, 64, 40, 0, 2*Math::PI
+      }
+      path { # sub-path
+        arc_negative 192, 64, 40, 0, -2*Math::PI
+      }
+      
+      translate 0, 128
+      fill_rule Cairo::FILL_RULE_WINDING
+      line_width 6
+      fill 0, 0, 229.5
+      stroke 0, 0, 0
+    }
+  }
+}.show

data/samples/cairo/gradient.rb

@@ -0,0 +1,31 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Gradient'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+        
+    # Create the Linear Pattern
+    rectangle(0, 0, 256, 256) {
+      pat = Cairo::LinearPattern.new(0.0, 0.0,  0.0, 256.0)
+      pat.add_color_stop_rgba(1, 0, 0, 0, 1)
+      pat.add_color_stop_rgba(0, 1, 1, 1, 1)
+      
+      fill pat
+    }
+    
+    # Create the radial pattern
+    arc(128.0, 128.0, 76.8, 0, 2 * Math::PI) {
+      pat = Cairo::RadialPattern.new(115.2, 102.4, 25.6,
+                                         102.4,  102.4, 128.0)
+      pat.add_color_stop_rgba(0, 1, 1, 1, 1)
+      pat.add_color_stop_rgba(1, 0, 0, 0, 1)
+      
+      fill pat
+    }
+  }
+}.show

data/samples/cairo/image.rb

@@ -0,0 +1,23 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Image'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+        
+    image = Cairo::ImageSurface.from_png(File.expand_path(File.join('..', '..', 'images', 'breaking-blue-wave.png'), __dir__))
+    w = image.width
+    h = image.height
+    
+    translate 128.0, 128.0
+    rotate 45*Math::PI/180
+    scale 256.0/w, 256.0/h
+    translate -0.5*w, -0.5*h
+    
+    paint image, 0, 0
+  }
+}.show

data/samples/cairo/image_gradient.rb

@@ -0,0 +1,32 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Image Gradient'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    image = Cairo::ImageSurface.from_png(File.expand_path(File.join('..', '..', 'images', 'breaking-blue-wave.png'), __dir__))
+    w = image.width
+    h = image.height
+    
+    # Load the image as a surface pattern
+    pattern = Cairo::SurfacePattern.new(image)
+    pattern.extend = Cairo::EXTEND_REPEAT
+    
+    # Set up the scale matrix
+    pattern.matrix = Cairo::Matrix.scale(w/256.0 * 5.0, h/256.0 * 5.0)
+    
+    rectangle(0, 0, 256, 256) {
+      translate 128.0, 128.0
+      rotate Math::PI / 4
+      scale 1/Math.sqrt(2), 1/Math.sqrt(2)
+      translate -128.0, -128.0
+        
+      fill pattern
+    }
+  }
+}.show

data/samples/cairo/multi_segment_caps.rb

@@ -0,0 +1,27 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Multi Segment Caps'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    path {
+      move_to 50.0, 75.0
+      line_to 200.0, 75.0
+      
+      move_to 50.0, 125.0
+      line_to 200.0, 125.0
+      
+      move_to 50.0, 175.0
+      line_to 200.0, 175.0
+      
+      line_width 30
+      line_cap Cairo::LINE_CAP_ROUND
+      stroke 0, 0, 0
+    }
+  }
+}.show

data/samples/cairo/rounded_rectangle.rb

@@ -0,0 +1,20 @@
+require 'glimmer-dsl-gtk'
+
+include Glimmer
+
+window {
+  title 'Rounded Rectangle'
+  default_size 256, 256
+  
+  drawing_area {
+    paint 242.25, 242.25, 242.25
+    
+    path {
+      rounded_rectangle(25.6, 25.6, 204.8, 204.8, 20)
+    
+      fill 127.5, 127.5, 255
+      line_width 10.0
+      stroke 127.5, 0, 0, 0.5
+    }
+  }
+}.show