raylib-bindings 0.1.4 → 0.2.0

data/lib/raylib.rb

@@ -4,152 +4,34 @@
 
 require 'ffi'
 require 'fileutils'
-require_relative 'raylib_main.rb'
-require_relative 'raymath.rb'
-require_relative 'rlgl.rb'
-require_relative 'raygui.rb'
-require_relative 'physac.rb'
+require_relative 'raylib_main'
+require_relative 'config'
+require_relative 'raymath'
+require_relative 'rlgl'
+require_relative 'raygui'
+require_relative 'physac'
+require_relative 'raylib_helper'
 
 module Raylib
-
   extend FFI::Library
 
-  @@raylib_import_done = false
-  def self.load_lib(libpath, output_error = false, raygui_libpath: nil, physac_libpath: nil)
-
-    unless @@raylib_import_done
-      begin
-        lib_paths = [libpath, raygui_libpath, physac_libpath].compact
-
-        ffi_lib_flags :now, :global
-        ffi_lib *lib_paths
-        setup_symbols(output_error)
-
-        setup_raygui_symbols(output_error) if raygui_libpath != nil
-        setup_physac_symbols(output_error) if physac_libpath != nil
-      rescue => error
-        puts error
-      end
-    end
-
-  end
-
-  def self.setup_symbols(output_error)
-    setup_raylib_symbols(output_error)
-    setup_raymath_symbols(output_error)
-    setup_rlgl_symbols(output_error)
-  end
-
-  #
-  # Color helper
-  #
-
-  def Color.from_u8(r = 0, g = 0, b = 0, a = 255)
-    instance = Color.new
-    instance[:r] = r
-    instance[:g] = g
-    instance[:b] = b
-    instance[:a] = a
-    return instance
-  end
-
-  LIGHTGRAY  = Color.from_u8(200, 200, 200, 255)
-  GRAY       = Color.from_u8(130, 130, 130, 255)
-  DARKGRAY   = Color.from_u8(80, 80, 80, 255)
-  YELLOW     = Color.from_u8(253, 249, 0, 255)
-  GOLD       = Color.from_u8(255, 203, 0, 255)
-  ORANGE     = Color.from_u8(255, 161, 0, 255)
-  PINK       = Color.from_u8(255, 109, 194, 255)
-  RED        = Color.from_u8(230, 41, 55, 255)
-  MAROON     = Color.from_u8(190, 33, 55, 255)
-  GREEN      = Color.from_u8(0, 228, 48, 255)
-  LIME       = Color.from_u8(0, 158, 47, 255)
-  DARKGREEN  = Color.from_u8(0, 117, 44, 255)
-  SKYBLUE    = Color.from_u8(102, 191, 255, 255)
-  BLUE       = Color.from_u8(0, 121, 241, 255)
-  DARKBLUE   = Color.from_u8(0, 82, 172, 255)
-  PURPLE     = Color.from_u8(200, 122, 255, 255)
-  VIOLET     = Color.from_u8(135, 60, 190, 255)
-  DARKPURPLE = Color.from_u8(112, 31, 126, 255)
-  BEIGE      = Color.from_u8(211, 176, 131, 255)
-  BROWN      = Color.from_u8(127, 106, 79, 255)
-  DARKBROWN  = Color.from_u8(76, 63, 47, 255)
-
-  WHITE      = Color.from_u8(255, 255, 255, 255)
-  BLACK      = Color.from_u8(0, 0, 0, 255)
-  BLANK      = Color.from_u8(0, 0, 0, 0)
-  MAGENTA    = Color.from_u8(255, 0, 255, 255)
-  RAYWHITE   = Color.from_u8(245, 245, 245, 255)
+  def self.load_lib(libpath, raygui_libpath: nil, physac_libpath: nil)
+    lib_paths = [libpath, raygui_libpath, physac_libpath].compact
 
-  #
-  # Math helper
-  #
-
-  def Vector2.create(x = 0, y = 0)
-    instance = Vector2.new
-    instance[:x] = x
-    instance[:y] = y
-    return instance
-  end
-
-  def Vector3.create(x = 0, y = 0, z = 0)
-    instance = Vector3.new
-    instance[:x] = x
-    instance[:y] = y
-    instance[:z] = z
-    return instance
-  end
-
-  def Vector4.create(x = 0, y = 0, z = 0, w = 0)
-    instance = Vector4.new
-    instance[:x] = x
-    instance[:y] = y
-    instance[:z] = z
-    instance[:w] = w
-    return instance
-  end
+    ffi_lib_flags :now, :global
+    ffi_lib(*lib_paths)
+    setup_symbols
 
-  def Quaternion.create(x = 0, y = 0, z = 0, w = 0)
-    instance = Quaternion.new
-    instance[:x] = x
-    instance[:y] = y
-    instance[:z] = z
-    instance[:w] = w
-    return instance
+    setup_raygui_symbols unless raygui_libpath.nil?
+    setup_physac_symbols unless physac_libpath.nil?
+  rescue LoadError => e
+    warn e
   end
 
-  def Rectangle.create(x = 0, y = 0, width = 0, height = 0)
-    instance = Rectangle.new
-    instance[:x] = x
-    instance[:y] = y
-    instance[:width] = width
-    instance[:height] = height
-    return instance
-  end
-
-  def BoundingBox.create(*args)
-    case args.size
-    when 2
-      instance = BoundingBox.new
-      instance[:min] = args[0] # min
-      instance[:max] = args[1] # max
-      return instance
-    when 6
-      instance = BoundingBox.new
-      instance[:min] = Vector3.create(args[0], args[1], args[2]) # min_x, min_y, min_z
-      instance[:max] = Vector3.create(args[3], args[4], args[5]) # max_x, max_y, max_z
-      return instance
-    else
-      raise ArgumentError.new "BoundingBox.create : Number of arguments must be 2 or 6"
-    end
-  end
-
-  def Vector3ToFloat(v)
-    return Vector3ToFloatV(mat)[:v].to_a
-  end
-
-  def MatrixToFloat(mat)
-    return MatrixToFloatV(mat)[:v].to_a
+  def self.setup_symbols
+    setup_raylib_symbols
+    setup_raymath_symbols
+    setup_rlgl_symbols
   end
 
   #
@@ -157,22 +39,21 @@ module Raylib
   #
   def self.template
     # Copy template code to user's current directory
-    example_path = Gem::Specification.find_by_name('raylib-bindings').full_gem_path + '/examples'
-    template_code_src = example_path + '/template.rb'
+    example_path = "#{Gem::Specification.find_by_name('raylib-bindings').full_gem_path}/examples"
+    template_code_src = "#{example_path}/template.rb"
     unless File.exist? template_code_src
-      $stderr.puts "[Error] Raylib.template : Template source #{template_code_src} not found"
+      warn "[Error] Raylib.template : Template source #{template_code_src} not found"
       return false
     end
 
-    template_code_dst = Dir.getwd + '/template.rb'
+    template_code_dst = "#{Dir.getwd}/template.rb"
     if File.exist? template_code_dst
-      $stderr.puts "[Error] Raylib.template : Template destination #{template_code_dst} already exists"
+      warn "[Error] Raylib.template : Template destination #{template_code_dst} already exists"
       return false
     end
 
-    $stderr.puts "[Info] Raylib.template : #{template_code_src} => #{template_code_dst}"
+    warn "[Info] Raylib.template : #{template_code_src} => #{template_code_dst}"
     FileUtils.copy template_code_src, template_code_dst
-    $stderr.puts "[Info] Raylib.template : Done"
+    warn '[Info] Raylib.template : Done'
   end
-
 end

data/lib/raylib_helper.rb

@@ -0,0 +1,419 @@
+# Yet another raylib wrapper for Ruby
+#
+# * https://github.com/vaiorabbit/raylib-bindings
+
+module Raylib
+  #
+  # Color helper
+  #
+
+  class Color
+    def self.from_u8(r = 0, g = 0, b = 0, a = 255)
+      Color.new.set(r, g, b, a)
+    end
+
+    def set(r, g, b, a)
+      self[:r] = r
+      self[:g] = g
+      self[:b] = b
+      self[:a] = a
+      self
+    end
+
+    def r() self[:r] end
+    def r=(v) self[:r] = v end
+    def g() self[:g] end
+    def g=(v) self[:g] = v end
+    def b() self[:b] end
+    def b=(v) self[:b] = v end
+    def a() self[:a] end
+    def a=(v) self[:a] = v end
+  end
+
+  LIGHTGRAY  = Color.from_u8(200, 200, 200, 255)
+  GRAY       = Color.from_u8(130, 130, 130, 255)
+  DARKGRAY   = Color.from_u8(80, 80, 80, 255)
+  YELLOW     = Color.from_u8(253, 249, 0, 255)
+  GOLD       = Color.from_u8(255, 203, 0, 255)
+  ORANGE     = Color.from_u8(255, 161, 0, 255)
+  PINK       = Color.from_u8(255, 109, 194, 255)
+  RED        = Color.from_u8(230, 41, 55, 255)
+  MAROON     = Color.from_u8(190, 33, 55, 255)
+  GREEN      = Color.from_u8(0, 228, 48, 255)
+  LIME       = Color.from_u8(0, 158, 47, 255)
+  DARKGREEN  = Color.from_u8(0, 117, 44, 255)
+  SKYBLUE    = Color.from_u8(102, 191, 255, 255)
+  BLUE       = Color.from_u8(0, 121, 241, 255)
+  DARKBLUE   = Color.from_u8(0, 82, 172, 255)
+  PURPLE     = Color.from_u8(200, 122, 255, 255)
+  VIOLET     = Color.from_u8(135, 60, 190, 255)
+  DARKPURPLE = Color.from_u8(112, 31, 126, 255)
+  BEIGE      = Color.from_u8(211, 176, 131, 255)
+  BROWN      = Color.from_u8(127, 106, 79, 255)
+  DARKBROWN  = Color.from_u8(76, 63, 47, 255)
+
+  WHITE      = Color.from_u8(255, 255, 255, 255)
+  BLACK      = Color.from_u8(0, 0, 0, 255)
+  BLANK      = Color.from_u8(0, 0, 0, 0)
+  MAGENTA    = Color.from_u8(255, 0, 255, 255)
+  RAYWHITE   = Color.from_u8(245, 245, 245, 255)
+
+  #
+  # Math helper
+  #
+
+  class Vector2
+    def self.create(x = 0, y = 0)
+      Vector2.new.set(x, y)
+    end
+
+    def self.copy_from(vec)
+      Vector2.create(vec[:x], vec[:y])
+    end
+
+    def set(x, y)
+      self[:x] = x
+      self[:y] = y
+      self
+    end
+
+    def x() self[:x] end
+    def x=(v) self[:x] = v end
+    def y() self[:y] end
+    def y=(v) self[:y] = v end
+  end
+
+  class Vector3
+    def self.create(x = 0, y = 0, z = 0)
+      Vector3.new.set(x, y, z)
+    end
+
+    def self.copy_from(vec)
+      Vector3.create(vec[:x], vec[:y], vec[:z])
+    end
+
+    def set(x, y, z)
+      self[:x] = x
+      self[:y] = y
+      self[:z] = z
+      self
+    end
+
+    def x() self[:x] end
+    def x=(v) self[:x] = v end
+    def y() self[:y] end
+    def y=(v) self[:y] = v end
+    def z() self[:z] end
+    def z=(v) self[:z] = v end
+  end
+
+  class Vector4
+    def self.create(x = 0, y = 0, z = 0, w = 0)
+      Vector4.new.set(x, y, z, w)
+    end
+
+    def self.copy_from(vec)
+      Vector4.create(vec[:x], vec[:y], vec[:z], vec[:w])
+    end
+
+    def set(x, y, z, w)
+      self[:x] = x
+      self[:y] = y
+      self[:z] = z
+      self[:w] = w
+      self
+    end
+
+    def x() self[:x] end
+    def x=(v) self[:x] = v end
+    def y() self[:y] end
+    def y=(v) self[:y] = v end
+    def z() self[:z] end
+    def z=(v) self[:z] = v end
+    def w() self[:w] end
+    def w=(v) self[:w] = v end
+  end
+
+  class Quaternion
+    def self.create(x = 0, y = 0, z = 0, w = 0)
+      Quaternion.new.set(x, y, z, w)
+    end
+
+    def self.copy_from(quat)
+      Quaternion.create(quat[:x], quat[:y], quat[:z], quat[:w])
+    end
+
+    def set(x, y, z, w)
+      self[:x] = x
+      self[:y] = y
+      self[:z] = z
+      self[:w] = w
+      self
+    end
+
+    def x() self[:x] end
+    def x=(v) self[:x] = v end
+    def y() self[:y] end
+    def y=(v) self[:y] = v end
+    def z() self[:z] end
+    def z=(v) self[:z] = v end
+    def w() self[:w] end
+    def w=(v) self[:w] = v end
+  end
+
+  class Rectangle
+    def self.create(x = 0, y = 0, width = 0, height = 0)
+      Rectangle.new.set(x, y, width, height)
+    end
+
+    def set(x, y, width, height)
+      self[:x] = x
+      self[:y] = y
+      self[:width] = width
+      self[:height] = height
+      self
+    end
+
+    def x() self[:x] end
+    def x=(v) self[:x] = v end
+    def y() self[:y] end
+    def y=(v) self[:y] = v end
+    def width() self[:width] end
+    def width=(v) self[:width] = v end
+    def height() self[:height] end
+    def height=(v) self[:height] = v end
+  end
+
+  def BoundingBox.create(*args)
+    case args.size
+    when 2
+      instance = BoundingBox.new
+      instance[:min] = args[0] # min
+      instance[:max] = args[1] # max
+      instance
+    when 6
+      instance = BoundingBox.new
+      instance[:min] = Vector3.create(args[0], args[1], args[2]) # min_x, min_y, min_z
+      instance[:max] = Vector3.create(args[3], args[4], args[5]) # max_x, max_y, max_z
+      instance
+    else
+      raise ArgumentError.new 'BoundingBox.create : Number of arguments must be 2 or 6'
+    end
+  end
+
+  def Vector3ToFloat(vec)
+    Vector3ToFloatV(vec)[:v].to_a
+  end
+
+  def MatrixToFloat(mat)
+    MatrixToFloatV(mat)[:v].to_a
+  end
+
+  #
+  # Transform helper
+  #
+
+  class Transform
+    def t = self[:translation]
+    def r = self[:rotation]
+    def s = self[:scale]
+  end
+
+  #
+  # Model helper
+  #
+
+  # DrawModelEx : Draw a model with extended parameters
+  # @param model [Model]
+  # @param position [Vector3]
+  # @param rotationAxis [Vector3]
+  # @param rotationAngle [float]
+  # @param scale [Vector3]
+  # @param tint [Color]
+  # @return [void]
+  def DrawModelEx(model, position, rotationAxis, rotationAngle, scale, tint)
+    # [NOTE] Fixing unintended matrix modification
+    # - In C, DrawModelEx uses the whole copy of `model` on stack, which will never affect the content of original `model`.
+    #   But Ruby FFI seems to pass the reference of `model` to DrawModelEx, which results in transform accumulation (e.g.:`model` get rotated by `rotationAngle` around `rotationAxis` every frame).
+    #   So here I copy the transform into `mtx_clone` and copy back this to the original after finished calling DrawModelEx.
+    # - Other DrawXXX members (DrawModel, DrawModelWires, DrawModelWiresEx) are free from this problem.
+    #   - They call DrawModelEx in C layer, which will use the copy of `model` on stack.
+    mtx_clone = model[:transform].clone
+    internalDrawModelEx(model, position, rotationAxis, rotationAngle, scale, tint)
+    model[:transform] = mtx_clone
+  end
+
+  class Model
+    # GetModelMaterial (ruby raylib original)
+    # @param index [int] 0 ~ materialCount
+    # @return [Material]
+    def material(index = 0)
+      Material.new(self[:materials] + index * Material.size)
+    end
+
+    # GetModelMaterialCount (ruby raylib original)
+    # @return [int]
+    def material_count
+      self[:materialCount]
+    end
+
+    # GetModelBoneCount (ruby raylib original)
+    # @return [int]
+    def bone_count
+      self[:boneCount]
+    end
+
+    # @return BoneInfo
+    def bone_info(index)
+      BoneInfo.new(self[:bones] + index * BoneInfo.size)
+    end
+
+    # @return Transform
+    def bind_pose_transform(index)
+      Transform.new(self[:bindPose] + index * Transform.size)
+    end
+  end
+
+  class BoneInfo
+    def parent_bone_index
+      self[:parent]
+    end
+  end
+
+  #
+  # ModelAnimation helper
+  #
+
+  # Manages a set of ModelAnimation (ruby raylib original)
+  class ModelAnimations
+    attr_reader :anims, :anim_ptrs
+
+    def initialize
+      @anims = nil
+      @anim_ptrs = nil
+      @framePoses = nil # array of Transform**
+    end
+
+    def anim(index) = @anims[index]
+    def anims_count = @anims.length
+    def frame_count(index) = @anims[index][:frameCount]
+
+    # @return BoneInfo
+    def bone_info(anim_index, bone_index)
+      BoneInfo.new(@anims[anim_index][:bones] + bone_index * BoneInfo.size)
+    end
+
+    # @return Transform*
+    def frame_pose(index, frame)
+      @framePoses[index] + frame * FFI::NativeType::POINTER.size # Transform*
+    end
+
+    # @return Transform
+    def bone_transform(frame_pose, bone_index)
+      Transform.new(frame_pose.read_pointer + bone_index * Transform.size)
+    end
+
+    # @return Transform
+    def bone_transform_of_frame_pose(anim_index, frame, bone_index)
+      bone_transform(frame_pose(anim_index, frame), bone_index)
+    end
+
+    # @return self
+    def setup(fileName)
+      @anims, @anim_ptrs = LoadAndAllocateModelAnimations(fileName)
+      @framePoses = []
+      @anims.each do |anim|
+        @framePoses << anim[:framePoses]
+      end
+      self
+    end
+
+    def cleanup
+      UnloadAndFreeModelAnimations(@anims, @anim_ptrs)
+    end
+  end
+
+  # LoadAndAllocateModelAnimations : (ruby raylib original)
+  # @param fileName [const char *]
+  # @return array of ModelAnimation and pointer to loaded memory
+  def LoadAndAllocateModelAnimations(fileName)
+    animsCount_buf = FFI::MemoryPointer.new(:uint, 1)
+    anim_ptrs = LoadModelAnimations(fileName, animsCount_buf)
+    animsCount = animsCount_buf.read_uint
+    anims = animsCount.times.map do |i|
+      ModelAnimation.new(anim_ptrs + i * ModelAnimation.size)
+    end
+    return anims, anim_ptrs
+  end
+
+  # UnloadAndFreeModelAnimations : (ruby raylib original)
+  # @param anims [array of ModelAnimation]
+  # @param anim_ptrs [pointer to loaded memory]
+  def UnloadAndFreeModelAnimations(anims, anim_ptrs)
+    anims.each do |anim|
+      UnloadModelAnimation(anim)
+    end
+    MemFree(anim_ptrs)
+  end
+
+  #
+  # Camera helper
+  #
+
+  class Camera
+    def position
+      self[:position]
+    end
+
+    def target
+      self[:target]
+    end
+
+    def up
+      self[:up]
+    end
+
+    def fovy
+      self[:fovy]
+    end
+
+    def fovy=(v)
+      self[:fovy] = v
+    end
+
+    def projection
+      self[:projection]
+    end
+
+    def projection=(v)
+      self[:projection] = v
+    end
+  end
+
+  class Camera2D
+    def offset
+      self[:offset]
+    end
+
+    def target
+      self[:target]
+    end
+
+    def rotation
+      self[:rotation]
+    end
+
+    def rotation=(v)
+      self[:rotation] = v
+    end
+
+    def zoom
+      self[:zoom]
+    end
+
+    def zoom=(v)
+      self[:zoom] = v
+    end
+  end
+
+end