glimmer-dsl-swt 4.20.6.0 → 4.20.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7ca988f6d990ae7520a2b6319c538a793f7499a23713e97ce02f32e3db2bec
-  data.tar.gz: a50dfa303380c6415d6a286f351a55931a4b1e09d73d7cc3e4602b52a00c179d
+  metadata.gz: 9a17e44008cc8425de7d3789c82e9bbaa11e0406e3f38ec71cee7f9427f07686
+  data.tar.gz: abfaa95510ebb353849d8659f55f5336aa1fd9b2653e4baf44fa156ba4524174
 SHA512:
-  metadata.gz: a8739fded7624fc8a007850dfa84fabeba144ffd3830fb83284e6abd733be75d8500da1be339d4827f30e14d702a4472f271198d90101d30573696f6a6dfdb14
-  data.tar.gz: c95d53ca9b574ec413b1630c2b415deb2fa3e65a091bc3d5d40b391b3c6083db5e74158c3f9d3572523682c4a02e75afee465ffef2e83f96cbc3bbc7e671698a
+  metadata.gz: 2c9c41491e55320002c349ae791073ec386237d63d07dc8737bbc8ecee37e29fbebef3ed8b4b333577ac8627e128fc54ff7da96720ca7db1fbad7ae4f49d7a96
+  data.tar.gz: 8a327ae96049e238fc36b40531e7bc9ae0d12303adae5183a4428de8cd3d39f49ef7ede3162b1b44a57102769f469200c556e394154eb65aba148679976ee12f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+### 4.20.7.0
+
+- Add Canvas Animation DSL #finished, #finished?, #finished= properties
+- Update Hello, Canvas Animation! (formerly had Data Binding suffix)
+- Update Hello, Canvas Animation Multi! (formerly did not have Multi suffix)
+
 ### 4.20.6.0
 
 - Canvas Animation DSL: support parallel animations per canvas (running along canvas static shapes too)

data/VERSION

@@ -1 +1 @@
-4.20.6.0
+4.20.7.0

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -2247,7 +2247,7 @@ Glimmer provides built-in support for animations via a declarative Animation DSL
 
 Animations take advantage of multi-threading, with Glimmer DSL for SWT automatically running each animation in its own independent thread of execution while updating the GUI asynchronously.
 
-Multiple simultaneous animations are supported per `canvas` (or widget) parent (they do not compete or starve each other).
+Multiple simultaneous animations are supported per `canvas` (or widget) parent.
 
 `canvas` has the `:double_buffered` SWT style by default on platforms other than the Mac to ensure flicker-free rendering (Mac does not need it). If you need to disable it for whatever reason, just pass the `:none` SWT style instead (e.g. `canvas(:none)`)
 
@@ -2282,8 +2282,8 @@ Screenshot:
 Keywords:
 - `animation` declares an animation under a canvas, which renders frames using a frame block indefinitely or finitely depending on (cycle_count/frame_count) properties
 - `every` specifies delay in seconds between every two frame renders
-- `frame` a block that can contain Shape DSL syntax that is rendered dynamically with variables calculated on the fly
-- `cycle` a property that takes an array to cycle into a second variable for the `frame` block
+- `frame {|index, cycle_var| }` a block that can contain Shape DSL syntax that is rendered dynamically with variables calculated on the fly
+- `cycle` an optional property that takes an array to cycle into a second variable for the `frame` block
 - `cycle_count` an optional cycle count limit after which the animation stops
 - `frame_count` an optional frame count limit after which the animation stops
 - `started` a boolean indicating if the animation is started right away or stopped waiting for manual startup via `#start` method

data/docs/reference/GLIMMER_SAMPLES.md

@@ -39,7 +39,7 @@
     - [Hello, Code Text!](#hello-code-text)
     - [Hello, Canvas!](#hello-canvas)
     - [Hello, Canvas Animation!](#hello-canvas-animation)
-    - [Hello, Canvas Animation Data Binding!](#hello-canvas-animation-data-binding)
+    - [Hello, Canvas Animation Multi!](#hello-canvas-animation-multi)
     - [Hello, Canvas Transform!](#hello-canvas-transform)
     - [Hello, Canvas Path!](#hello-canvas-path)
     - [Hello, Canvas Data Binding!](#hello-canvas-data-binding)
@@ -743,31 +743,27 @@ Hello, Canvas! Data-Binding (changing a `text` shape `string` via data-binding c
 
 #### Hello, Canvas Animation!
 
-This sample demonstrates the use of the `canvas` widget and [Animation DSL](#canvas-animation-dsl) in Glimmer.
+This sample demonstrates the use of the [Canvas Animation DSL](#canvas-animation-dsl) with data-binding.
 
 Code:
 
-[samples/hello/hello_canvas_animation.rb](/samples/hello/hello_canvas_animation.rb)
+[samples/hello/hello_canvas_animation_data_binding.rb](/samples/hello/hello_canvas_animation_data_binding.rb)
 
 Hello, Canvas Animation!
 
-![Hello Canvas Animation](/images/glimmer-hello-canvas-animation.png)
-
-Hello, Canvas Animation Another Frame!
+![Hello Canvas Animation Data Binding](/images/glimmer-hello-canvas-animation.gif)
 
-![Hello Canvas Animation Frame 2](/images/glimmer-hello-canvas-animation-frame2.png)
+#### Hello, Canvas Animation Multi!
 
-#### Hello, Canvas Animation Data Binding!
-
-This sample demonstrates the use of the [Canvas Animation DSL](#canvas-animation-dsl) with data-binding.
+This sample demonstrates parallel animations in the [Canvas Animation DSL](/docs/reference/GLIMMER_GUI_DSL_SYNTAX#canvas-animation-dsl).
 
 Code:
 
-[samples/hello/hello_canvas_animation_data_binding.rb](/samples/hello/hello_canvas_animation_data_binding.rb)
+[samples/hello/hello_canvas_animation_multi.rb](/samples/hello/hello_canvas_animation_multi.rb)
 
-Hello, Canvas Animation Data Binding!
+Hello, Canvas Animation Multi!
 
-![Hello Canvas Animation Data Binding](/images/glimmer-hello-canvas-animation-data-binding.gif)
+![Hello Canvas Animation Multi](/images/glimmer-hello-canvas-animation-multi.gif)
 
 #### Hello, Canvas Transform!
 

data/lib/glimmer/swt/custom/animation.rb

@@ -28,6 +28,7 @@ module Glimmer
       # Represents an animation declaratively
       class Animation
         include Properties
+        include Glimmer::DataBinding::ObservableModel
         
         class << self
           def schedule_frame_animation(animation, &frame_animation_block)
@@ -77,18 +78,19 @@ module Glimmer
           end
         end
         
-        attr_reader :parent, :options, :frame_index, :cycle
+        attr_reader :parent, :options
+        attr_accessor :frame_index, :cycle, :frame_block, :every, :cycle_count, :frame_count, :started, :duration_limit, :duration, :finished, :cycle_count_index
         alias current_frame_index frame_index
-        attr_accessor :frame_block, :every, :cycle_count, :frame_count, :started, :duration_limit
         alias started? started
+        alias finished? finished
         # TODO consider supporting an async: false option
         
         def initialize(parent)
           @parent = parent
           @parent.requires_shape_disposal = true
-          @started = true
-          @frame_index = 0
-          @cycle_count_index = 0
+          self.started = true
+          self.frame_index = 0
+          self.cycle_count_index = 0
           @start_number = 0 # denotes the number of starts (increments on every start)
           self.class.swt_display # ensures initializing variable to set from GUI thread
         end
@@ -111,9 +113,10 @@ module Glimmer
         def start
           return if @start_number > 0 && started?
           @start_number += 1
-          @started = true
           @start_time = Time.now
           @original_start_time = @start_time if @duration.nil?
+          self.finished = false if finished?
+          self.started = true
           # TODO track when finished in a variable for finite animations (whether by frame count, cycle count, or duration limit)
           Thread.new do
             start_number = @start_number
@@ -132,16 +135,16 @@ module Glimmer
         
         def stop
           return if stopped?
-          @started = false
-          @duration = (Time.now - @start_time) + @duration.to_f if duration_limited? && !@start_time.nil?
+          self.started = false
+          self.duration = (Time.now - @start_time) + @duration.to_f if duration_limited? && !@start_time.nil?
         end
         
         # Restarts an animation (whether indefinite or not and whether stopped or not)
         def restart
           @original_start_time = @start_time = nil
-          @duration = nil
-          @frame_index = 0
-          @cycle_count_index = 0
+          self.duration = nil
+          self.frame_index = 0
+          self.cycle_count_index = 0
           stop
           start
         end
@@ -183,6 +186,21 @@ module Glimmer
           end
         end
         
+        def cycle_count_index=(value)
+          @cycle_count_index = value
+          self.finished = true if cycle_limited? && @cycle_count_index == @cycle_count
+        end
+        
+        def frame_index=(value)
+          @frame_index = value
+          self.finished = true if frame_count_limited? && @frame_index == @frame_count
+        end
+        
+        def duration=(value)
+          @duration = value
+          self.finished = true if surpassed_duration_limit?
+        end
+        
         def cycle_enabled?
           @cycle.is_a?(Array)
         end
@@ -196,7 +214,7 @@ module Glimmer
         end
         
         def frame_count_limited?
-          @frame_count.is_a?(Integer)
+          @frame_count.is_a?(Integer) && @frame_count > 0
         end
         
         def surpassed_duration_limit?
@@ -211,11 +229,13 @@ module Glimmer
         
         # Returns true on success of painting a frame and false otherwise
         def draw_frame(start_number)
-          return false if stopped? ||
-                          start_number != @start_number ||
-                          (frame_count_limited? && @frame_index == @frame_count) ||
-                          (cycle_limited? && @cycle_count_index == @cycle_count) ||
-                          surpassed_duration_limit?
+          if stopped? or
+              (start_number != @start_number) or
+              (frame_count_limited? && @frame_index == @frame_count) or
+              (cycle_limited? && @cycle_count_index == @cycle_count) or
+              surpassed_duration_limit?
+            return false
+          end
           block_args = [@frame_index]
           block_args << @cycle[@frame_index % @cycle.length] if cycle_enabled?
           current_frame_index = @frame_index
@@ -231,16 +251,16 @@ module Glimmer
                 @shapes = @parent.shapes - parent_shapes_before
               end
             else
+              self.finished = true if surpassed_duration_limit?
               if stopped? && @frame_index > current_frame_index
-                @started = false
-                @frame_index = current_frame_index
-                @cycle_count_index = current_cycle_count_index
+                self.frame_index = current_frame_index
+                self.cycle_count_index = current_cycle_count_index
               end
             end
           end
-          @frame_index += 1
-          @cycle_count_index += 1 if cycle_limited? && (@frame_index % @cycle&.length&.to_i) == 0
-          sleep(every) if every.is_a?(Numeric)
+          self.frame_index += 1
+          self.cycle_count_index += 1 if cycle_limited? && (@frame_index % @cycle&.length&.to_i) == 0
+          sleep(every) if every.is_a?(Numeric) # TODO consider using timer_exec as a more reliable alternative
           true
         rescue => e
           Glimmer::Config.logger.error {e}

data/samples/elaborate/meta_sample.rb

@@ -207,6 +207,8 @@ class MetaSampleApplication
       image File.expand_path('../../icons/scaffold_app.png', __dir__)
       
       sash_form {
+        weights 4, 14
+      
         composite {
           grid_layout(1, false) {
             margin_width 0
@@ -282,8 +284,6 @@ class MetaSampleApplication
           left_margin 7
           right_margin 7
         }
-        
-        weights 4, 11
       }
     }
   }

data/samples/hello/hello_canvas_animation.rb

@@ -20,90 +20,89 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer-dsl-swt'
+require 'bigdecimal'
 
-include Glimmer
-
-shell {
-  text 'Hello, Canvas Animation!'
-  minimum_size 1200, 420
-
-  canvas {
-    background :white
-    
-    animation {
-      every 0.01 # in seconds (one hundredth)
-            
-      frame { |index| # frame block loops indefinitely (unless frame_count is set to an integer)
-        oval(0, 0, 400, 400) { # x, y, width, height
-          foreground :black # sets oval background color
-        }
-        arc(0, 0, 400, 400, -1.4*index%360, 10) {  # x, y, width, height, start angle, arc angle
-          background rgb(50, 200, 50) # sets arc background color
-        }
-      }
-    }
+class HelloCanvasAnimation
+  include Glimmer::UI::CustomShell
+  
+  # data-bindable attributes (names must vary from attribute names on animation)
+  attr_accessor :animation_every, :animation_frame_count, :animation_started, :animation_finished
+  
+  before_body {
+    @animation_every = 0.050
+    @animation_frame_count = 100
+    @animation_started = true
+    @animation_finished = false
   }
-
-  canvas {
-    background :white
-    
-    colors = [:yellow, :red]
-    
-    animation {
-      every 0.25 # in seconds (one quarter)
-      cycle colors # cycles array of colors into the second variable of the frame block below
-
-      frame { |index, color| # frame block loops indefinitely (unless frame_count or cycle_count is set to an integer)
-        outside_color = colors[index % 2]
-        inside_color = colors[(index + 1) % 2]
-
-        background outside_color # sets canvas background color
-
-        rectangle(0, 0, 200, 200) {
-          background inside_color # sets rectangle background color
-        }
-        rectangle(200, 200, 200, 200) {
-          background inside_color # sets rectangle background color
-        }
+  
+  body {
+    shell {
+      grid_layout(2, true)
+      text 'Hello, Canvas Animation!'
+      
+      button {
+        layout_data(:fill, :center, true, false)
+        text <= [self, :animation_started, on_read: ->(value) { value ? 'Stop' : 'Resume' }]
+        enabled <= [self, :animation_finished, on_read: :!]
+        
+        on_widget_selected do
+          if @animation.started?
+            @animation.stop
+          else
+            @animation.start
+          end
+        end
       }
-    }
-  }
-
-  canvas {
-    background :white
-    
-    colors = [:yellow, :red]
-    
-    animation {
-      every 0.25 # in seconds (one quarter)
-      cycle colors # cycles array of colors into the second variable of the frame block below
-
-      frame { |index, color| # frame block loops indefinitely (unless frame_count or cycle_count is set to an integer)
-        outside_color = colors[index % 2]
-        inside_color = colors[(index + 1) % 2]
-
-        background outside_color # sets canvas background color
-
-        rectangle(0, 0, 200, 200) {
-          background inside_color # sets rectangle background color
-        }
-        rectangle(200, 200, 200, 200) {
-          background inside_color # sets rectangle background color
-        }
+      button {
+        layout_data(:fill, :center, true, false)
+        text 'Restart'
+        
+        on_widget_selected do
+          @animation.restart
+        end
       }
-    }
-    
-    animation {
-      every 0.01 # in seconds (one hundredth)
-            
-      frame { |index| # frame block loops indefinitely (unless frame_count is set to an integer)
-        oval(0, 0, 400, 400) { # x, y, width, height
-          foreground :black # sets oval background color
+      label {
+        text 'every (milliseconds)'
+      }
+      label {
+        text 'frame count (0 is unlimited)'
+      }
+      spinner {
+        layout_data(:fill, :center, true, false)
+        digits 3
+        minimum 1
+        maximum 100
+        selection <=> [self, :animation_every, on_read: ->(v) {(BigDecimal(v.to_s)*1000).to_f}, on_write: ->(v) {(BigDecimal(v.to_s)/1000).to_f}]
+      }
+      spinner {
+        layout_data(:fill, :center, true, false)
+        minimum 0
+        maximum 100
+        selection <=> [self, :animation_frame_count]
+      }
+      
+      canvas {
+        layout_data(:fill, :fill, true, true) {
+          horizontal_span 2
+          width_hint 320
+          height_hint 320
         }
-        arc(0, 0, 400, 400, -1.4*index%360, 10) {  # x, y, width, height, start angle, arc angle
-          background rgb(50, 200, 50) # sets arc background color
+        @animation = animation {
+          every <= [self, :animation_every]
+          frame_count <= [self, :animation_frame_count]
+          started <=> [self, :animation_started]
+          finished <=> [self, :animation_finished]
+          
+          frame { |index|
+            background rgb(index%100, index%100 + 100, index%55 + 200)
+            oval(index*3%300, index*3%300, 20, 20) {
+              background :yellow
+            }
+          }
         }
       }
     }
   }
-}.open
+end
+
+HelloCanvasAnimation.launch

data/samples/hello/hello_canvas_animation_multi.rb

@@ -0,0 +1,109 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# 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.
+
+require 'glimmer-dsl-swt'
+
+include Glimmer
+
+shell {
+  text 'Hello, Canvas Animation Multi!'
+  minimum_size 1200, 420
+
+  canvas {
+    background :white
+    
+    animation {
+      every 0.01 # in seconds (one hundredth)
+            
+      frame { |index| # frame block loops indefinitely (unless frame_count is set to an integer)
+        oval(0, 0, 400, 400) { # x, y, width, height
+          foreground :black # sets oval background color
+        }
+        arc(0, 0, 400, 400, -1.4*index%360, 10) {  # x, y, width, height, start angle, arc angle
+          background rgb(50, 200, 50) # sets arc background color
+        }
+      }
+    }
+  }
+
+  canvas {
+    background :white
+    
+    colors = [:yellow, :red]
+    
+    animation {
+      every 0.25 # in seconds (one quarter)
+      cycle colors # cycles array of colors into the second variable of the frame block below
+
+      frame { |index, color| # frame block loops indefinitely (unless frame_count or cycle_count is set to an integer)
+        outside_color = colors[index % 2]
+        inside_color = colors[(index + 1) % 2]
+
+        background outside_color # sets canvas background color
+
+        rectangle(0, 0, 200, 200) {
+          background inside_color # sets rectangle background color
+        }
+        rectangle(200, 200, 200, 200) {
+          background inside_color # sets rectangle background color
+        }
+      }
+    }
+  }
+
+  canvas {
+    background :white
+    
+    colors = [:yellow, :red]
+    
+    animation {
+      every 0.25 # in seconds (one quarter)
+      cycle colors # cycles array of colors into the second variable of the frame block below
+
+      frame { |index, color| # frame block loops indefinitely (unless frame_count or cycle_count is set to an integer)
+        outside_color = colors[index % 2]
+        inside_color = colors[(index + 1) % 2]
+
+        background outside_color # sets canvas background color
+
+        rectangle(0, 0, 200, 200) {
+          background inside_color # sets rectangle background color
+        }
+        rectangle(200, 200, 200, 200) {
+          background inside_color # sets rectangle background color
+        }
+      }
+    }
+    
+    animation {
+      every 0.01 # in seconds (one hundredth)
+            
+      frame { |index| # frame block loops indefinitely (unless frame_count is set to an integer)
+        oval(0, 0, 400, 400) { # x, y, width, height
+          foreground :black # sets oval background color
+        }
+        arc(0, 0, 400, 400, -1.4*index%360, 10) {  # x, y, width, height, start angle, arc angle
+          background rgb(50, 200, 50) # sets arc background color
+        }
+      }
+    }
+  }
+}.open

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swt
 version: !ruby/object:Gem::Version
-  version: 4.20.6.0
+  version: 4.20.7.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -574,7 +574,7 @@ files:
 - samples/hello/hello_c_tab.rb
 - samples/hello/hello_canvas.rb
 - samples/hello/hello_canvas_animation.rb
-- samples/hello/hello_canvas_animation_data_binding.rb
+- samples/hello/hello_canvas_animation_multi.rb
 - samples/hello/hello_canvas_data_binding.rb
 - samples/hello/hello_canvas_path.rb
 - samples/hello/hello_canvas_transform.rb

data/samples/hello/hello_canvas_animation_data_binding.rb

@@ -1,66 +0,0 @@
-# Copyright (c) 2007-2021 Andy Maleh
-#
-# 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.
-
-require 'glimmer-dsl-swt'
-require 'bigdecimal'
-
-class HelloAnimationDataBinding
-  include Glimmer::UI::CustomShell
-  
-  attr_accessor :delay_time
-  
-  before_body {
-    @delay_time = 0.050
-  }
-  
-  body {
-    shell {
-      text 'Hello, Canvas Animation Data Binding!'
-      minimum_size 320, 320
-      
-      canvas {
-        grid_layout
-        
-        spinner {
-          layout_data(:center, :center, true, true) {
-            minimum_width 75
-          }
-          digits 3
-          minimum 1
-          maximum 100
-          selection <=> [self, :delay_time, on_read: ->(v) {(BigDecimal(v.to_s)*1000).to_f}, on_write: ->(v) {(BigDecimal(v.to_s)/1000).to_f}]
-        }
-        animation {
-          every <= [self, :delay_time]
-          
-          frame { |index|
-            background rgb(index%100, index%100 + 100, index%55 + 200)
-            oval(index*3%300, index*3%300, 20, 20) {
-              background :yellow
-            }
-          }
-        }
-      }
-    }
-  }
-end
-
-HelloAnimationDataBinding.launch