dyi 1.2.1 → 1.3.0

data/lib/dyi/formatter/svg_formatter.rb

@@ -62,13 +62,13 @@ module DYI
           @canvas.add_initialize_script(Script::EcmaScript::DomLevel2.draw_text_border(*@text_border_elements))
         end
         attrs = @xmlns.merge(:version => @version,
-                             :width => canvas.real_width,
-                             :height => canvas.real_height,
-                             :viewBox => canvas.view_box,
-                             :preserveAspectRatio => canvas.preserve_aspect_ratio)
-        attrs[:'pointer-events'] = 'none' if canvas.receive_event?
-        attrs[:class] = canvas.css_class if canvas.css_class
-        canvas.event_listeners.each do |event_name, listeners|
+                             :width => @canvas.real_width,
+                             :height => @canvas.real_height,
+                             :viewBox => @canvas.view_box,
+                             :preserveAspectRatio => @canvas.preserve_aspect_ratio)
+        attrs[:'pointer-events'] = 'none' if @canvas.receive_event?
+        attrs[:class] = @canvas.css_class if @canvas.css_class
+        @canvas.event_listeners.each do |event_name, listeners|
           unless listeners.empty?
             methods = listeners.map do |listener|
                         if listener.name
@@ -81,43 +81,42 @@ module DYI
         end
         sio = StringIO.new
         create_node(sio, 'svg', attrs) {
-          create_leaf_node(sio, 'title', canvas.title) if canvas.title
-          create_leaf_node(sio, 'desc', canvas.description) if canvas.description
-          if canvas.metadata
+          create_leaf_node(sio, 'title', @canvas.title) if @canvas.title
+          create_leaf_node(sio, 'desc', @canvas.description) if @canvas.description
+          if @canvas.metadata
             create_cdata_node(sio, 'metadata'){
               puts_line(sio) {
-                write_metadata(canvas.metadata, sio)
+                write_metadata(@canvas.metadata, sio)
               }
             }
           end
           @root_info = [sio.pos, @level]
           i = 0
-          length = canvas.scripts.size
+          length = @canvas.scripts.size
           while i < length
-            script = canvas.scripts[i]
+            script = @canvas.scripts[i]
             if script.include_external_file?
               create_leaf_node(sio, 'script',
                                :'xlink:href' => script.href,
                                :type => script.content_type)
               break if length <= (i += 1)
-              script = canvas.scripts[i]
             else
               content_type = script.content_type
               create_cdata_node(sio, 'script',
                                 :type => content_type) {
                 sio << script.contents
                 if (i += 1) < length
-                  script = canvas.scripts[i]
+                  script = @canvas.scripts[i]
                   while !script.has_uri_reference? && content_type == script.content_type
                     sio << script.contents
                     break if length <= (i += 1)
-                    script = canvas.scripts[i]
+                    script = @canvas.scripts[i]
                   end
                 end
               }
             end
           end
-          canvas.child_elements.each do |element|
+          @canvas.child_elements.each do |element|
             element.write_as(self, sio)
           end
         }
@@ -330,6 +329,31 @@ module DYI
         end
       end
 
+      # @since 1.3.0
+      def write_template(shape, io)
+        unless shape.child_elements.empty?
+          attrs = {:viewBox => shape.view_box,
+                   :preserveAspectRatio => shape.preserve_aspect_ratio}
+          attrs.merge!(common_attributes(shape))
+          write_node(shape, io, attrs, 'symbol') {
+            shape.child_elements.each do |element|
+              element.write_as(self, io)
+            end
+          }
+        end
+      end
+
+      # @since 1.3.0
+      def write_reused_shape(shape, io)
+        attrs = {:x=>shape.left,
+                 :y=>shape.top,
+                 :'xlink:href'=>"##{shape.source_element.id}"}
+        attrs[:width] = shape.width if shape.width
+        attrs[:height] = shape.height if shape.height
+        attrs.merge!(common_attributes(shape))
+        write_node(shape, io, attrs, 'use')
+      end
+
       def write_linear_gradient(shape, io)
         attrs = {:id => @defs.find{|key, value| value==shape}[0],
                  :gradientUnit => 'objectBoundingBox',
@@ -345,6 +369,23 @@ module DYI
         }
       end
 
+      # @since 1.3.0
+      def write_radial_gradient(shape, io)
+        attrs = {:id => @defs.find{|key, value| value==shape}[0],
+                 :gradientUnit => 'objectBoundingBox',
+                 :cx => shape.center_point.x,
+                 :cy => shape.center_point.y,
+                 :r => shape.radius,
+                 :fx => shape.focal_point.x,
+                 :fy => shape.focal_point.y}
+        attrs[:"spreadMethod"] = shape.spread_method if shape.spread_method
+        create_node(io, 'radialGradient', attrs) {
+          shape.child_elements.each do |element|
+            element.write_as(self, io)
+          end
+        }
+      end
+
       def write_gradient_stop(shape, io)
         attrs = {:offset=>shape.offset}
         attrs[:"stop-color"] = shape.color if shape.color
@@ -380,11 +421,24 @@ module DYI
 
       # @since 1.0.0
       def write_painting_animation(anim, shape, io)
-        anim.animation_attributes.each do |anim_attr, (from_value, to_value)|
+        anim.animation_attributes.each do |anim_attr, values|
           attrs = {:attributeName => name_to_attribute(anim_attr),
                    :attributeType => 'CSS'}
-          attrs[:from] = from_value if from_value
-          attrs[:to] = to_value
+          if values.size == 2
+            attrs[:from] = values[0] if values[0]
+            attrs[:to] = values[1]
+          else
+            attrs[:values] = values.join(';')
+            key_times = [0].push(*anim.relay_times[0, anim.relays.size])
+            if anim.relay_times.size < anim.relays.size
+              step = (1.0 - key_times.last) / (anim.relays.size - anim.relay_times.size + 1)
+              (anim.relays.size - anim.relay_times.size).times do |i|
+                key_times << key_times.last + step
+              end
+            end
+            key_times << 1
+            attrs[:keyTimes] = key_times.map{|num| num.strfnum('0.###')}.join(';')
+          end
           merge_anim_attributes(anim, shape, attrs)
           if anim.duration && anim.duration != 0
             create_leaf_node(io, 'animate', attrs)
@@ -399,12 +453,26 @@ module DYI
         attrs = {:attributeName => 'transform',
                  :attributeType => 'XML',
                  :type => anim.type}
-        if anim.from.is_a?(Array)
-          attrs[:from] = anim.from.join(',')
-        elsif anim.from
-          attrs[:from] = anim.from.to_s
+        if anim.relays.empty?
+          if anim.from.is_a?(Array)
+            attrs[:from] = anim.from.join(',')
+          elsif anim.from
+            attrs[:from] = anim.from.to_s
+          end
+          attrs[:to] = anim.to.is_a?(Array) ? anim.to.join(',') : anim.to.to_s
+        else
+          values = [anim.from].push(*anim.relays).push(anim.to)
+          attrs[:values] = values.map{|v| v.is_a?(Array) ? v.join(',') : v.to_s}.join(';')
+          key_times = [0].push(*anim.relay_times[0, anim.relays.size])
+          if anim.relay_times.size < anim.relays.size
+            step = (1.0 - key_times.last) / (anim.relays.size - anim.relay_times.size + 1)
+            (anim.relays.size - anim.relay_times.size).times do |i|
+              key_times << key_times.last + step
+            end
+          end
+          key_times << 1
+          attrs[:keyTimes] = key_times.map{|num| num.strfnum('0.###')}.join(';')
         end
-        attrs[:to] = anim.to.is_a?(Array) ? anim.to.join(',') : anim.to.to_s
         merge_anim_attributes(anim, shape, attrs)
         if anim.duration && anim.duration != 0
           create_leaf_node(io, 'animateTransform', attrs)
@@ -586,6 +654,13 @@ module DYI
             end
           end
         end
+        if element.respond_to?(:source_element) && element.source_element
+          source_element = element.source_element
+          unless source_element.canvas == @canvas || @defs.value?(source_element)
+            def_id = source_element.id || (source_element.id = @canvas.publish_shape_id)
+            @defs[def_id] = source_element
+          end
+        end
         element.child_elements.each do |child_element|
           examin_descendant_elements(child_element)
         end
@@ -636,6 +711,19 @@ module DYI
         attrs[:fill] = anim.fill if anim.fill
         attrs[:additive] = anim.additive if anim.additive
         attrs[:restart] = anim.restart if anim.restart
+        attrs[:calcMode] = anim.calc_mode if anim.calc_mode
+        if anim.repeat_count
+          count = anim.repeat_count
+          attrs[:repeatCount] =
+              if count.zero? || count.infinite?
+                'indefinite'
+              else
+                anim.repeat_count
+              end
+        end
+        if anim.key_splines && !anim.key_splines.empty?
+          attrs[:keySplines] = anim.key_splines.each_slice(4).map{|nums| nums.join(' ')}.join(';')
+        end
       end
 
       def name_to_attribute(name)

data/lib/dyi/shape.rb

@@ -24,6 +24,8 @@
 base
 path
 marker
+reused_shape
+graphical_template
 
 ).each do |file_name|
   require File.join(File.dirname(__FILE__), 'shape', file_name)

data/lib/dyi/shape/base.rb

@@ -390,6 +390,8 @@ module DYI
         @anchor_target = options.delete(:anchor_target)
         self.css_class = options.delete(:css_class)
         self.id = options.delete(:id) if options[:id]
+        self.description = options.delete(:description) if options[:description]
+        self.title = options.delete(:title) if options[:title]
         options
       end
     end
@@ -404,14 +406,16 @@ module DYI
       # Returns heigth of the rectangle.
       attr_length :height
 
-      # @param [Coordinate] left_top a coordinate of a corner of the rectangle
+      # @param [Coordinate] left_top a left-top coordinate of the rectangle
       # @param [Length] width width of the rectangle
       # @param [Length] heigth heigth of the rectangle
-      # @option options [Painting] :painting painting status of the rectangle
+      # @option options [Painting] :painting painting status of this shape
       # @option options [Length] :rx the x-axis radius of the ellipse for
       #   rounded the rectangle
       # @option options [Length] :ry the y-axis radius of the ellipse for
       #   rounded the rectangle
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(left_top, width, height, options={})
         width = Length.new(width)
         height = Length.new(height)
@@ -468,7 +472,7 @@ module DYI
         # @param [Coordinate] left_top a coordinate of a corner of the rectangle
         # @param [Length] width width of the rectangle
         # @param [Length] heigth heigth of the rectangle
-        # @option options [Painting] :painting painting status of the rectangle
+        # @option options [Painting] :painting painting status of the shape
         # @option options [Length] :rx the x-axis radius of the ellipse for
         #   rounded the rectangle
         # @option options [Length] :ry the y-axis radius of the ellipse for
@@ -508,6 +512,11 @@ module DYI
       # Returns a radius of the circle.
       attr_length :radius
 
+      # @param [Coordinate] center a center coordinate of the circle
+      # @param [Length] radius a radius length of the circle
+      # @option options [Painting] :painting painting status of this shape
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(center, radius, options={})
         @center = Coordinate.new(center)
         @radius = Length.new(radius).abs
@@ -556,6 +565,12 @@ module DYI
       attr_coordinate :center
       attr_length :radius_x, :radius_y
 
+      # @param [Coordinate] center a center coordinate of the ellipse
+      # @param [Length] radius_x an x-axis radius of the ellipse
+      # @param [Length] radius_y a y-axis radius of the ellipse
+      # @option options [Painting] :painting painting status of this shape
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(center, radius_x, radius_y, options={})
         @center = Coordinate.new(center)
         @radius_x = Length.new(radius_x).abs
@@ -605,6 +620,11 @@ module DYI
       include Markable
       attr_coordinate :start_point, :end_point
 
+      # @param [Coordinate] start_point a start coordinate of the line
+      # @param [Coordinate] end_point an end coordinate of the line
+      # @option options [Painting] :painting painting status of this shape
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(start_point, end_point, options={})
         @start_point = Coordinate.new(start_point)
         @end_point = Coordinate.new(end_point)
@@ -651,6 +671,10 @@ module DYI
     class Polyline < Base
       include Markable
 
+      # @param [Coordinate] start_point a start coordinate of the shape
+      # @option options [Painting] :painting painting status of this shape
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(start_point, options={})
         @points = [Coordinate.new(start_point)]
         @attributes = init_attributes(options)
@@ -715,6 +739,13 @@ module DYI
     class Image < Rectangle
       attr_reader :file_path
 
+      # @param [Coordinate] left_top a left-top coordinate of the image
+      # @param [Length] width width of the image
+      # @param [Length] heigth heigth of the image
+      # @param [String] file_path a file path of the image
+      # @option options [Painting] :painting painting status of this shape
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(left_top, width, height, file_path, options={})
         super(left_top, width, height, options)
         @file_path = file_path
@@ -745,6 +776,12 @@ module DYI
       attr_accessor :text
       attr_reader :format
 
+      # @param [Coordinate] point a start coordinate of the text
+      # @param [String] text a text that is displayed
+      # @option options [Painting] :painting painting status of the shape
+      # @option options [Font] :font font status of the text
+      # @option options [String] :description the description of this shape
+      # @option options [String] :title the title of this shape
       def initialize(point, text=nil, options={})
         @point = Coordinate.new(point || [0,0])
         @text = text
@@ -796,6 +833,8 @@ module DYI
     class ShapeGroup < Base
       attr_reader :child_elements
 
+      # @option options [String] :description the description of this group
+      # @option options [String] :title the title of this group
       def initialize(options={})
         @attributes = init_attributes(options)
         @child_elements = []

data/lib/dyi/shape/graphical_template.rb

@@ -0,0 +1,106 @@
+# -*- encoding: UTF-8 -*-
+
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
+#
+# Author:: Mamoru Yuo
+#
+# This file is part of DYI.
+#
+# DYI is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# DYI is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with DYI.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module DYI
+
+  module Shape
+
+    # The body of Vector-Image. This class is a container for all graphical
+    # elements that make up the image.
+    # @since 1.3.0
+    class GraphicalTemplate < Base
+
+      # @private
+      IMPLEMENT_ATTRIBUTES = [:view_box, :preserve_aspect_ratio]
+
+      # Returns width of the vector-image on user unit.
+      attr_length :width
+
+      # Returns heigth of the vector-image on user unit.
+      attr_length :height
+
+      # @attribute view_box
+      # Returns the value of the view_box.
+      # @return [String]
+      #+++
+      # @attribute preserve_aspect_ratio
+      # Returns the value of the preserve_aspect_ratio.
+      # @return [String] the value of preserve_aspect_ratio
+      attr_reader *IMPLEMENT_ATTRIBUTES
+
+      # Returns an array of child elements.
+      # @return [Array<Element>] an array of child elements
+      attr_reader :child_elements
+
+      # Returns a metadata object that the image has.
+      # @return [Object] a metadata object that the image has.
+      attr_accessor :metadata
+
+      # @param [Length] width width of the canvas on user unit
+      # @param [Length] height height of the canvas on user unit
+      # @param [Length] real_width width of the image. When this value
+      #   is nil, uses a value that equals value of width parameter.
+      # @param [Length] real_height height of the image. When this value
+      #   is nil, uses a value that equals value of height parameter.
+      # @param [String] preserve_aspect_ratio value that indicates
+      #   whether or not to force uniform scaling
+      # @option options [String] :css_class CSS class of body element
+      def initialize(width, height,
+                     preserve_aspect_ratio='none', options={})
+        self.width = width
+        self.height = height
+        @view_box = "0 0 #{width} #{height}"
+        @preserve_aspect_ratio = preserve_aspect_ratio
+        @child_elements = []
+        self.css_class = options[:css_class]
+      end
+
+      # Returns whether this instance is root element of the shape.
+      # @return [Boolean] always true.
+      def root_element?
+        false
+      end
+
+      # Writes image on io object.
+      # @param [Formatter::Base] formatter an object that defines the image format
+      # @param [IO] io an io to be written
+      def write_as(formatter, io=$>)
+        formatter.write_template(self, io)
+      end
+
+      def instantiate_on(parent, left_top, options={})
+        Shape::ReusedShape.new(self, left_top, options).draw_on(parent)
+      end
+
+      # Returns optional attributes.
+      # @return [Hash] optional attributes
+      def attributes
+        IMPLEMENT_ATTRIBUTES.inject({}) do |hash, attribute|
+          variable_name = '@' + attribute.to_s.split(/(?=[A-Z])/).map{|str| str.downcase}.join('_')
+          value = instance_variable_get(variable_name)
+          hash[attribute] = value.to_s if value
+          hash
+        end
+      end
+    end
+  end
+end