dyi 1.1.1 → 1.1.2

data/lib/dyi/script/simple_script.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -18,15 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with DYI.  If not, see <http://www.gnu.org/licenses/>.
-#
-# == Overview
-#
-# This file provides the classes of client side scripting.  The event becomes
-# effective only when it is output by SVG format.
-#
-# @since 1.0.0
 
+#
 module DYI
+
+  # @since 1.0.0
   module Script
 
     # Class representing a inline-client-script.  The scripting becomes

data/lib/dyi/shape.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #

data/lib/dyi/shape/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -30,13 +30,9 @@ module DYI
     class Base < GraphicalElement
 
       # Returns painting status of the shape.
-      # @attribute painting
-      # @return [Painting] painting status
       attr_painting :painting
 
       # Returns font status of the shape.
-      # @attribute font
-      # @return [Font] font status
       attr_font :font
 
       # Returns optional attributes of the shape.
@@ -49,14 +45,17 @@ module DYI
 
       # Returns a parent element of the shape.
       # @return [GraphicalElement] a parent element
+      # @since 1.0.0
       attr_reader :parent
 
       # Returns a location of a reference of a source anchor for the link.
       # @return [String] a location of a reference
+      # @since 1.0.0
       attr_accessor :anchor_href
 
       # Returns a relevant presentation context when the link is activated.
       # @return [String] a relevant presentation context
+      # @since 1.0.0
       attr_accessor :anchor_target
 
       # Draws the shape on a parent element.
@@ -122,7 +121,7 @@ module DYI
       # Scales up (or down) this shape.
       # @param [Numeric] x scaled ratio along x-axis
       # @param [Numeric] y scaled ratio along y-axis. If this parameter is nil,
-      #   uses value that equals to parameter `x' value
+      #   uses value that equals to parameter 'x' value
       # @param [Coordinate] base_point based coordinate of scaling up (or down)
       def scale(x, y=nil, base_point=Coordinate::ZERO)
         y ||= x
@@ -235,7 +234,7 @@ module DYI
       #   animation end, in seconds
       # @option options [Event] :end_event an event that determine the animation
       #   end
-      # @option options [String] :fill `freeze' or `remove'
+      # @option options [String] :fill 'freeze' or 'remove'
       # @since 1.0.0
       def add_painting_animation(options)
         add_animation(Animation::PaintingAnimation.new(self, options))
@@ -255,7 +254,7 @@ module DYI
       #   animation end, in seconds
       # @option options [Event] :end_event an event that determine the animation
       #   end
-      # @option options [String] :fill `freeze' or `remove'
+      # @option options [String] :fill 'freeze' or 'remove'
       # @since 1.0.0
       def add_transform_animation(type, options)
         add_animation(Animation::TransformAnimation.new(self, type, options))
@@ -303,13 +302,9 @@ module DYI
     class Rectangle < Base
 
       # Returns width of the rectangle.
-      # @attribute width
-      # @return [Length] width of the rectangle
       attr_length :width
 
       # Returns heigth of the rectangle.
-      # @attribute height
-      # @return [Length] heigth of the rectangle
       attr_length :height
 
       # @param [Coordinate] left_top a coordinate of a corner of the rectangle
@@ -411,13 +406,9 @@ module DYI
     class Circle < Base
 
       # Returns a center coordinate of the circle.
-      # @attribute center
-      # @return [Coordinate]  a center coordinate of the circle
       attr_coordinate :center
 
       # Returns a radius of the circle.
-      # @attribute radius
-      # @return [Length]  a radius of the circle
       attr_length :radius
 
       def initialize(center, radius, options={})
@@ -647,7 +638,7 @@ module DYI
 
     class Text < Base
       BASELINE_VALUES = ['baseline', 'top', 'middle', 'bottom']
-      DEFAULT_LINE_HEIGHT = 1
+      DEFAULT_LINE_HEIGHT = 1.0
       attr_coordinate :point
       attr_accessor :line_height
       attr_accessor :text

data/lib/dyi/shape/path.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -21,9 +21,39 @@
 
 require 'enumerator'
 
-module DYI #:nodoc:
-  module Shape #:nodoc:
-
+module DYI
+  module Shape
+
+    # +Path+ represent the outline of a shape.
+    #
+    # +Path+ object has a concept of a current point. In an analogy with drawing
+    # on paper, the current point can be thought of as the location of the pen.
+    # The position of the pen can be changed, and the outline of a shape (open
+    # or closed) can be traced by dragging the pen in either straight lines or
+    # curves.
+    #
+    # = Commands of Drawing Paths
+    #
+    # Lines or curves is drawn using following commad:
+    # * <b>_move_to_ commands</b> -- Method {#move_to} and {#rmove_to} establish
+    #   a new current point. The effect is as if the "pen" were lifted and moved
+    #   to a new location.
+    # * <b>_close_path_ command</b> -- Method {#close_path} ends the current
+    #   subpath and causes an automatic straight line to be drawn from the
+    #   current point to the initial point of the current subpath.
+    # * <b>_line_to_ commands</b> -- Method {#line_to} and {#rline_to} draw
+    #   straight lines from the current point to a new point.
+    # * <b>Cubic Bézier Curve commands</b> -- Method {#curve_to} and {#rcurve_to}
+    #   draw a cubic Bézier curve from the current point.
+    # * <b>Quadratic Bézier Curve commands</b> -- Method {#quadratic_curve_to}
+    #   and {#rquadratic_curve_to} draw a quadratic Bézier curve from the
+    #   current point.
+    # * <b>Elliptical Arc Curve commands</b> -- Method {#arc_to} and {#rarc_to}
+    #   draw an elliptical arc from the current point.
+    #
+    # See the documentation of each method for more infomation.
+    #
+    # @since 0.0.0
     class Path < Base
 
       def initialize(start_point, options={})
@@ -32,20 +62,63 @@ module DYI #:nodoc:
                        else PathData.new(start_point)
                      end
         @attributes = init_attributes(options)
-      end
-
+        @marker = {}
+      end
+
+      # Starts a new sub-path at a given point, which is specified a absolute
+      # coordinate. The new current points become the given point.
+      #
+      # When multiple points is given as arguments, starts a new sub-path at the
+      # first point and draws straight line to the subsequent points. (i.e.
+      # <tt>path.move_to(pt1,pt2,pt3,...)</tt> equals to <tt>path.move_to(pt1);
+      # path.line_to(pt2,pt3,...)</tt>)
+      # @param [Coordinate] point the absolute coordinate of the start point of
+      #   the new sub-path. The second and subsequent arguments are the absolute
+      #   point to which the line is drawn from previous point
+      # @see #rmove_to
       def move_to(*points)
         push_command(:move_to, *points)
       end
 
+      # Starts a new sub-path at a given point, which is specified a relative
+      # coordinate to current point. The new current point becomes the last
+      # given point.
+      #
+      # When multiple points is given as arguments, starts a new sub-path at the
+      # first point and draws straight line to the subsequent points. (i.e.
+      # <tt>path.move_to(pt1,pt2,pt3,...)</tt> equals to <tt>path.move_to(pt1);
+      # path.line_to(pt2,pt3,...)</tt>)
+      # @param [Coordinate] point the relative coordinate of the start point of
+      #   the new sub-path. The second and subsequent arguments are the relative
+      #   point to which the line is drawn from previous point
+      # @see #move_to
       def rmove_to(*points)
         push_command(:rmove_to, *points)
       end
 
+      # Draws straight lines from the current point, which is specified a
+      # absolute coordinate. The new current point becomes the last given point.
+      #
+      # When multiple points is given as argument, draws a polyline. (i.e.
+      # <tt>path.line_to(pt1,pt2,pt3,...)</tt> equals to <tt>path.line_to(pt1);
+      # path.line_to(pt2); path.line_to(pt3); ...</tt>)
+      # @param [Coordinate] point the absolute coordinate which the line is
+      #   drawn from current point to
+      # @see #rline_to
       def line_to(*points)
         push_command(:line_to, *points)
       end
 
+      # Draws straight lines from the current point, which is specified a
+      # relative coordinate to current point. The new current point becomes the
+      # last given point.
+      #
+      # When multiple points is given as arguments, draws a polyline. (i.e.
+      # <tt>path.rline_to(pt1,pt2,pt3,...)</tt> equals to <tt>path.rline_to(pt1);
+      # path.rline_to(pt2); path.rline_to(pt3); ...</tt>)
+      # @param [Coordinate] point the relavive coordinate which the line is
+      #   drawn from current point to
+      # @see #line_to
       def rline_to(*points)
         push_command(:rline_to, *points)
       end
@@ -141,6 +214,16 @@ module DYI #:nodoc:
       def bottom
         edge_coordinate(:bottom)
       end
+
+      # Returns whether this shape has a marker symbol.
+      # @param [Symbol] point_type the type of marker point. Specifies the
+      #   following values: +:start+, +:mid+, +:end+
+      # @return [Boolean] true if the shape has a marker at the cpecified point,
+      #   false otherwise
+      # @since 1.2.0
+      def has_marker?(point_type)
+        !@marker[point_type].nil?
+      end
 =begin
       def line_bezier_paths
         start_point = Coordinate::ZERO
@@ -313,7 +396,7 @@ module DYI #:nodoc:
         end
       end
 
-      class PathData #:nodoc:
+      class PathData
         include Enumerable
 
         def initialize(*points)
@@ -428,7 +511,7 @@ module DYI #:nodoc:
         end
       end
 
-      class CommandBase #:nodoc:
+      class CommandBase
         attr_reader :preceding_command, :point
 
         def initialize(relative, preceding_command, point)
@@ -484,7 +567,7 @@ module DYI #:nodoc:
         end
       end
 
-      class MoveCommand < CommandBase #:nodoc:
+      class MoveCommand < CommandBase
 
         def start_point
           last_point
@@ -517,7 +600,7 @@ module DYI #:nodoc:
         end
       end
 
-      class CloseCommand < CommandBase #:nodoc:
+      class CloseCommand < CommandBase
         def initialize(preceding_command)
           raise ArgumentError, 'preceding_command is nil' if preceding_command.nil?
           @relative = nil
@@ -554,7 +637,7 @@ module DYI #:nodoc:
         end
       end
 
-      class LineCommand < CommandBase #:nodoc:
+      class LineCommand < CommandBase
         def initialize(relative, preceding_command, point)
           raise ArgumentError, 'preceding_command is nil' if preceding_command.nil?
           super
@@ -579,7 +662,7 @@ module DYI #:nodoc:
         end
       end
 
-      class HorizontalLineCommand < LineCommand #:nodoc:
+      class HorizontalLineCommand < LineCommand
         def initialize(relative, preceding_command, x)
           super(relative, preceding_command, Coordinate.new(x, relative ? 0 : preceding_command.last_point.y))
         end
@@ -597,7 +680,7 @@ module DYI #:nodoc:
         end
       end
 
-      class VerticalLineCommand < LineCommand #:nodoc:
+      class VerticalLineCommand < LineCommand
         def initialize(relative, preceding_command, y)
           super(relative, preceding_command, Coordinate.new(relative ? 0 : preceding_command.last_point.x, y))
         end
@@ -615,7 +698,7 @@ module DYI #:nodoc:
         end
       end
 
-      class CurveCommandBase < CommandBase #:nodoc:
+      class CurveCommandBase < CommandBase
         def initialize(relative, preceding_command, *points)
           raise ArgumentError, "wrong number of arguments (2 for #{pt_cnt + 2})" if points.size != pt_cnt
           raise ArgumentError, 'preceding_command is nil' if preceding_command.nil?
@@ -656,7 +739,7 @@ module DYI #:nodoc:
         end
       end
 
-      class CurveCommand < CurveCommandBase #:nodoc:
+      class CurveCommand < CurveCommandBase
         def preceding_control_point
           if preceding_command.is_a?(CurveCommand)
             preceding_command.last_control_point
@@ -684,7 +767,7 @@ module DYI #:nodoc:
         end
       end
 
-      class ShorthandCurveCommand < CurveCommand #:nodoc:
+      class ShorthandCurveCommand < CurveCommand
         def control_point1
           if relative?
             preceding_point - preceding_control_point
@@ -712,7 +795,7 @@ module DYI #:nodoc:
         end
       end
 
-      class QuadraticCurveCommand < CurveCommandBase #:nodoc:
+      class QuadraticCurveCommand < CurveCommandBase
         def preceding_control_point
           if preceding_command.is_a?(QuadraticCurveCommand)
             preceding_command.last_control_point
@@ -742,7 +825,7 @@ module DYI #:nodoc:
         end
       end
 
-      class ShorthandQuadraticCurveCommand < QuadraticCurveCommand #:nodoc:
+      class ShorthandQuadraticCurveCommand < QuadraticCurveCommand
         def control_point
           if relative?
             preceding_point - preceding_control_point
@@ -766,7 +849,7 @@ module DYI #:nodoc:
         end
       end
 
-      class ArcCommand < CommandBase #:nodoc:
+      class ArcCommand < CommandBase
         attr_reader :rx, :ry, :rotation
 
         def initialize(relative, preceding_command, rx, ry, rotation, is_large_arc, is_clockwise, point)

data/lib/dyi/stylesheet.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -23,10 +23,11 @@
 #
 # This file provides the classes of client side scripting.  The event becomes
 # effective only when it is output by SVG format.
-#
-# @since 1.0.0
 
+#
 module DYI
+
+  # @since 1.0.0
   module Stylesheet
 
     class Style

data/lib/dyi/svg_element.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -19,8 +19,10 @@
 # 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 #:nodoc:
+#
+module DYI
 
+  # @since 0.0.0
   module SvgElement
 
     def draw_on(canvas)
@@ -111,11 +113,11 @@ module DYI #:nodoc:
 
     private
 
-    def draw_children? #:nodoc:
+    def draw_children?
       not child_elements.empty?
     end
 
-    def svg_attributes #:nodoc:
+    def svg_attributes
       attrs =
           attributes.inject({}) do |hash, (key, value)|
             hash[name_to_attribute(key).to_sym] = value if value
@@ -132,15 +134,15 @@ module DYI #:nodoc:
       attrs
     end
 
-    def name_to_attribute(name) #:nodoc:
+    def name_to_attribute(name)
       name.to_s.gsub(/_/,'-')
     end
 
-    def root_attributes #:nodoc:
+    def root_attributes
       {}
     end
 
-    def child_elements_to_svg(xml) #:nodoc:
+    def child_elements_to_svg(xml)
       child_elements.each {|child|
         child.to_svg(xml)
       }