ctioga2 0.3 → 0.4

data/lib/ctioga2/graphics/styles/box.rb

@@ -0,0 +1,67 @@
+# arrows.rb: style objects for lines and arrows
+# copyright (c) 2012 by Vincent Fourmond
+  
+# This program 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 2 of the License, or
+# (at your option) any later version.
+  
+# This program 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 (in the COPYING file).
+
+require 'ctioga2/utils'
+require 'ctioga2/log'
+
+# This module contains all the classes used by ctioga
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Graphics
+
+    # All the styles
+    module Styles
+
+      # This class represents styles attached to a box
+      #
+      # @todo Add rounded corners and the like...
+      class BoxStyle < StrokeStyle
+
+        sub_style 'fill', FillStyle
+
+        def draw_box(t, x1, y1, x2, y2)
+          t.context do
+            t.discard_path
+
+            ## @todo Rounded rects!
+            if fill && fill.color
+              fill.setup_fill(t)
+              t.append_rect_to_path(x1, y1, x2 - x1, y2 - y1)
+              fill.do_fill(t)
+            end
+            if color
+              set_stroke_style(t)
+              t.append_rect_to_path(x1, y1, x2 - x1, y2 - y1)
+              t.stroke
+            end
+          end
+
+        end
+
+        # Draws a box around the given box, leaving dx and dy
+        # around. If _dy_ is omitted, it defaults to _dx_
+        def draw_box_around(t, x1, y1, x2, y2, dx, dy = nil)
+          dy ||= dx
+          dx = dx.to_figure(t, :x)
+          dy = dy.to_figure(t, :y)
+          draw_box(t, x1 - dx, y1 + dy,
+                   x2 + dx, y2 - dy)
+        end
+
+      end
+    end
+  end
+end
+

data/lib/ctioga2/graphics/styles/carrays.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 105 $', '$Date: 2009-09-17 22:17:16 +0200 (Thu, 17 Sep 2009) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/styles/colormap.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 199 $', '$Date: 2010-11-30 00:48:26 +0100 (Tue, 30 Nov 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/styles/curve.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 349 $', '$Date: 2012-12-25 22:23:27 +0100 (Tue, 25 Dec 2012) $')
 
   module Graphics
 
@@ -28,6 +28,9 @@ module CTioga2
       # \todo maybe for objects different than Curve2D, a subclass of
       # CurveStyle could be used ? This way, we could have clearly
       # separated legends and the like ?
+      #
+      # @todo This should probably be a subclass of basicStyle, to
+      # handle style sheets.
       class CurveStyle
 
         # The style of the line that is drawn, as a StrokeStyle. 
@@ -105,6 +108,9 @@ module CTioga2
         #    plotted onto
         #
         # \todo make #legend another object derived from BasicStyle ?
+        #
+        # @todo This function should essentially disappear if we make
+        # this derive from BasicStyle.
         def set_from_hash(hash)
           @line = StrokeStyle.from_hash(hash, 'line_%s')
           @marker = MarkerStyle.from_hash(hash, 'marker_%s')

data/lib/ctioga2/graphics/styles/drawable.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 350 $', '$Date: 2012-12-25 22:23:35 +0100 (Tue, 25 Dec 2012) $')
 
   module Graphics
 
@@ -28,13 +28,13 @@ module CTioga2
       # a Tioga path.
       class StrokeStyle < BasicStyle
         # The color
-        attr_accessor :color
+        typed_attribute :color, 'color-or-false'
         
         # The line style
-        attr_accessor :style
+        typed_attribute :style, 'line-style'
 
         # The line width
-        attr_accessor :width
+        typed_attribute :width, 'float'
 
         # Sets the stroke style to a FigureMaker object, _t_.
         def set_stroke_style(t)
@@ -42,6 +42,14 @@ module CTioga2
           t.line_type = @style if @style
           t.line_width = @width if @width
         end
+
+        # Draws a line according with this style
+        def draw_line(t, x1, y1, x2, y2)
+          t.context do 
+            set_stroke_style(t)
+            t.stroke_line(x1, y1, x2, y2)
+          end
+        end
       end
 
       # This class represents all the stylistic information to draw a
@@ -54,13 +62,13 @@ module CTioga2
       class MarkerStyle < BasicStyle
 
         # The color
-        attr_accessor :color
+        typed_attribute :color, 'color'
         
         # The marker
-        attr_accessor :marker
+        typed_attribute :marker, 'marker'
 
         # The marker scale
-        attr_accessor :scale
+        typed_attribute :scale, 'float'
 
         # Shows the marker at a given location/set of locations.
         # 
@@ -97,16 +105,21 @@ module CTioga2
       #
       # \todo add ways to specify complex fills, such as patterned
       # fills and so on. Those would use clipping the path and base
-      # themselves on the coordinates of the current frame.
+      # themselves on the coordinates of the current frame -- or more
+      # nicely use dimensions ? (which would allow to mix both to some
+      # extent ?)
       #
       # \todo more attributes ?
+      #
+      # @todo This class should also provide image-based fills, with
+      # CSS-like capacities (scaling, tiling, centering, and so on...)
       class FillStyle < BasicStyle
 
         # The color.
-        attr_accessor :color
+        typed_attribute :color, "color"
 
         # The transparency
-        attr_accessor :transparency
+        typed_attribute :transparency, 'float'
 
         # Sets up the parameters for the fill. Must be called before
         # any path drawing.
@@ -136,7 +149,7 @@ module CTioga2
         # fill ? A float, or:
         # * :top, :bottom
         # * false, nil to disable filling altogether
-        attr_accessor :y0
+        typed_attribute :y0, 'fill-until'
         
       end
 

data/lib/ctioga2/graphics/styles/errorbar.rb

@@ -18,7 +18,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 123 $', '$Date: 2010-01-10 02:45:47 +0100 (Sun, 10 Jan 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/styles/factory.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 217 $', '$Date: 2010-12-31 16:18:20 +0100 (Fri, 31 Dec 2010) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/styles/gradients.rb

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/coordinates'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 335 $', '$Date: 2012-12-23 00:29:44 +0100 (Sun, 23 Dec 2012) $')
 
   module Graphics
 
@@ -37,10 +37,10 @@ module CTioga2
         include Log
         
         # The starting color (for x = 0)
-        attr_accessor :start
+        typed_attribute :start, 'color'
 
         # The ending color (for x = 1)
-        attr_accessor :end
+        typed_attribute :end, 'color'
 
         def initialize(s,e)
           warn { "This class shouldn't be used anymore at #{caller.inspect}" }

data/lib/ctioga2/graphics/styles/legend.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 359 $', '$Date: 2012-12-26 10:45:35 +0100 (Wed, 26 Dec 2012) $')
 
   module Graphics
 
@@ -27,7 +27,7 @@ module CTioga2
       class LegendStorageStyle < BasicStyle
 
         # The distance between two lines, a Types::Dimension object.
-        attr_accessor :dy
+        typed_attribute :dy, 'dimension'
 
         # The width of the legend pictogram, a Types::Dimension object.
         attr_accessor :picto_width
@@ -38,12 +38,22 @@ module CTioga2
         # The distance between the legend pictogram and the text
         attr_accessor :picto_to_text
 
-        # The scale of the legend
-        attr_accessor :scale
+        # The overall scale of the legend
+        typed_attribute :scale, 'float'
 
         # The scale of the legend text -- relative to the overall
         # scale.
-        attr_accessor :text_scale
+        typed_attribute :text_scale, 'float'
+
+        # The scale of the pictogram
+        typed_attribute :symbol_scale, 'float'
+
+
+        # A frame around the legend
+        sub_style :frame, BoxStyle
+
+        # Padding around the frame
+        typed_attribute :frame_padding, 'dimension'
 
         def initialize
           @dy = Types::Dimension.new(:dy, 1.6, :y)
@@ -55,6 +65,11 @@ module CTioga2
 
           @scale = 0.8
           @text_scale = 0.82
+          @symbol_scale = 1
+
+          @frame = BoxStyle.new()
+          
+          @frame_padding = Types::Dimension.from_text("1mm", :x)
         end
       end
     end

data/lib/ctioga2/graphics/styles/location.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 335 $', '$Date: 2012-12-23 00:29:44 +0100 (Sun, 23 Dec 2012) $')
 
   module Graphics
 
@@ -36,10 +36,10 @@ module CTioga2
         
         # The name of the X axis, something to be fed to
         # PlotStyle#get_axis_key
-        attr_accessor :xaxis
+        typed_attribute :xaxis, 'axis'
 
         # The name of the Y axis
-        attr_accessor :yaxis
+        typed_attribute :yaxis, 'axis'
 
         # Given a PlotStyle object, returns the axes keys as would
         # PlotStyle#get_axis_key

data/lib/ctioga2/graphics/styles/map-axes.rb

@@ -32,17 +32,17 @@ module CTioga2
         attr_accessor :color_map
         
         # Zmin and Zmax boundaries
-        attr_accessor :bounds
+        typed_attribute :bounds, "float-range"
 
         # Size of the bar (not counting the label)
-        attr_accessor :bar_size
+        typed_attribute :bar_size, 'dimension'
 
         # Space to be left between the graph and the beginning of the
         # graph
-        attr_accessor :bar_shift
+        typed_attribute :bar_shift, 'dimension'
 
         # Space to be left on the side
-        attr_accessor :padding
+        typed_attribute :padding, 'dimension'
 
         # Creates a new MapAxisStyle object at the given location with
         # the given style.
@@ -155,10 +155,9 @@ module CTioga2
         end
 
       end
+      # @todo This naming doesn't look that good, honestly
+      ZAxisStyle = MapAxisStyle.options_hash()
 
-      ZAxisStyle = FullAxisStyle.dup
-      ZAxisStyle['bar_size'] = CmdArg.new('dimension')
-      ZAxisStyle['bar_shift'] = CmdArg.new('dimension')
     end
   end
 end

data/lib/ctioga2/graphics/styles/plot.rb

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/coordinates'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision$', '$Date$')
+  Version::register_svn_info('$Revision: 370 $', '$Date: 2012-12-28 17:40:18 +0100 (Fri, 28 Dec 2012) $')
 
   module Graphics
 
@@ -33,6 +33,10 @@ module CTioga2
       # * ticks
       # * background (uniform fill + watermark if applicable + possibly
       #   a picture .?)
+      #
+      # This class is way too complex and needs too much flexibility
+      # to be handled by a subclass of BasicStyle. However, all
+      # substyles should be.
       class PlotStyle
 
         include Tioga::FigureConstants
@@ -77,27 +81,36 @@ module CTioga2
         def initialize
           # Default style for the plots.
           @axes = {}
-          @axes[:left] = AxisStyle.new(:left, 
-                                       AXIS_WITH_TICKS_AND_NUMERIC_LABELS,
-                                       '$y$')
-          @axes[:bottom] = AxisStyle.new(:bottom, 
-                                         AXIS_WITH_TICKS_AND_NUMERIC_LABELS,
-                                         '$x$')
-
-          @axes[:right] = AxisStyle.new(:right, AXIS_WITH_TICKS_ONLY)
-          @axes[:top] = AxisStyle.new(:top, AXIS_WITH_TICKS_ONLY)
+          @axes[:left] = 
+            StyleSheet.style_for(AxisStyle, 'left', :left, 
+                                 AXIS_WITH_TICKS_AND_NUMERIC_LABELS,
+                                 '$y$')
+          @axes[:bottom] = 
+            StyleSheet.style_for(AxisStyle, 'bottom', :bottom, 
+                                 AXIS_WITH_TICKS_AND_NUMERIC_LABELS,
+                                 '$x$')
+
+          @axes[:right] = 
+            StyleSheet.style_for(AxisStyle, 'right', :right, 
+                                 AXIS_WITH_TICKS_ONLY)
+          @axes[:top] = 
+            StyleSheet.style_for(AxisStyle, 'top', :top, 
+                                 AXIS_WITH_TICKS_ONLY)
 
           @xaxis_location = :bottom
           @yaxis_location = :left
 
-          @title = TextLabel.new
-          @title.loc = Types::PlotLocation.new(:top)
+          @title = 
+            StyleSheet.style_for(TextLabel, 'title',
+                                 nil, 
+                                 Types::PlotLocation.new(:top))
 
           @plot_margin = nil
 
           @transforms = CoordinateTransforms.new
 
-          @background = BackgroundStyle.new
+          @background = 
+            StyleSheet.style_for(BackgroundStyle, 'background')
 
           # A padding of 4bp ? Why ?? Why not ?
           @padding = Types::Dimension.new(:bp, 4)
@@ -227,7 +240,7 @@ module CTioga2
                 axis.draw_axis(t)
               rescue Exception => e
                 error { "Impossible to draw axis #{which}: #{e.message}" }
-                debug { "Full message: #{e.inspect}" }
+                debug { "Full message: #{e.inspect}\n#{e.backtrace.join("\n")}" }
               end
             end
           end
@@ -319,13 +332,12 @@ module CTioga2
                                "Axes and labels", "Axes and labels", 40)
 
 
-      
       AxisTypeCommands = []
       [:left, :right, :top, :bottom].each do |loc|
         AxisTypeCommands << 
           Cmd.new("#{loc}",nil,"--#{loc}", 
                   [
-                   CmdArg.new('axis-decoration'),
+                   AxisStyleOptions['decoration'],
                   ], PartialAxisStyle) do |plotmaker, dec, opts|
           style = AxisStyle.current_axis_style(plotmaker, loc)
           style.decoration = dec
@@ -336,14 +348,18 @@ module CTioga2
           describe("Sets the type of the #{loc} axis", 
                    <<"EOH", AxisGroup)
 Sets the type of the #{loc} axis.
+
+The options have the same meaning as for {command: define-axis-style},
+see that command for more information.
 EOH
+
       end
 
       AxisStyleCommand = 
           Cmd.new("axis-style",nil,"--axis-style", 
                   [
                    CmdArg.new('axis'),
-                  ], FullAxisStyle) do |plotmaker, which, opts|
+                  ], AxisStyleOptions) do |plotmaker, which, opts|
         style = AxisStyle.current_axis_style(plotmaker, which)
         style.set_from_hash(opts)
       end
@@ -351,8 +367,8 @@ EOH
         describe("Sets the style of the given axis", 
                  <<"EOH", AxisGroup)
 This command can be used to set various aspects of the style of the 
-given axis, through its various options:
- * decoration
+given axis, through its various options, which are documented in more details 
+in the {command: define-axis-style} command.
 EOH
 
       BackgroundLinesCommand = 
@@ -360,10 +376,9 @@ EOH
                 [
                  CmdArg.new('axis'), 
                  CmdArg.new('color-or-false')
-                ],{
-                  'style' => CmdArg.new('line-style'),
-                  'width' => CmdArg.new('float')
-                }) do |plotmaker, which, color, options|
+                ],
+                StrokeStyle.options_hash().without('color')
+                ) do |plotmaker, which, color, options|
         axis = AxisStyle.current_axis_style(plotmaker, which)
         if color
           style = {'color' => color}
@@ -388,7 +403,8 @@ EOH
       %w{x y}.each do |axis|
         labelcmd = Cmd.new("#{axis}label", "-#{axis}", 
                             "--#{axis}label", [ CmdArg.new('text') ],
-                            FullTextStyleOptions) do |plotmaker, label, options|
+                            TextLabel.options_hash().without('text')
+                           ) do |plotmaker, label, options|
           PlotStyle.current_plot_style(plotmaker).
             set_label_style("#{axis}_label", options, label)
         end
@@ -396,6 +412,8 @@ EOH
                           <<"EOH", AxisGroup)
 Sets the #{axis.upcase} label of the current plot.
 EOH
+
+        Commands::make_alias_for_option "#{axis}label", 'alignment', 'align', true
         
         nolabelcmd = Cmd.new("no-#{axis}label", nil, 
                              "--no-#{axis}label", []) do |plotmaker|
@@ -424,8 +442,10 @@ EOD
       end
 
       TitleLabelCommand = 
-        Cmd.new('title', '-t', '--title', [ CmdArg.new('text') ],
-                FullTextStyleOptions) do |plotmaker, label, options|
+        Cmd.new('title', '-t', '--title', 
+                [ CmdArg.new('text') ],
+                TextLabel.options_hash().without('text')
+                ) do |plotmaker, label, options|
         PlotStyle.current_plot_style(plotmaker).
           set_label_style('title', options, label)
       end
@@ -435,6 +455,8 @@ EOD
 Sets the title of the current plot.
 EOH
 
+      Commands::make_alias_for_option 'title', 'alignment', 'align', true
+
       NoTitleLabelCommand = 
         Cmd.new('no-title', nil, '--no-title', []) do |plotmaker|
         PlotStyle.current_plot_style(plotmaker).
@@ -501,6 +523,8 @@ EOH
         PlotStyle.current_plot_style(plotmaker).
           set_label_style(which, options)
       end
+
+      Commands::make_alias_for_option 'label-style', 'alignment', 'align', true
       
       LabelStyleCommand.describe("Sets the style of the given label", 
                                  <<"EOH", AxisGroup)
@@ -517,6 +541,7 @@ override the color using the /stroke_color option of
 greater.
 EOH
 
+
     end
   end
 end