rhex 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6deb19b3fa7658e30adc918242cfd55c6c96a831
-  data.tar.gz: e9c1ac59f2faec0c63ba0515d45552964d4eb114
+  metadata.gz: 06af15a3d397116a537acb467bbc2689f637c08c
+  data.tar.gz: aac1063765276f0585e0cde65a53ae9fcc9c3b6f
 SHA512:
-  metadata.gz: 98ea9582bb07c5312714d37f0e36be129eca200e1c538d8a9a728adafee915dc64209bcc26d708576fd01f0cae17f6a3927e870bf71c1ecde81b9f1500bbb746
-  data.tar.gz: c7a8f7d08d20ab059c16f553b72a0b72784e57d7509f89f9d509518d96455cef935a9877188d8952b0f76416adcb9c4c69b6b98d8463dc38cf2e75609cfe55d7
+  metadata.gz: e3b945daad5e4b6a0398effd1d4d14d817789725a27cd0b1b121da3b2677500035e91bd294715b79c56bd97c3f2dc7a3a5359eff64f91a27ebd779c15425f889
+  data.tar.gz: c9f595a299135cdbada16d8e9329e90bfb37ef1fb5e5f821a956b328ecebb8daec97c3ec5f8568c64bbc010d1dc93fabcc1f91d21a412bfb1c7bb1112ef9c187

data/lib/hex/ascii_to_grid.rb

@@ -2,17 +2,31 @@ module AsciiToGrid
 
   def read_ascii_file( file_path )
     File.open( file_path ) do |file|
-      r = 0
+
+      r = max_q = max_r = 0
       file.each_line do |line|
         elements = line.split
         q = 0
         elements.each do |element|
-          set( q, r, element )
+          border = true if ( r == 0 || q == 0 )
+          cset( q, r, val: element, border: border )
           q += 1
+          max_q = [ max_q, q ].max
         end
         r += 1
+        max_r = [ max_r, r ].max
+      end
+
+      0.upto( max_q - 1 ).each do |q|
+        hex = cget( q, max_r - 1 )
+        hex.border! if hex
       end
+
+      0.upto( max_r - 1 ).each do |row|
+        hex = cget( max_q - 1, row )
+        hex.border! if hex
+      end
+
     end
   end
-
 end

data/lib/hex/axial.rb

@@ -7,16 +7,15 @@ module Hex
 
     attr_reader :q, :r, :val
 
-    R = 16
-
     # Directions around hex from top left clockwise
     DIRECTIONS = [ [0,-1], [1,-1], [1,0], [0,1], [-1,+1], [-1,0] ]
 
-    # Create a new flat topped axial represented hexagon object
-    def initialize( q, r, val = nil)
+    # Create a new pointy topped axial represented hexagon object
+    def initialize( q, r, val: nil, border: false )
       @q = q
       @r = r
       @val = val.to_sym if val
+      @border = border
     end
 
     # Equality between two hexagons
@@ -24,21 +23,14 @@ module Hex
       @q==h.q && @r==h.r
     end
 
-    # Create an hexagon object from (x,y) coordinate
-    def self.hex_at_xy(x, y)
-      x-=R
-      y-=R
-      q = x * 2/3 / R
-      r = (-x / 3 + Math.sqrt(3)/3 * y) / R
-      Hex::Axial.new(q, r).round
+    # Force the border status of the hex
+    def border!
+      @border = true
     end
 
-    # Give the position of an hexagone object in pixel
-    def to_xy
-      pix_r = r - ( @q/2 )
-      x = R * 3/2 * @q
-      y = ( ( R.to_f * Math.sqrt(3) ).round * (pix_r.to_f + @q.to_f/2.to_f) )
-      [ x, y ]
+    # Get the border status of the hex
+    def border?
+      !@border.nil?
     end
 
     # Transform flat topped axial represented hexagon object to flat topped cube represented hexagon object
@@ -72,17 +64,15 @@ module Hex
       DIRECTIONS.map{ |e| Hex::Axial.new( @q+e[0], @r+e[1] ) }
     end
 
-    # Check if an hexagon is around another exagon
+    # Check if an hexagon is around another hexagon
     def hex_surrounding_hex?(hex)
       distance(hex)==1
     end
 
-    private
-
-    # Round an hexagone coordinates (useful after pixel to axial coordinate transformation)
-    def round
-      to_cube.round.to_axial
-    end
+    # Round an hexagon coordinates (useful after pixel to axial coordinate transformation)
+    # def round
+    #   to_cube.round.to_axial
+    # end
 
   end
 end

data/lib/hex/cube.rb

@@ -15,24 +15,24 @@ module Hex
     end
 
     # Round an float coordonate hexagon to an integer hexagon
-    def round
-      rx=@x.round(0)
-      ry=@y.round(0)
-      rz=@z.round(0)
-
-      x_diff=(rx-@x).abs
-      y_diff=(ry-@y).abs
-      z_diff=(rz-@z).abs
-
-      if x_diff > y_diff and x_diff > z_diff
-        rx = -ry-rz
-      elsif y_diff > z_diff
-        ry = -rx-rz
-      else
-        rz = -rx-ry
-      end
-      Hex::Cube.new(rx,ry,rz)
-    end
+    # def round
+    #   rx=@x.round(0)
+    #   ry=@y.round(0)
+    #   rz=@z.round(0)
+    #
+    #   x_diff=(rx-@x).abs
+    #   y_diff=(ry-@y).abs
+    #   z_diff=(rz-@z).abs
+    #
+    #   if x_diff > y_diff and x_diff > z_diff
+    #     rx = -ry-rz
+    #   elsif y_diff > z_diff
+    #     ry = -rx-rz
+    #   else
+    #     rz = -rx-ry
+    #   end
+    #   Hex::Cube.new(rx,ry,rz)
+    # end
 
     def distance(h)
       [(@x - h.x).abs, (@y - h.y).abs, (@z - h.z).abs].max

data/lib/hex/grid.rb

@@ -8,40 +8,52 @@ module Hex
     include GridToPic
     include AsciiToGrid
 
-    def initialize( element_to_color_hash = {} )
+    def initialize( hex_ray: 16, element_to_color_hash: {} )
       @hexes={}
       @element_to_color_hash = element_to_color_hash
+      @hex_ray = hex_ray
+      set_hex_dimensions
     end
 
-    # Position aa value at hexagon coordinate
-    # You can use the form set( q, r, value )
-    # Or set( hex, value )
-    # In both case value can be nil.
-    def set( *args )
-      raise ArgumentError, 'Incorrect number of arguments' if args.length < 1 || args.length > 3
-      fa=args.shift
-      if fa.class == Hex::Axial
-        @hexes[ [ fa.q, fa.r ] ] = Hex::Axial.new( fa.q, fa.r, args.shift )
-      else
-        q=fa
-        r=args.shift
-        @hexes[ [ q, r ] ] = Hex::Axial.new( q, r, args.shift )
-      end
+    # Create an hexagon at a given position (q, r)
+    # You can set a value for the hexagon and set the hex as a border hex or not
+    def cset( q, r, val: nil, border: false )
+      @hexes[ [ q, r ] ] = Hex::Axial.new( q, r, val: val, border: border )
     end
 
-    # Get the value of stored at hexagon coordinate
-    # You can use the form get( q, r )
-    # Or get( hex )
-    def get( *args )
-      raise( ArgumentError, 'Incorrect number of arguments' ) if args.length < 1 || args.length > 2
-      fa=args.shift
-      if fa.class == Hex::Axial
-        @hexes[ [ fa.q, fa.r ] ]
-      else
-        q=fa
-        r=args.shift
-        @hexes[ [ q, r ] ]
-      end
+    # Same method, but accept an hexagon instead of (q, r) coords
+    def hset( hex, val: nil, border: false )
+      @hexes[ [ hex.q, hex.r ] ] = Hex::Axial.new( hex.q, hex.r, val: val, border: border )
+    end
+
+    # Get the hexagon at a given position (q, r)
+    def cget( q, r )
+      @hexes[ [ q, r ] ]
+    end
+
+    # Same method, but accept an hexagon instead of (q, r) coords
+    def hget( hex )
+      @hexes[ [ hex.q, hex.r ] ]
+    end
+
+    # Create an hexagon object from (x,y) coordinate
+    # q = (x * sqrt(3)/3 - y / 3) / size
+    # r = y * 2/3 / size
+    # return hex_round(Hex(q, r))
+    # def hex_at_xy(x, y)
+    #   # x-=@hex_width/2.0
+    #   # y-=@hex_height/2.0
+    #   q = (x * Math.sqrt(3)/3.0 - y/3.0) / @hex_ray
+    #   r = y * 2.0/3.0 / @hex_ray
+    #   Hex::Axial.new(q, r).round
+    # end
+
+    # Give the position of an hexagon object in pixel.
+    def to_xy( hex )
+      tmp_q = hex.q - ( hex.r/2.0 ).floor
+      x = @hex_ray * Math.sqrt(3) * ( tmp_q + hex.r/2.0 )
+      y = @hex_ray * 3.0/2.0 * hex.r
+      [ x, y ]
     end
 
   end

data/lib/hex/grid_to_pic.rb

@@ -9,33 +9,38 @@ end
 
 module GridToPic
 
+  attr_reader :hex_height, :hex_width
+
   def to_pic( pic_name, exit_on_error = true )
     unless defined?( Magick::Image ) && defined?( Magick::HatchFill ) && defined?( Magick::Draw )
       puts 'Rmagick is not installed !!! You can\'t dump hex grid to pic'
       exit if exit_on_error
     end
 
-    canvas = Magick::Image.new( 500, 500 )
+    maxx = @hexes.keys.map{ |k| k[0] }.max * @hex_width
+    maxy = @hexes.keys.map{ |k| k[1] }.max * @hex_height * 3.0/4.0
+
+    canvas = Magick::Image.new( maxx, maxy )
     gc = Magick::Draw.new
-    width = Hex::Axial::R * 2
-    quarter_width = width / 4.0
-    height = Math.sqrt(3)/2 * width
-    half_height = height / 2.0
-
-    @hexes.each do |pos, hex|
-      x, y = hex.to_xy
-
-      color = get_color( hex )
-      gc.stroke( 'black' )
-      gc.fill( color.to_s )
-      gc.polygon( x-quarter_width, y-half_height, x+quarter_width, y-half_height, x+quarter_width*2, y,
-                  x+quarter_width, y+half_height, x-quarter_width, y+half_height, x-quarter_width*2, y )
-    end
+    gc.stroke_antialias( true )
+    gc.stroke( 'black' )
+
+    @hexes.each{ | _, hex| draw_hex( gc, hex ) }
 
     gc.draw(canvas)
     canvas.write( pic_name )
   end
 
+  def set_hex_dimensions
+
+    @hex_height = @hex_ray * 2.0
+    @hex_width =  Math.sqrt(3)/2.0 * @hex_height
+
+    @half_width = @hex_width / 2.0
+    @quarter_height = @hex_height / 4.0
+
+  end
+
   private
 
   def get_color( hex )
@@ -43,4 +48,18 @@ module GridToPic
     color ? color : :white
   end
 
+  def draw_hex( gc, hex )
+    x, y = to_xy( hex )
+
+    color = get_color( hex )
+    gc.fill( color.to_s )
+
+    gc.polygon( x - @half_width, y + @quarter_height,
+                x, y + 2*@quarter_height,
+                x + @half_width, y + @quarter_height,
+                x + @half_width, y - @quarter_height,
+                x, y - 2*@quarter_height,
+                x - @half_width, y - @quarter_height )
+  end
+
 end

data/lib/rhex.rb

@@ -1,3 +1,3 @@
-require 'hex/axial'
-require 'hex/cube'
-require 'hex/grid'
+require_relative 'hex/axial'
+require_relative 'hex/cube'
+require_relative 'hex/grid'

metadata

@@ -1,16 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: rhex
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cédric ZUGER
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies: []
-description: A library designed to provide hexagonal grids for ruby
+description: |2
+      A library designed to provide hexagonal grids for ruby.
+      - Coordinate system is axial, bitmap representation is pointy topped.
+      - Provide various hex methods (surrounding hexes, nearest hex, distance between two hexes)
+      - Provide a method to create a grid from an ascii map
+      - Provide a method to dump your hex grid to a bitmap file (require rmagick)
 email: 
 executables: []
 extensions: []
@@ -34,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -42,9 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby HEXagonal grid
 test_files: []
-has_rdoc: