vector2d 0.0.5

data/lib/vector2d.rb

@@ -0,0 +1,157 @@
+#--
+# Copyright (c) 2006 Inge Jørgensen <inge@elektronaut.no>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+
+# Class for for easy handling of two-dimensional coordinates. It's forte is argument flexibility, 
+# methods that take vectors accepts arguments in many forms. See Vector2d.new for details and examples.
+class Vector2d
+
+  # X axis
+  attr_accessor :x
+  # Y axis
+  attr_accessor :y
+
+
+
+  # Create a new vector from args. The following examples are equal:
+  #   Vector2d.new( 150, 100 )
+  #   Vector2d.new( 150.0, 100.0 )
+  #   Vector2d.new( "150x100" )
+  #   Vector2d.new( "150.0x100.0" )
+  #   Vector2d.new( [150,100} )
+  #   Vector2d.new( { :x => 150, :y => 100 } )
+  #   Vector2d.new( { "x" => 150.0, "y" => 100.0 } )
+  #   Vector2d.new( Vector2d.new( 150, 100 ) )
+  def initialize( *args )
+    args.flatten!
+	if ( args.length == 1 )
+		if ( args[0].kind_of?( String ) && args[0].match( /^[\s]*[\d\.]*[\s]*x[\s]*[\d\.]*[\s]*$/ ) )
+			args = args[0].split( "x" )
+		elsif args[0].kind_of?( Vector2d )
+			args = [ args[0].x, args[0].y ]
+		elsif args[0].kind_of?( Hash )
+			args[0] = args[0][:x]  if args[0][:x]
+			args[0] = args[0]["x"] if args[0]["x"]
+			args[1] = args[0][:y]  if args[0][:y]
+			args[1] = args[0]["y"] if args[0]["y"]
+		else
+			args = [ args[0], args[0] ]
+		end
+	end
+	@x, @y = args[0].to_f, args[1].to_f
+  end
+
+
+
+  # Compare two vectors
+  def ==( comp )
+	( comp.x == @x && comp.y == y )
+  end
+
+
+
+  # Get a String representation of vector.
+  #   Vector2d.new( 150, 100 ).to_s  # "150x100"
+  def to_s; "#{@x}x#{@y}"; end
+  
+  
+  
+  # Get length of vector.
+  def length; Math.sqrt((@x*@x)+(@y*@y)); end
+  
+  # Set new length.
+  def length= ( new_length )
+    v = self * (new_length/length)
+    @x, @y = v.x, v.y
+  end
+  
+  
+  
+  # Normalize vector (set length to 1.0)
+  def normalize;  self.dup.normalize!; end
+  # In-place form of Vector2d.normalize.
+  def normalize!; length = 1.0; self; end
+
+
+  # Round coordinates to nearest integer.
+  def round; self.dup.round!; end
+  # In-place form of Vector2d.round.
+  def round!; @x, @y = @x.round, @y.round; self; end
+
+
+  # Get the aspect ratio of the vector, returns a Float.
+  def aspect_ratio; (@x/@y).abs; end
+  
+  
+
+  # Multiply vectors. If args is a single Numeric, both axis will be multiplied.
+  def * ( *vector_or_number ); v = Vector2d::new( vector_or_number ); Vector2d.new( @x * v.x, @y * v.y ); end
+  # Divide vectors. If args is a single Numeric, both axis will be divided.
+  def / ( *vector_or_number ); v = Vector2d::new( vector_or_number ); Vector2d.new( @x / v.x, @y / v.y ); end
+  # Add vectors. If args is a single Numeric, it will be added to both axis.
+  def + ( *vector_or_number ); v = Vector2d::new( vector_or_number ); Vector2d.new( @x + v.x, @y + v.y ); end
+  # Subtract vectors. If args is a single Numeric, it will be subtracted from both axis.
+  def - ( *vector_or_number ); v = Vector2d::new( vector_or_number ); Vector2d.new( @x - v.x, @y - v.y ); end
+  
+  
+  
+  # Constrain/expand so that both coordinates fit within (the square implied by) another vector.
+  # This is useful for resizing images to fit a certain size while keeping aspect ratio.
+  #
+  # == Examples
+  #
+  #   my_image = Vector2d.new( "320x200" )  # Creates a new vector object
+  #   my_image.constrain_both( 100 )        # Returns a new vector: x=100, y=63
+  #   my_image.constrain_both( 150, 50 )    # Returns a new vector: x=80, y=50
+  #   my_image.constrain_both( "150x50" )   # Equal to constrain_both( 150, 50 )
+  #   my_image.constrain_both( "x100" )     # Returns a new vector: x=160, y=100
+  #
+  # == Note
+  #
+  # Either axis will be disregarded if zero or nil (see the last example). This is a feature, not a bug. ;)
+  def constrain_both( *vector_or_number )
+    scale = Vector2d::new( vector_or_number ) / self
+    ( self * ( (scale.y==0||(scale.x>0&&scale.x<scale.y) ) ? scale.x : scale.y ) )
+  end
+    
+    
+  
+  # Constrain/expand so that one of the coordinates fit within (the square implied by) another vector.
+  #
+  # == Example
+  #  
+  #   my_image = Vector2d.new( "320x200" )  # Creates a new vector object
+  #   my_image.constrain_one( 100, 100 )    # Returns a new vector: x=160, y=100
+  def constrain_one( *vector_or_number )
+    scale = Vector2d::new( vector_or_number ) / self
+    if ( scale.x > 0 && scale.y > 0 )
+	  scale = ( scale.x<scale.y) ? scale.y : scale.x
+	  self * scale
+    else
+      constrain_both( args )
+    end
+  end
+  
+end #class Vector2d
+
+

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: vector2d
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+date: 2006-12-10 00:00:00 +01:00
+summary: A simplistic class for handling two-dimensional vectors.
+require_paths: 
+- lib
+email: inge@elektronaut.no
+homepage: http://rubyforge.org/projects/vector2d/
+rubyforge_project: vector2d
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- "Inge J\xC3\xB8rgensen"
+files: 
+- lib/vector2d.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+