ctioga2 0.0

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

@@ -0,0 +1,122 @@
+# background.rb: the style of the background of a plot.
+# copyright (c) 2009 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'
+
+module CTioga2
+
+  Version::register_svn_info('$Revision: 75 $', '$Date: 2009-06-03 00:02:32 +0200 (Wed, 03 Jun 2009) $')
+
+  module Graphics
+
+    module Styles
+
+      # The style of the background of a plot. Handles:
+      # * uniform background colors (fine)
+      # * (text) watermark
+      # * pictures (in a distant future ?)
+      class BackgroundStyle < BasicStyle
+
+        # The background color for a uniform fill. 
+        attr_accessor :background_color
+
+        # The text of the watermark, or _nil_ if there should be no
+        # watermark.
+        attr_accessor :watermark_text
+
+        # A MarkerStringStyle object representing the style of the
+        # watermark.
+        attr_accessor :watermark_style
+        
+        # Creates a new AxisStyle object at the given location with
+        # the given style.
+        def initialize(location = nil, type = nil, label = nil)
+          @background_color = nil
+          @watermark_style = MarkerStringStyle.new
+          @watermark_style.color = [0.5,0.5,0.5]
+        end
+
+        # Draws the background of the current plot. Fills up the
+        # current frame.
+        def draw_background(t)
+          t.context do
+            xl, yb, xr, yt = 
+              t.bounds_left, t.bounds_bottom, t.bounds_right, t.bounds_top
+            if @background_color
+              t.fill_color = @background_color
+              t.fill_frame
+            end
+            draw_watermark(t)
+          end
+        end
+
+        def draw_watermark(t)
+          if @watermark_text
+            x = t.convert_frame_to_figure_x(0.5)
+            y = t.convert_frame_to_figure_y(0.5)
+            
+            delta_y = t.default_text_height_dy * @watermark_style.
+              real_vertical_scale
+            
+            # We split lines on \\, just like in standard LaTeX
+            lines = @watermark_text.split(/\s*\\\\\s*/)
+            i = + (lines.size-1)/2.0
+            for text in lines 
+              @watermark_style.
+                draw_string_marker(t, text, x, y + delta_y * i)
+              i -= 1
+            end
+          end
+        end
+        
+        
+      end
+
+
+      BackgroundGroup = 
+        CmdGroup.new('background',
+                     "Background", <<EOD, 40)
+Commands dealing with the aspect of the background of a plot (excluding
+background lines, which are linked to axes).
+EOD
+      
+      BackgroundColorCmd = 
+        Cmd.new('background', nil, '--background', 
+                [ CmdArg.new('color-or-false') ]) do |plotmaker, color|
+        PlotStyle.current_plot_style(plotmaker).
+          background.background_color = color
+      end
+
+      BackgroundColorCmd.describe("Background color for the plot", 
+                                  <<"EOH", BackgroundGroup)
+Sets the background color for the current (and subsequent?) plot.
+EOH
+
+      WatermarkCmd = 
+        Cmd.new('watermark', nil, '--watermark', 
+                [ CmdArg.new('text') ], 
+                StringMarkerOptions) do |plotmaker, text, opts|
+        bg = PlotStyle.current_plot_style(plotmaker).
+          background
+        bg.watermark_text = text
+        bg.watermark_style.set_from_hash(opts)
+      end
+
+      WatermarkCmd.describe("Sets a watermark for the current plot", 
+                            <<"EOH", BackgroundGroup)
+Watermark...
+EOH
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# base.rb: the base of style objects
+# copyright (c) 2009 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/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) $')
+
+  module Graphics
+
+    # All the styles
+    module Styles
+
+      # This style is the base class of a series of style objects that
+      # 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
+      # each attribute ??? 
+      class BasicStyle
+
+        OldAttrAccessor = method(:attr_accessor)
+
+        # This redefinition of attr_accessor allows to track for the
+        # names of the attributes, while still showing them up
+        # properly documented in rdoc.
+        def self.attr_accessor(symbol)
+          @attributes ||= []
+          @attributes << symbol
+          OldAttrAccessor.call(symbol)
+        end
+
+        # Returns the list of attributes.
+        def self.attributes
+          return ( @attributes || [] ) + 
+            if superclass.respond_to?(:attributes)
+              superclass.attributes
+            else
+              []
+            end
+        end
+
+        # Sets the values of the attributes from the given
+        # _hash_. Keys are looked under the form of
+        # 
+        #  name % key_name
+        #  
+        # where _key_name_ takes all the values of the attributes.
+        #
+        # Unspecified attributes are not removed from the
+        # object. Extra keys are silently ignored.
+        def set_from_hash(hash, name = "%s")
+          for key_name in self.class.attributes
+            hash_key = name % key_name
+            if hash.key? hash_key 
+              self.send("#{key_name}=", hash[hash_key])
+            end
+          end
+        end
+
+        # Creates a new object from a hash specification, just as in
+        # #set_from_hash.
+        def self.from_hash(hash, name = "%s")
+          obj = self.new
+          obj.set_from_hash(hash, name)
+          return obj
+        end
+
+        # We define instance_variable_defined? if Ruby does not have
+        # it... Old Ruby 1.8 versions don't - that is the case for
+        # those on MacOS.
+        if not self.respond_to?(:instance_variable_defined?)
+          def instance_variable_defined?(iv)
+            a = instance_variables.index(iv)
+            if a && a >= 0 
+              return true
+            else
+              return false
+            end
+          end
+        end
+
+        # Converts to a hash. Does the reverse of #set_from_hash.
+        def to_hash(name = "%s")
+          retval = {}
+          for attr in self.class.attributes
+            if instance_variable_defined?("@#{attr}")
+              retval[name % attr] = instance_variable_get("@#{attr}")
+            end
+          end
+          return retval
+        end
+
+        # Updates information from another object.
+        def update_from_other(other_object)
+          set_from_hash(other_object.to_hash)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,53 @@
+# carrays.rb: 'circular arrays'
+# copyright (c) 2009 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: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+
+  module Graphics
+
+    module Styles
+
+      # A CirularArray, i.e an array from which one can extract
+      # successive elements in a fixed order, and that turns back to
+      # the first element once all have been used (hence 'circular').
+      class CircularArray
+        
+        # The set through which we go
+        attr_accessor :set
+        
+        def initialize(set)
+          @set = set
+        end
+
+        # Returns the next element in the array
+        def next
+          @value ||= 0
+          if @value >= @set.size
+            @value = 0
+          end
+          val = @set[@value]
+          @value += 1
+          return val
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,101 @@
+# curve.rb: style objects pertaining to curves and other line drawings.
+# copyright (c) 2009 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: 2 $', '$Date: 2009-04-25 14:03:30 +0200 (Sat, 25 Apr 2009) $')
+
+  module Graphics
+
+    module Styles
+
+      # A class holding all the styles for a curve.
+      #
+      # 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 ?
+      class CurveStyle
+
+        # The style of the line that is drawn, as a StrokeStyle. 
+        attr_accessor :line
+
+        # The style of markers that should be drawn, as a MarkerStyle.
+        attr_accessor :marker
+
+        # The text of the legend, if there is one.
+        attr_accessor :legend
+
+        # True if a line should be drawn.
+        def has_line?
+          return @line && @line.style
+        end
+
+        # True if markers should be drawn
+        def has_marker?
+          return @marker && @marker.marker
+        end
+
+        # True if there is one legend to be drawn for this object.
+        def has_legend?
+          return @legend
+        end
+
+        # Sets the values of the different sub-objects from a 'flat'
+        # _hash_. Keys have the following meaning:
+        # * 'line_...': a StrokeStyle for the drawing the line
+        # * 'marker_...': a MarkerStyle for the drawing of markers
+        # * 'legend': the legend of the curve
+        #
+        # TODO: make @legend another object derived from BasicStyle ?
+        def set_from_hash(hash)
+          @line = StrokeStyle.from_hash(hash, 'line_%s')
+          @marker = MarkerStyle.from_hash(hash, 'marker_%s')
+          @legend = hash['legend']
+        end
+
+        # Creates a CurveStyle object straight from a hash
+        # description. See #set_from_hash for more information.
+        def self.from_hash(hash)
+          a = CurveStyle.new
+          a.set_from_hash(hash)
+          return a
+        end
+
+
+        # Draws a legend pictogram that fills up the whole current
+        # frame.
+        #
+        # TODO: add more elements to the pictogram in case of more
+        # complex things.
+        def draw_legend_pictogram(t)
+          t.context do
+            if has_line?
+              @line.set_stroke_style(t)
+              t.stroke_line(0.0, 0.5, 1.0, 0.5)
+            end
+            if has_marker?
+              @marker.draw_markers_at(t, [0.5], [0.5])
+            end
+          end
+        end
+
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,87 @@
+# drawable.rb: style objects pertaining to drawable objects.
+# copyright (c) 2009 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: 61 $', '$Date: 2009-05-29 01:00:56 +0200 (Fri, 29 May 2009) $')
+
+  module Graphics
+
+    # All the styles
+    module Styles
+
+      # This class represents all the stylistic information to stroke
+      # a Tioga path.
+      class StrokeStyle < BasicStyle
+        # The color
+        attr_accessor :color
+        
+        # The line style
+        attr_accessor :style
+
+        # The line width
+        attr_accessor :width
+
+        # Sets the stroke style to a FigureMaker object, _t_.
+        def set_stroke_style(t)
+          t.stroke_color = @color if @color
+          t.line_type = @style if @style
+          t.line_width = @width if @width
+        end
+      end
+
+      # This class represents all the stylistic information to draw a
+      # Marker.
+      #
+      # TODO: many things are still missing here...
+      class MarkerStyle < BasicStyle
+
+        # The color
+        attr_accessor :color
+        
+        # The marker
+        attr_accessor :marker
+
+        # The marker scale
+        attr_accessor :scale
+
+        # Shows the marker at a given location/set of locations.
+        def draw_markers_at(t, x, y)
+          if x.is_a? Numeric
+            x = Dvector[x]
+            y = Dvector[y]
+          end
+          t.context do
+            # Always with line style solid (though that could change ?)
+            t.line_type = LineStyles::Solid
+            dict = { 
+              'Xs' => x, 'Ys' => y,
+              'marker' => @marker, 
+              'color' => @color
+            }
+            if @scale
+              dict['scale'] = @scale
+            end
+            t.show_marker(dict)
+          end
+        end
+      end
+
+    end
+  end
+end
+