corbanbrook-rcomposite 0.3.0 → 0.3.1

data/README

@@ -1,6 +1,30 @@
                                   
                                   RComposite
 
+RComposite is an RMagick abstraction library to easily manipulate and composite 
+images through the use of a canvas, layers, layer masks, adjustment layers, fill
+layers, and layer sets (much like in Photoshop).
+
+
+Install:
+
+Add the github repository to your gem sources:
+
+  sudo gem sources -a http://gems.github.com
+
+Install the gem from github:
+
+  sudo gem install corbanbrook-rcomposite
+
+Require:
+
+  require 'rubygems'
+  require 'rcomposite'
+
+  include RComposite # optional: if you wish to have the RComposite module in your project scope
+
+  ...
+
 
 Class Summary:
 
@@ -34,92 +58,124 @@ Class Summary:
 
 Usage:
 
-First you must require the gem or lib:
+* Creating a blank canvas:
 
-  require 'rubygems'
-  require 'rcomposite'
-  include RComposite # includes the RComposite module methods into this scope
+    canvas = RComposite::Canvas.new(640, 480)
 
-After including the Module, we will need to create a blank canvas.
+  Canvas also accepts an optional block for easily adding layers to the stack
 
-  canvas = Canvas.new(640, 480)
+    canvas = Rcomposite::Canvas.new(640, 480) do
+      layer :file => 'butterfly.png'
+    end
 
-Creating a layer:
+* Creating a layer:
 
-  photo = Layer.new :file => 'photo.jpg'
+    photo = RComposite::Layer.new :file => 'photo.jpg'
 
-Creating a fill layer:
+* Creating a fill layer:
 
-  blue = FillLayer.new '#000090'
+    blue = RCompisite::FillLayer.new '#000090'
 
-Changing a Layers properties:
+* Changing a Layers properties:
 
-  blue.opacity 40
-  blue.mode Multiply
+    blue.opacity 40
+    blue.mode Multiply
 
-The layers may be added to the canvas. Whatever is added first will be on top:
+* Adding layers to the canvas. (Whatever is added first will be on top):
 
-  canvas.layer blue
-  canvas.layer photo
+    canvas.layer blue
+    canvas.layer photo
 
-The canvas can be saved:
+* Saving the canvas:
 
-  canvas.save_as 'bluesky.jpg'
+    canvas.save_as 'bluesky.jpg'
 
-The real power of RComposite lies in its use of blocks and simplified syntax.
-Take a look at the following example:
+* Adding an alpha channel mask to a layer:
 
-  Canvas.new(320,240) do
+  Masks are used to punch holes into layers to add transparency.
 
-    layer_set :slides do
-      layer :file => 'slide1.png' do
-        opacity 65
-        offset 12, 12
-        mode Lighten
-      end
+    blue.layer_mask :file => 'alpha_channel.png'
 
-      adjustment_layer Blur, 0.5, 1.5 do
-        layer_mask :file => 'butterfly-mask.png'
-      end
+  You can add layer options to the mask just like it was a normal layer.
 
-      layer :file => 'slide2.png' do
-        offset 28, 28
-        opacity 30
-        mode Darken
+    fill_layer SolidColor, '#f83898FF' do
+      layer_mask :file => 'butterfly-mask.png' do
+        offset -30, -30
+        rotate 40
       end
+    end
 
-      rotate 45
-      offset 70, 50
-      scale 80, 80
+
+The real power of RComposite lies in its use of blocks and simplified syntax.
+Take a look at the following examples:
+
+* Just like the Canvas, all layer types also accept an optional block parametre for setting layer options:
+
+    butterfly = RComposite::Layer :file => 'butterfly.png' do 
+      offset 100, 100 # moves the layer on the canvas
+      rotate 25
     end
 
-    fill_layer SolidColor, '#f83898FF' do
-      opacity 70
-      mode Multiply
+  or..
 
-      layer_mask :file => 'butterfly-mask.png' do
-        offset -30, -30
-        image.rotate! 40
-      end
+    canvas.layer :file => 'butterfly.png' do 
+      ..
     end
 
-    fill_layer Gradient, 0, 0, 0, 50, '#606', '#033' do
-      opacity 90
-      mode Overlay
+* DSL Example
 
-      layer_mask :file => 'butterfly-mask.png' do
-        offset -20, -20
+    Canvas.new(320,240) do
+
+      layer_set :slides do
+        layer :file => 'slide1.png' do
+          opacity 65
+          offset 12, 12
+          mode Lighten
+        end
+
+        adjustment_layer Blur, 0.5, 1.5 do
+          layer_mask :file => 'butterfly-mask.png'
+        end
+
+        layer :file => 'slide2.png' do
+          offset 28, 28
+          opacity 30
+          mode Darken
+        end
+
+        rotate 45
+        offset 70, 50
+        scale 80, 80
       end
-    end
 
-    layer :file => 'background.png' do
-      image.resize!(320, 240)
+      fill_layer SolidColor, '#f83898FF' do
+        opacity 70
+        mode Multiply
+
+        layer_mask :file => 'butterfly-mask.png' do
+          offset -30, -30
+          image.rotate! 40
+        end
+      end
+
+      fill_layer Gradient, 0, 0, 0, 50, '#606', '#033' do
+        opacity 90
+        mode Overlay
+
+        layer_mask :file => 'butterfly-mask.png' do
+          offset -20, -20
+        end
+      end
+
+      layer :file => 'background.png' do
+        image.resize!(320, 240)
+      end
+
+      save_as 'composite.jpg'
     end
 
-    save_as 'composite.jpg'
-  end
 
-This nice thing about RComposite is that it doesnt hide the underlaying RMagick
+The nice thing about RComposite is that it doesnt hide the underlaying RMagick
 Image object from you. It is always available through the image accessor
 
   layer :file => 'photo.jpg' do

data/lib/rcomposite/layer.rb

@@ -80,6 +80,10 @@ module RComposite
       @offset_y = y
     end
 
+    def rotate(degrees)
+      @image.rotate!(degrees)
+    end
+
     def opacity(percent)
       @opacity_percent = percent
       # intercept original alpha channel with pixel intensity

data/lib/rcomposite/layerset.rb

@@ -5,7 +5,6 @@ module RComposite
     
     def initialize(name, &block)
       @layers = []
-      @layer_sets = {}
 
       bounding_box
       @name = name
@@ -13,23 +12,25 @@ module RComposite
       self.instance_eval &block if block_given?
     end
 
-    def layer_set(set_or_name, &block) 
-      if set_or_name.is_a? RComposite::LayerSet
-        # referencing a previously instanstiated LayerSet and adding to Canvas.
-        set = set_or_name
-        @layers << set
-        @layer_sets[set.name] = set 
-      
-      elsif @layer_sets[set_or_name]
-        # referencing a previously added LayerSet.
-        set = @layer_sets[set_or_name]
-      
+    def stack(&block)
+      self.instance_eval &block if block_given?
+    end
+
+    def layer_set(ref, position = :bottom, &block) 
+      if ref.is_a? RComposite::LayerSet
+        # referencing a previously instanstiated LayerSet.
+        set = ref 
       else    
-        # creating a new LayerSet and adding to Canvas.
-        set = LayerSet.new set_or_name  
-        @layers << set
-        @layer_sets[set_or_name] = set
+        # creating a new LayerSet
+        set = LayerSet.new ref  
       end     
+      
+      # Add layer set to render pipeline
+      if position == :bottom
+        @layers << set
+      elsif position == :top
+        @layers.unshift set
+      end
 
       # tie floating block methods (layer, rotate, offset, etc) to LayerSet object.
       set.instance_eval &block if block_given?
@@ -43,6 +44,8 @@ module RComposite
       else
         layer = Layer.new options
       end
+
+      # Add layer to render pipeline
       @layers << layer
 
       # tie floating block methods (opacity, mode, offset, etc) to Layer object.
@@ -76,7 +79,6 @@ module RComposite
       
       # clear layers and sets
       @layers.clear
-      @layer_sets.clear
 
       # only 1 flattened layer now   
       @layers << Layer.new(flattened_image)
@@ -114,7 +116,7 @@ module RComposite
       @layers.delete(layer)
       bounding_box
     end
-    
+
     def bounding_box
       if @layers.size > 0
         x1 = []
@@ -181,7 +183,7 @@ module RComposite
         new_mid_x = ((layer_mid_x * cos) - (layer_mid_y * sin)).round
         new_mid_y = ((layer_mid_x * sin) + (layer_mid_y * cos)).round
       
-        layer.image.rotate!(degrees)
+        layer.rotate(degrees)
 
         new_offset_x = new_mid_x - (layer.width/2.0).round + @min_x + bounding_mid_x
         new_offset_y = new_mid_y * -1 - (layer.height/2.0).round + @min_y + bounding_mid_y

data/lib/rcomposite.rb

@@ -6,3 +6,4 @@ require 'rcomposite/canvas'
 require 'rcomposite/filllayer'
 require 'rcomposite/adjustmentlayer'
 require 'rcomposite/layermask'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: corbanbrook-rcomposite
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Corban Brook
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-24 00:00:00 -07:00
+date: 2009-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/rcomposite/layermask.rb
 has_rdoc: true
 homepage: http://github.com/corbanbrook/rcomposite
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: An RMagick abstration layer for easy image compositing