https://github.com/shanebdavis/gui_geometry

2D geometry Ruby Gem designe for use in graphical user interfaces
https://github.com/shanebdavis/gui_geometry

Last synced: about 1 month ago
JSON representation

2D geometry Ruby Gem designe for use in graphical user interfaces

• Host: GitHub
• URL: https://github.com/shanebdavis/gui_geometry
• Owner: shanebdavis
• License: mit
• Created: 2013-01-23T19:40:05.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-10-26T01:04:37.000Z (over 5 years ago)
• Last Synced: 2024-12-08T23:16:56.866Z (about 2 months ago)
• Language: Ruby
• Size: 158 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# GuiGeo

There are a few good geometry gems already available for Ruby (ruby-geometry and geometry), but I need one which is focused on the needs of creating 2D graphical user interfaces.

## Installation

Add this line to your application's Gemfile:

    gem 'gui_geometry'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install gui_geometry

## Usage

Points are represented by X and Y coordinates:

Rectangles consist of two point objects. One specifies the location of the rectangle - it's top-left corner. The other specifies its size in terms of width then height.

``` ruby

require "gui_geometry"

include GuiGeo

# create point x == y == 0

point

# => point(0,0)

# create a point x=3, y=4

my_point = point(3,4)

# => point(3,4)

[my_point.x, my_point.y]

# => [3, 4]

# create a rectangle - x, y, w, h form

rect(4,5,100,80)

# => rect(4,5,100,80)

# create rectangle - location, size form

my_rect = rect point(4,5), point(100,80)

# => rect(4,5,100,80)

# create rectangle - size form (location defaults to 0,0

rect point(30,50)

# => rect(0,0,30,50)

# get loc and size:

[my_rect.loc, my_rect.size]

# => [point(4,5), point(100,80)]

# get x, y, width and height

[my_rect.x, my_rect.y, my_rect.w, my_rect.h]

# => [4, 5, 100, 80]

# get the 4 corners:

[my_rect.tl, my_rect.tr, my_rect.bl, my_rect.br]

# => [point(4,5), point(104,5), point(4,85), point(104,85)]

```

To get access to min, max, bound, and minmax:

```

include GuiGeo::Tools

min(4,5)

# => 4

max(4,5)

# => 5

minmax(4,5)

# => [4,5]

bound(5,4,10)

# => 5

```

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request