ctioga2 0.0 → 0.1

data/lib/ctioga2/graphics/legends.rb

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/legends/provider'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 68 $', '$Date: 2009-05-31 00:02:56 +0200 (Sun, 31 May 2009) $')
+  Version::register_svn_info('$Revision: 244 $', '$Date: 2011-01-23 23:36:02 +0100 (Sun, 23 Jan 2011) $')
 
   module Graphics
 
@@ -37,8 +37,8 @@ EOD
 
     NextLegendCommand.describe("Sets the legend for the next dataset",
                                <<EOH, LegendGroup)
-Sets the legend for the next dataset. Overridden by the legend= option
-to the plot command.
+Sets the legend for the next dataset. Overridden by the @legend@ option
+to the {command: plot} command.
 EOH
 
     LegendLineCommand = 
@@ -52,21 +52,6 @@ EOH
     LegendLineCommand.describe("Adds a pure text line to the legend",
                                <<EOH, LegendGroup)
 Adds a line of text unrelated to any curve to the legend.
-EOH
-
-    LegendInsideCommand = 
-      Cmd.new("legend-inside", nil, "--legend-inside",
-              [ CmdArg.new('aligned-point')]) do |plotmaker, point|
-      l = Legends::LegendArea.new(:inside)
-      l.legend_position = point
-      plotmaker.root_object.current_plot.legend_area = l
-    end
-
-    LegendInsideCommand.describe("Draw legends inside the current plot",
-                                 <<EOH, LegendGroup)
-When this option is in effect, all legends for the current plot (and
-possibly subplots) are drawn inside the current plot, at the specified 
-position.
 EOH
 
     AutoLegendCommand = 
@@ -99,10 +84,30 @@ EOH
                                 <<EOH, LegendGroup)
 Sets the various aspects of the style of the legends throught 
 its options:
- * dy: the spacing between consecutive lines
- * scale: the overall scale of the legends
- * text_scale: the scale of the text (and the markers) inside the legends
+ * @dy@: the spacing between consecutive lines
+ * @scale@: the overall scale of the legends
+ * @text_scale@: the scale of the text (and the markers) inside the legends
+EOH
+
+    LegendInsideCommand = 
+      Cmd.new("legend-inside", nil, "--legend-inside",
+              [ CmdArg.new('aligned-point')],
+              LegendStyleOptions) do |plotmaker, point, options|
+      l = Legends::LegendArea.new(:inside)
+      l.legend_position = point
+      plotmaker.root_object.current_plot.legend_area = l
+      l.legend_style.set_from_hash(options)
+    end
+
+    LegendInsideCommand.describe("Draw legends inside the current plot",
+                                 <<EOH, LegendGroup)
+Using this command sets the position of the legends for the current
+(sub)plot inside it, at the precise location given.
+
+As a shortcut, {command: legend-inside} also takes all the options that 
+{command: legend-style} takes, with the same effect.
 EOH
 
+
   end
 end

data/lib/ctioga2/graphics/legends/area.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 80 $', '$Date: 2009-06-09 23:56:44 +0200 (Tue, 09 Jun 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   module Graphics
 
@@ -25,7 +25,7 @@ module CTioga2
 
       # This class holds a series of legends for curves.
       #
-      # TODO:
+      # \todo
       # 
       # * a legend can be plotted either inside a plot or outside the
       #   root object
@@ -44,7 +44,7 @@ module CTioga2
       #   @legend_area for the current Elements::Container, with the
       #   given position.
       #
-      # TODO: make a subclass for a top-level area ???? 
+      # \todo make a subclass for a top-level area ???? 
       class LegendArea
 
         # The style of the LegendStorage, a Styles::LegendStorageStyle
@@ -70,7 +70,7 @@ module CTioga2
         # subobjects. It assumes that the frames have been set
         # according to the return value of #partition_frame
         #
-        # TODO:
+        # \todo
         # 
         # * customization of the x and y of origin (y should match the
         #   top of the corresponding graph, if applicable)
@@ -86,10 +86,10 @@ module CTioga2
 
             # We make figure coordinates frame coordinates
             t.set_bounds([0, 1, 1, 0])
-            # TODO: customize this !
+            # \todo customize this !
             x, y = initial_xy(t, container)
             for item in items
-              # TODO: transform the 0.0 for x into a negative
+              # \todo transform the 0.0 for x into a negative
               # user-specifiable stuff.
               item.draw(t, @legend_style, x , y)
               y -= @legend_style.dy.to_figure(t,:y)
@@ -176,12 +176,12 @@ module CTioga2
         def initial_xy(t, container)
           case @legend_type
           when :right
-            l,r,t,b = container.subframe.to_frame_margins(t)
+            l,r,t,b = container.actual_subframe(t).to_frame_margins(t)
             # Here, we take profit from the fact that frame
             # coordinates are also figure coordinates within the
             # legend.
 
-            # TODO: that won't work in the case of labels on the
+            # \todo that won't work in the case of labels on the
             # right-hand-side.
             return [- l/2, 1.0 - t]
           when :inside

data/lib/ctioga2/graphics/legends/items.rb

@@ -18,7 +18,7 @@ require 'ctioga2/graphics/styles'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 55 $', '$Date: 2009-05-27 00:01:34 +0200 (Wed, 27 May 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   module Graphics
 
@@ -116,7 +116,7 @@ module CTioga2
       # The legend of a curve object, or rather, the legend
       # corresponding to a given
       #
-      # TODO: finish to adapt: use FullTextStyle to draw the objects.
+      # \todo finish to adapt: use FullTextStyle to draw the objects.
       class CurveLegend < LegendItem
 
         include CTioga2::Log
@@ -130,9 +130,9 @@ module CTioga2
         
         # Draw one single text line
         #
-        # TODO: adapt here !
+        # \todo adapt here !
         #
-        # TODO: _x_ and _y_ are not taken into account the way they should be.
+        # \todo _x_ and _y_ are not taken into account the way they should be.
         def draw(t, legend_style, x, y)
           y = get_baseline_y(t, legend_style, y) 
           t.context do 
@@ -142,7 +142,7 @@ module CTioga2
               'bottom' => y,
               'top' => 1 - y - legend_style.picto_height.to_figure(t)
             }
-            debug "Legend margins for '#{@curve_style.legend}' : #{margin_specs.inspect}"
+            debug { "Legend margins for '#{@curve_style.legend}' : #{margin_specs.inspect}" }
             t.subfigure(margin_specs) do
               # We make the markers slightly smaller than the text
               # around.

data/lib/ctioga2/graphics/legends/storage.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 53 $', '$Date: 2009-05-20 01:05:32 +0200 (Wed, 20 May 2009) $')
+  Version::register_svn_info('$Revision: 139 $', '$Date: 2010-01-22 00:12:17 +0100 (Fri, 22 Jan 2010) $')
 
   module Graphics
 
@@ -50,7 +50,9 @@ module CTioga2
               retval << el
             elsif el.is_a? Elements::Container and 
                 (not el.legend_area)
-              retval.concat(el.legend_storage.harvest_contents)
+              if el.legend_storage 
+                retval.concat(el.legend_storage.harvest_contents)
+              end
             end
           end
           return retval

data/lib/ctioga2/graphics/root.rb

@@ -21,7 +21,7 @@ require 'ctioga2/graphics/subplot-commands'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 88 $', '$Date: 2009-06-17 00:10:31 +0200 (Wed, 17 Jun 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   # This module contains all graphical elements of CTioga2
   module Graphics
@@ -127,7 +127,7 @@ module CTioga2
         t.title_scale = 1
         t.xlabel_scale = 1
         t.ylabel_scale = 1
-        # TODO: I think this is mostly useless. Check.
+        # \todo I think this is mostly useless. Check.
       end
 
       # Creates a subplot of the current plot. If @current_container
@@ -146,6 +146,28 @@ module CTioga2
         return subplot
       end
 
+      # This function is the companion of #subplot, but for Region
+      # objects. Returns the newly created Region.
+      def enter_region
+        if ! @current_container
+          subplot
+        end
+        region = Elements::Region.new(@current_container, self)
+        enter_subobject(region)
+        return region
+      end
+
+      # This function is the companion of #subplot, but for GradientRegion
+      # objects. Returns the newly created GradientRegion
+      def enter_gradient
+        if ! @current_container
+          subplot
+        end
+        region = Elements::GradientRegion.new(@current_container, self)
+        enter_subobject(region)
+        return region
+      end
+
       # Returns true if not a single drawable object has been pushed
       # unto the RootObject yet.
       def empty?

data/lib/ctioga2/graphics/styles.rb

@@ -14,13 +14,21 @@
 require 'ctioga2/graphics/styles/base'
 
 require 'ctioga2/graphics/styles/drawable'
+require 'ctioga2/graphics/styles/location'
 require 'ctioga2/graphics/styles/texts'
 require 'ctioga2/graphics/styles/carrays'
 require 'ctioga2/graphics/styles/curve'
 
+require 'ctioga2/graphics/styles/gradients'
+require 'ctioga2/graphics/styles/colormap'
+
+
+require 'ctioga2/graphics/styles/errorbar'
+
 require 'ctioga2/graphics/styles/sets'
 
 require 'ctioga2/graphics/styles/axes'
+require 'ctioga2/graphics/styles/map-axes'
 require 'ctioga2/graphics/styles/background'
 require 'ctioga2/graphics/styles/plot'
 

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

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 94 $', '$Date: 2009-06-25 23:37:13 +0200 (Thu, 25 Jun 2009) $')
+  Version::register_svn_info('$Revision: 202 $', '$Date: 2010-11-30 22:21:17 +0100 (Tue, 30 Nov 2010) $')
 
   module Graphics
 
@@ -68,7 +68,7 @@ module CTioga2
         # Creates a new AxisStyle object at the given location with
         # the given style.
         def initialize(location = nil, decoration = nil, label = nil)
-          @location = location
+          @location = Types::PlotLocation.new(location)
           @decoration = decoration
 
           @tick_label_style = FullTextStyle.new
@@ -80,7 +80,7 @@ module CTioga2
         # current plot boundaries. Also draw the #axis_label, if there
         # is one.
         #
-        # TODO:
+        # \todo
         # * the offset mechanism, to place the axis away from the place
         #   where it should be...
         # * non-linear axes (or linear, for that matter, but with
@@ -93,11 +93,31 @@ module CTioga2
             spec['stroke_color'] = @stroke_color
           end
           t.show_axis(spec)
-          @axis_label.loc = LocationToTiogaLocation[@location]
+          @axis_label.loc = @location
           default = vertical? ? 'ylabel' : 'xlabel'
           @axis_label.draw(t, default)
         end
 
+        # Sets the current boundaries of the _t_ object to the _range_
+        # SimpleRange object for the direction handled by the
+        # AxisStyle, without touching the rest.
+        def set_bounds_for_axis(t, range = nil)
+          if ! range
+            return
+          end
+          l,r,top,b = t.bounds_left, t.bounds_right, 
+          t.bounds_top, t.bounds_bottom
+
+          if self.vertical?
+            b = range.first
+            top = range.last
+          else
+            l = range.first
+            r = range.last
+          end
+          t.set_bounds([l,r,top,b])
+        end
+
         # Draw the axis background lines:
         def draw_background_lines(t)
           if @background_lines
@@ -132,16 +152,12 @@ module CTioga2
             get_axis_style(spec)
         end
 
-        # Returns the extension of the axis (including tick labels and
-        # labels if applicable) perpendicular to itself, in units of
-        # text height (at scale = current text scale when drawing
-        # axes).
-        #
-        # _style_ is a PlotStyle object containing the style
-        # information for the target plot.
+        # Returns the part of the #extension only due to the labels
+        # (ticks and standard label).
         #
-        # TODO: handle offset axes when that is implemented.
-        def extension(t, style = nil)
+        # For now, it returns the same value as #extension, but that
+        # might change
+        def labels_only_extension(t, style = nil)
           ticks_shift, ticks_scale = *get_ticks_parameters(t)
           default =  vertical? ? 'ylabel' : 'xlabel'
           le = @axis_label.label_extension(t, default, @location)
@@ -157,19 +173,31 @@ module CTioga2
             (style ? style.text_scale || 1 : 1)
         end
 
+        # Returns the extension of the axis (including tick labels and
+        # labels if applicable) perpendicular to itself, in units of
+        # text height (at scale = current text scale when drawing
+        # axes).
+        #
+        # _style_ is a PlotStyle object containing the style
+        # information for the target plot.
+        #
+        # \todo handle offset axes when that is implemented.
+        def extension(t, style = nil)
+          return labels_only_extension(t, style)
+        end
+
         protected
 
         # Whether the axis is vertical or not
         def vertical?
-          return LocationVertical[@location]
+          return @location.vertical?
         end
 
         # Returns: _ticks_shift_, _ticks_scale_ for the axis.
         #
-        # TODO: try something clever with the angles ?
+        # \todo try something clever with the angles ?
         def get_ticks_parameters(t)
-          i = t.axis_information({'location' => 
-                                   LocationToTiogaLocation[@location]})
+          i = t.axis_information({'location' => @location.tioga_location})
           retval = []
           retval << (@tick_label_style.shift || i['shift'])
           retval << (@tick_label_style.scale || i['scale'])
@@ -193,8 +221,7 @@ module CTioga2
             raise YetUnimplemented, "This has not been implemented yet"
           else
             retval.
-              update({'location' => 
-                       LocationToTiogaLocation[@location],
+              update({'location' => @location.tioga_location,
                        'type' => @decoration, 'log' => @log})
             return retval
           end
@@ -204,8 +231,7 @@ module CTioga2
         def compute_coordinate_transforms(t)
           return unless @transform
           # We'll proceed by steps...
-          i = t.axis_information({'location' => 
-                                   LocationToTiogaLocation[@location]})
+          i = t.axis_information({'location' => @location.tioga_location})
           t.context do 
             if i['vertical']
               top,b = @transform.convert_to([t.bounds_top, t.bounds_bottom])
@@ -215,8 +241,7 @@ module CTioga2
               l,r = @transform.convert_to([t.bounds_left, t.bounds_right])
             end
             t.set_bounds([l,r,top,b])
-            i = t.axis_information({'location' => 
-                                     LocationToTiogaLocation[@location]})
+            i = t.axis_information({'location' => @location.tioga_location})
             # Now, we have the location of everything we need.
           end
           # In the following, the || are because of a fix in Tioga
@@ -235,6 +260,7 @@ module CTioga2
 
       PartialAxisStyle = {
         'transform' => CmdArg.new('bijection'),
+        'location' => CmdArg.new('location'),
         'stroke_color' => CmdArg.new('color')
       }
 

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

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 32 $', '$Date: 2009-05-03 19:47:29 +0200 (Sun, 03 May 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   module Graphics
 
@@ -27,7 +27,7 @@ module CTioga2
       # share one common feature: all their attributes can be set
       # using the set_from_hash function.
       #
-      # TODO: maybe a basic MetaBuilder::Type should be associated to
+      # \todo maybe a basic MetaBuilder::Type should be associated to
       # each attribute ??? 
       class BasicStyle
 

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: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+  Version::register_svn_info('$Revision: 105 $', '$Date: 2009-09-17 22:17:16 +0200 (Thu, 17 Sep 2009) $')
 
   module Graphics
 
@@ -29,7 +29,14 @@ module CTioga2
       class CircularArray
         
         # The set through which we go
-        attr_accessor :set
+        attr_reader :set
+
+        # Defines the set of elements we'll be circling through and
+        # resets the index.
+        def set=(s)
+          @set = s
+          @value = 0
+        end
         
         def initialize(set)
           @set = set