Codebase list ruby-fxruby / master rdoc-sources / FXVec2f.rb
master

Tree @master (Download .tar.gz)

FXVec2f.rb @masterraw · history · blame

module Fox
  class FXVec2f

    attr_accessor :x
    attr_accessor :y

    #
    # Return an initialized FXVec2f instance.
    #
    def initialize(xx=0.0, yy=0.0); end

    #
    # Returns the element at _index_, where _index_ is 0 or 1.
    # Raises IndexError if _index_ is out of range.
    #
    def [](index); end

    #
    # Set the element at _index_ to _value_ and return _value_.
    # Raises IndexError if _index_ is out of range.
    #
    def []=(index, value); end

    # Returns a new FXVec2f instance which is the negation of this one.
    def -@(); end

    #
    # Returns a new FXVec2f instance obtained by memberwise
    # addition of the _other_ FXVec2f instance with this
    # one.
    #
    def +(other); end

    #
    # Returns a new FXVec2f instance obtained by memberwise
    # subtraction of the _other_ FXVec2f instance from this
    # one.
    #
    def -(other); end

    #
    # Returns a new FXVec2f instance obtained by memberwise
    # multiplication of this vector's elements by the scalar
    # _n_.
    #
    def *(n); end

    #
    # Returns a new FXVec2f instance obtained by memberwise
    # division of this vector's elements by the scalar
    # _n_.
    # Raises ZeroDivisionError if _n_ is identically zero.
    #
    def /(n); end

    #
    # Returns the dot (scalar) product of this vector and _other_.
    #
    def dot(other); end

    # Return +true+ if this vector is equal to _other_.
    def ==(other); end

    #
    # Return the square of the length of this vector.
    #
    def length2; end

    #
    # Return the length (magnitude) of this vector.
    #
    def length; end

    # Clamp the values of this vector between limits _lo_ and _hi_.
    def clamp(lo, hi); end

    #
    # Return a new FXVec2f instance which is a normalized version
    # of this one.
    #
    def normalize; end

    #
    # Return a new FXVec2f instance which is the lesser of this
    # vector and _other_.
    #
    def lo(other); end

    #
    # Return a new FXVec2f instance which is the greater of this
    # vector and _other_.
    #
    def hi(other); end
  end
end