cyberarm_engine 0.13.0 → 0.13.1

data/lib/cyberarm_engine/ui/style.rb

@@ -1,37 +1,37 @@
-module Gosu
-  class Color
-    def _dump(level)
-      [
-        "%02X" % self.alpha,
-        "%02X" % self.red,
-        "%02X" % self.green,
-        "%02X" % self.blue
-      ].join
-    end
-
-    def self._load(hex)
-      argb(hex.to_i(16))
-    end
-  end
-end
-
-module CyberarmEngine
-  class Style
-    def initialize(hash = {})
-      @hash = Marshal.load(Marshal.dump(hash))
-    end
-
-    def method_missing(method, *args, &block)
-      if method.to_s.end_with?("=")
-        raise "Did not expect more than 1 argument" if args.size > 1
-        return @hash[method.to_s.sub("=", "").to_sym] = args.first
-
-      elsif args.size == 0
-        return @hash[method]
-
-      else
-        raise ArgumentError, "Did not expect arguments"
-      end
-    end
-  end
+module Gosu
+  class Color
+    def _dump(level)
+      [
+        "%02X" % self.alpha,
+        "%02X" % self.red,
+        "%02X" % self.green,
+        "%02X" % self.blue
+      ].join
+    end
+
+    def self._load(hex)
+      argb(hex.to_i(16))
+    end
+  end
+end
+
+module CyberarmEngine
+  class Style
+    def initialize(hash = {})
+      @hash = Marshal.load(Marshal.dump(hash))
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s.end_with?("=")
+        raise "Did not expect more than 1 argument" if args.size > 1
+        return @hash[method.to_s.sub("=", "").to_sym] = args.first
+
+      elsif args.size == 0
+        return @hash[method]
+
+      else
+        raise ArgumentError, "Did not expect arguments"
+      end
+    end
+  end
 end

data/lib/cyberarm_engine/ui/theme.rb

@@ -1,120 +1,120 @@
-module CyberarmEngine
-  module Theme
-    def default(*args)
-      value = @options
-      args.each do |arg|
-        value = value.dig(arg)
-      end
-
-      value
-    end
-
-    def theme_defaults(options)
-      raise "Error" unless self.class.ancestors.include?(CyberarmEngine::Element)
-      _theme = THEME
-      _theme = _theme.merge(options[:theme]) if options[:theme]
-      _theme.delete(:theme) if options[:theme]
-
-      hash = {}
-      class_names = self.class.ancestors
-      class_names = class_names[0..class_names.index(CyberarmEngine::Element)].map! {|c| c.to_s.split("::").last.to_sym}.reverse!
-
-      class_names.each do |klass|
-        next unless data = _theme.dig(klass)
-        data.each do |key, value|
-          hash.merge!(data)
-        end
-      end
-
-      deep_merge(hash, options)
-    end
-
-    # Derived from Rails Hash#deep_merge!
-    # Enables passing partial themes through Element options without issue
-    def deep_merge(original, intergrate, &block)
-      hash = original.merge(intergrate) do |key, this_val, other_val|
-        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
-          deep_merge(this_val, other_val, &block)
-        elsif block_given?
-          block.call(key, this_val, other_val)
-        else
-          other_val
-        end
-      end
-
-      return hash
-    end
-
-    THEME = {
-      Element: {
-        x: 0,
-        y: 0,
-        z: 30,
-
-        width:  nil,
-        height: nil,
-        color:     Gosu::Color::WHITE,
-        background: Gosu::Color::NONE,
-        margin:   0,
-        padding:  0,
-        border_thickness: 0,
-        border_color: Gosu::Color::NONE,
-        border_radius: 0,
-      },
-
-      Button: { # < Label
-        margin:   1,
-        padding:  4,
-        border_thickness: 1,
-        border_color: ["ffd59674".hex, "ffff8746".hex],
-        border_radius: 0,
-        background: ["ffc75e61".to_i(16), "ffe26623".to_i(16)],
-
-        hover: {
-          color: Gosu::Color.rgb(200,200,200),
-          background:  ["ffB23E41".to_i(16), "ffFF7C00".to_i(16)],
-        },
-
-        active: {
-          color: Gosu::Color::BLACK,
-          background: ["ffB23E41".to_i(16)]
-        }
-      },
-
-      EditLine: { # < Button
-        type: :text,
-        width: 200,
-        password_character: "•",
-        caret_width: 2,
-        caret_color: Gosu::Color::WHITE,
-        caret_interval: 500,
-        selection_color: Gosu::Color::GREEN,
-      },
-
-      Image: { # < Element
-        retro: false
-      },
-
-      Label: { # < Element
-      text_size: 28,
-      text_shadow: false,
-      font: "Arial",
-      margin: 0,
-      padding: 2
-      },
-
-      ToggleButton: { # < Button
-        checkmark: "√"
-      },
-
-      Progress: { # < Element
-        width: 250,
-        height: 36,
-        background: 0xff111111,
-        fraction_background: [0xffc75e61, 0xffe26623],
-        border_thickness: 1,
-        border_color: [0xffd59674, 0xffff8746]
-      }
-    }.freeze
-  end
-end
+module CyberarmEngine
+  module Theme
+    def default(*args)
+      value = @options
+      args.each do |arg|
+        value = value.dig(arg)
+      end
+
+      value
+    end
+
+    def theme_defaults(options)
+      raise "Error" unless self.class.ancestors.include?(CyberarmEngine::Element)
+      _theme = THEME
+      _theme = _theme.merge(options[:theme]) if options[:theme]
+      _theme.delete(:theme) if options[:theme]
+
+      hash = {}
+      class_names = self.class.ancestors
+      class_names = class_names[0..class_names.index(CyberarmEngine::Element)].map! {|c| c.to_s.split("::").last.to_sym}.reverse!
+
+      class_names.each do |klass|
+        next unless data = _theme.dig(klass)
+        data.each do |key, value|
+          hash.merge!(data)
+        end
+      end
+
+      deep_merge(hash, options)
+    end
+
+    # Derived from Rails Hash#deep_merge!
+    # Enables passing partial themes through Element options without issue
+    def deep_merge(original, intergrate, &block)
+      hash = original.merge(intergrate) do |key, this_val, other_val|
+        if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+          deep_merge(this_val, other_val, &block)
+        elsif block_given?
+          block.call(key, this_val, other_val)
+        else
+          other_val
+        end
+      end
+
+      return hash
+    end
+
+    THEME = {
+      Element: {
+        x: 0,
+        y: 0,
+        z: 30,
+
+        width:  nil,
+        height: nil,
+        color:     Gosu::Color::WHITE,
+        background: Gosu::Color::NONE,
+        margin:   0,
+        padding:  0,
+        border_thickness: 0,
+        border_color: Gosu::Color::NONE,
+        border_radius: 0,
+      },
+
+      Button: { # < Label
+        margin:   1,
+        padding:  4,
+        border_thickness: 1,
+        border_color: ["ffd59674".hex, "ffff8746".hex],
+        border_radius: 0,
+        background: ["ffc75e61".to_i(16), "ffe26623".to_i(16)],
+
+        hover: {
+          color: Gosu::Color.rgb(200,200,200),
+          background:  ["ffB23E41".to_i(16), "ffFF7C00".to_i(16)],
+        },
+
+        active: {
+          color: Gosu::Color::BLACK,
+          background: ["ffB23E41".to_i(16)]
+        }
+      },
+
+      EditLine: { # < Button
+        type: :text,
+        width: 200,
+        password_character: "•",
+        caret_width: 2,
+        caret_color: Gosu::Color::WHITE,
+        caret_interval: 500,
+        selection_color: Gosu::Color::GREEN,
+      },
+
+      Image: { # < Element
+        retro: false
+      },
+
+      Label: { # < Element
+      text_size: 28,
+      text_shadow: false,
+      font: "Arial",
+      margin: 0,
+      padding: 2
+      },
+
+      ToggleButton: { # < Button
+        checkmark: "√"
+      },
+
+      Progress: { # < Element
+        width: 250,
+        height: 36,
+        background: 0xff111111,
+        fraction_background: [0xffc75e61, 0xffe26623],
+        border_thickness: 1,
+        border_color: [0xffd59674, 0xffff8746]
+      }
+    }.freeze
+  end
+end

data/lib/cyberarm_engine/vector.rb

@@ -1,203 +1,290 @@
-module CyberarmEngine
-  class Vector
-    def self.up
-      Vector.new(0, 1, 0)
-    end
-
-    def self.down
-      Vector.new(0, -1, 0)
-    end
-
-    def self.left
-      Vector.new(-1, 0, 0)
-    end
-
-    def self.right
-      Vector.new(1, 0, 0)
-    end
-
-    def self.forward
-      Vector.new(0, 0, 1)
-    end
-
-    def self.backward
-      Vector.new(0, 0, -1)
-    end
-
-    def initialize(x = 0, y = 0, z = 0, weight = 0)
-      @x, @y, @z, @weight = x, y, z, weight
-    end
-
-    def x; @x; end
-    def x=(n); @x = n; end
-
-    def y; @y; end
-    def y=(n); @y = n; end
-
-    def z; @z; end
-    def z=(n); @z = n; end
-
-    def weight; @weight; end
-    def weight=(n); @weight = n; end
-
-    alias w weight
-    alias w= weight=
-
-    def ==(other)
-      if other.is_a?(Numeric)
-        @x      == other &&
-        @y      == other &&
-        @z      == other &&
-        @weight == other
-      else
-        @x      == other.x &&
-        @y      == other.y &&
-        @z      == other.z &&
-        @weight == other.weight
-      end
-    end
-
-    def xy
-      Vector.new(@x, @y)
-    end
-
-    # Performs math operation, excluding @weight
-    private def operator(function, other)
-      if other.is_a?(Numeric)
-        Vector.new(
-          @x.send(:"#{function}", other),
-          @y.send(:"#{function}", other),
-          @z.send(:"#{function}", other)
-        )
-      else
-        Vector.new(
-          @x.send(:"#{function}", other.x),
-          @y.send(:"#{function}", other.y),
-          @z.send(:"#{function}", other.z)
-        )
-      end
-    end
-
-    # Adds Vector and Numberic or Vector and Vector, excluding @weight
-    def +(other)
-      operator("+", other)
-    end
-
-    # Subtracts Vector and Numberic or Vector and Vector, excluding @weight
-    def -(other)
-      operator("-", other)
-    end
-
-    # Multiplies Vector and Numberic or Vector and Vector, excluding @weight
-    def *(other)
-      operator("*", other)
-    end
-
-    # Divides Vector and Numberic or Vector and Vector, excluding @weight
-    def /(other)
-      # Duplicated to protect from DivideByZero
-      if other.is_a?(Numeric)
-        Vector.new(
-          (@x == 0 ? 0 : @x / other),
-          (@y == 0 ? 0 : @y / other),
-          (@z == 0 ? 0 : @z / other)
-        )
-      else
-        Vector.new(
-          (@x == 0 ? 0 : @x / other.x),
-          (@y == 0 ? 0 : @y / other.y),
-          (@z == 0 ? 0 : @z / other.z)
-        )
-      end
-    end
-
-    def dot(other)
-      product = 0
-
-      a = self.to_a
-      b = other.to_a
-
-      3.times do |i|
-        product = product + (a[i] * b[i])
-      end
-
-      return product
-    end
-
-    def cross(other)
-      a = self.to_a
-      b = other.to_a
-
-      Vector.new(
-        b[2] * a[1] - b[1] * a[2],
-        b[0] * a[2] - b[2] * a[0],
-        b[1] * a[0] - b[0] * a[1]
-      )
-    end
-
-    # returns degrees
-    def angle(other)
-      Math.acos( self.normalized.dot(other.normalized) ) * 180 / Math::PI
-    end
-
-    # returns magnitude of Vector, ignoring #weight
-    def magnitude
-      Math.sqrt((@x * @x) + (@y * @y) + (@z * @z))
-    end
-
-    def normalized
-      mag = magnitude
-      self / Vector.new(mag, mag, mag)
-    end
-
-    def direction
-      # z is pitch
-      # y is yaw
-      # x is roll
-      _x = -Math.sin(@y.degrees_to_radians) * Math.cos(@z.degrees_to_radians)
-      _y = Math.sin(@z.degrees_to_radians)
-      _z = Math.cos(@y.degrees_to_radians) * Math.cos(@z.degrees_to_radians)
-
-      Vector.new(_x, _y, _z)
-    end
-
-    def inverse
-      Vector.new(1.0 / @x, 1.0 / @y, 1.0 / @z)
-    end
-
-    def sum
-      @x + @y + @z
-    end
-
-    def lerp(other, factor)
-      (self - other) * factor.clamp(0.0, 1.0)
-    end
-
-    # 2D distance using X and Y
-    def distance(other)
-      Math.sqrt((@x-other.x)**2 + (@y-other.y)**2)
-    end
-
-    # 2D distance using X and Z
-    def gl_distance2d(other)
-      Math.sqrt((@x-other.x)**2 + (@z-other.z)**2)
-    end
-
-    # 3D distance using X, Y, and Z
-    def distance3d(other)
-      Math.sqrt((@x-other.x)**2 + (@y-other.y)**2 + (@z-other.z)**2)
-    end
-
-    def to_a
-      [@x, @y, @z, @weight]
-    end
-
-    def to_s
-      "X: #{@x}, Y: #{@y}, Z: #{@z}, Weight: #{@weight}"
-    end
-
-    def to_h
-      {x: @x, y: @y, z: @z, weight: @weight}
-    end
-  end
+module CyberarmEngine
+  class Vector
+    ##
+    # Creates a up vector
+    #
+    #   Vector.new(0, 1, 0)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.up
+      Vector.new(0, 1, 0)
+    end
+
+    ##
+    # Creates a down vector
+    #
+    #   Vector.new(0, -1, 0)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.down
+      Vector.new(0, -1, 0)
+    end
+
+    ##
+    # Creates a left vector
+    #
+    #   Vector.new(-1, 0, 0)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.left
+      Vector.new(-1, 0, 0)
+    end
+
+    ##
+    # Creates a right vector
+    #
+    #   Vector.new(1, 0, 0)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.right
+      Vector.new(1, 0, 0)
+    end
+
+    ##
+    # Creates a forward vector
+    #
+    #   Vector.new(0, 0, 1)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.forward
+      Vector.new(0, 0, 1)
+    end
+
+    ##
+    # Creates a backward vector
+    #
+    #   Vector.new(0, 0, -1)
+    #
+    # @return [CyberarmEngine::Vector]
+    def self.backward
+      Vector.new(0, 0, -1)
+    end
+
+    def initialize(x = 0, y = 0, z = 0, weight = 0)
+      @x, @y, @z, @weight = x, y, z, weight
+    end
+
+    def x; @x; end
+    def x=(n); @x = n; end
+
+    def y; @y; end
+    def y=(n); @y = n; end
+
+    def z; @z; end
+    def z=(n); @z = n; end
+
+    def weight; @weight; end
+    def weight=(n); @weight = n; end
+
+    alias w weight
+    alias w= weight=
+
+    # @return [Boolean]
+    def ==(other)
+      if other.is_a?(Numeric)
+        @x      == other &&
+        @y      == other &&
+        @z      == other &&
+        @weight == other
+      elsif other.is_a?(Vector)
+        @x      == other.x &&
+        @y      == other.y &&
+        @z      == other.z &&
+        @weight == other.weight
+      else
+        other == self
+      end
+    end
+
+    # Create a new vector using {x} and {y} values
+    # @return [CyberarmEngine::Vector]
+    def xy
+      Vector.new(@x, @y)
+    end
+
+    # Performs math operation, excluding {weight}
+    private def operator(function, other)
+      if other.is_a?(Numeric)
+        Vector.new(
+          @x.send(:"#{function}", other),
+          @y.send(:"#{function}", other),
+          @z.send(:"#{function}", other)
+        )
+      else
+        Vector.new(
+          @x.send(:"#{function}", other.x),
+          @y.send(:"#{function}", other.y),
+          @z.send(:"#{function}", other.z)
+        )
+      end
+    end
+
+    # Adds Vector and Numeric or Vector and Vector, excluding {weight}
+    # @return [CyberarmEngine::Vector]
+    def +(other)
+      operator("+", other)
+    end
+
+    # Subtracts Vector and Numeric or Vector and Vector, excluding {weight}
+    # @return [CyberarmEngine::Vector]
+    def -(other)
+      operator("-", other)
+    end
+
+    # Multiplies Vector and Numeric or Vector and Vector, excluding {weight}
+    # @return [CyberarmEngine::Vector]
+    def *(other)
+      operator("*", other)
+    end
+
+    # Divides Vector and Numeric or Vector and Vector, excluding {weight}
+    # @return [CyberarmEngine::Vector]
+    def /(other)
+      # Duplicated to protect from DivideByZero
+      if other.is_a?(Numeric)
+        Vector.new(
+          (@x == 0 ? 0 : @x / other),
+          (@y == 0 ? 0 : @y / other),
+          (@z == 0 ? 0 : @z / other)
+        )
+      else
+        Vector.new(
+          (@x == 0 ? 0 : @x / other.x),
+          (@y == 0 ? 0 : @y / other.y),
+          (@z == 0 ? 0 : @z / other.z)
+        )
+      end
+    end
+
+    # dot product of {Vector}
+    # @return [Integer|Float]
+    def dot(other)
+      product = 0
+
+      a = self.to_a
+      b = other.to_a
+
+      3.times do |i|
+        product = product + (a[i] * b[i])
+      end
+
+      return product
+    end
+
+    # cross product of {Vector}
+    # @return [CyberarmEngine::Vector]
+    def cross(other)
+      a = self.to_a
+      b = other.to_a
+
+      Vector.new(
+        b[2] * a[1] - b[1] * a[2],
+        b[0] * a[2] - b[2] * a[0],
+        b[1] * a[0] - b[0] * a[1]
+      )
+    end
+
+    # returns degrees
+    # @return [Float]
+    def angle(other)
+      Math.acos( self.normalized.dot(other.normalized) ) * 180 / Math::PI
+    end
+
+    # returns magnitude of Vector, ignoring #weight
+    # @return [Float]
+    def magnitude
+      Math.sqrt((@x * @x) + (@y * @y) + (@z * @z))
+    end
+
+    ##
+    # returns normalized {Vector}
+    #
+    # @example
+    #   CyberarmEngine::Vector.new(50, 21.2, 45).normalized
+    #   # => <CyberarmEngine::Vector:0x001 @x=0.7089... @y=0.3005... @z=0.6380... @weight=0>
+    #
+    # @return [CyberarmEngine::Vector]
+    def normalized
+      mag = magnitude
+      self / Vector.new(mag, mag, mag)
+    end
+
+
+    # returns a direction {Vector}
+    #
+    # z is pitch
+    #
+    # y is yaw
+    #
+    # x is roll
+    # @return [CyberarmEngine::Vector]
+    def direction
+      _x = -Math.sin(@y.degrees_to_radians) * Math.cos(@z.degrees_to_radians)
+      _y = Math.sin(@z.degrees_to_radians)
+      _z = Math.cos(@y.degrees_to_radians) * Math.cos(@z.degrees_to_radians)
+
+      Vector.new(_x, _y, _z)
+    end
+
+    # returns an inverse {Vector}
+    # @return [CyberarmEngine::Vector]
+    def inverse
+      Vector.new(1.0 / @x, 1.0 / @y, 1.0 / @z)
+    end
+
+    # Adds up values of {x}, {y}, and {z}
+    # @return [Integer|Float]
+    def sum
+      @x + @y + @z
+    end
+
+    ##
+    # Linear interpolation: smoothly transition between two {Vector}
+    #
+    #   CyberarmEngine::Vector.new(100, 100, 100).lerp( CyberarmEngine::Vector.new(0, 0, 0), 0.75 )
+    #   # => <CyberarmEngine::Vector:0x0001 @x=75.0, @y=75.0, @z=75.0, @weight=0>
+    #
+    # @param other [CyberarmEngine::Vector | Integer | Float] value to subtract from
+    # @param factor [Float] how complete transition to _other_ is, in range [0.0..1.0]
+    # @return [CyberarmEngine::Vector]
+    def lerp(other, factor)
+      (self - other) * factor.clamp(0.0, 1.0)
+    end
+
+    # 2D distance using X and Y
+    # @return [Float]
+    def distance(other)
+      Math.sqrt((@x-other.x)**2 + (@y-other.y)**2)
+    end
+
+    # 2D distance using X and Z
+    # @return [Float]
+    def gl_distance2d(other)
+      Math.sqrt((@x-other.x)**2 + (@z-other.z)**2)
+    end
+
+    # 3D distance using X, Y, and Z
+    # @return [Float]
+    def distance3d(other)
+      Math.sqrt((@x-other.x)**2 + (@y-other.y)**2 + (@z-other.z)**2)
+    end
+
+    # Converts {Vector} to Array
+    # @return [Array]
+    def to_a
+      [@x, @y, @z, @weight]
+    end
+
+    # Converts {Vector} to String
+    # @return [String]
+    def to_s
+      "X: #{@x}, Y: #{@y}, Z: #{@z}, Weight: #{@weight}"
+    end
+
+    # Converts {Vector} to Hash
+    # @return [Hash]
+    def to_h
+      {x: @x, y: @y, z: @z, weight: @weight}
+    end
+  end
 end