Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.93 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.93 KB
Raw

dinraal

Post-Processing

Dinraal is a library for working with shapes in DragonRuby Game Toolkit. By default, DRGTK does not support rendering or working with any shapes outside of rectangles. Until now, other shapes have been provided by sprites.

Full Documentation can be found at https://dschaedler.github.io/dinraal/

Our killer feature is the triangle method. This returns an array of primitives ready to be drawn.

require 'app/lib/dinraal.rb'

def tick args
    triangle = { x: 100, y: 100, x2: 250, y2: 400, x3: 600, y3: 200 }
    args.outputs.static_primitives << Dinraal.triangle( triangle )
  end
end

The library source file can be found at app/lib/dinraal.rb.

A more detailed sample app is at app/main.rb.

Triangles are defined as a hash of points, with any additional information.

{ x: point1_x, y: point1_y, x2: point2_x, y2: point2_y, x3: point3_x, y3: point3_y, r: red, g: green, b: blue, a: alpha }

TODO

  • Create triangle_intersects_triangle? method
  • Create rectangle_intersects_triangle? method
  • Create triangle_inradius method - Incircle Math Breakdown
  • Create triangle_area method - Heron's Formula
    • Vector based calculations will be faster, but less straightforward to impliment
  • Create triangle_perimiter method

How to contribute

  • Submit a Pull Request with any code improvements
  • Impliment any item from the TODO list.
  • Write a sample app that more clearly shows all methods
  • Write a tutorial
  • Improve Documentation
  • Submit improved calculation methods
    • Vector calculations for area over Heron's Formula

YARD

When documenting with YARD, use the full variable / object type names found here https://rubydoc.info/gems/yard/0.9.26/YARD/CodeObjects#BUILTIN_ALL-constant

About Dinraal

Dinraal is created by Dee Schaedler. Many thanks to the DragonRuby Discord server for inspiration and feedback. https://discord.dragonruby.org

Specific thanks to:

  • kota#6413 - Implimenting real time triangles, implimenting many geometry and vector methods
  • leviondiscord#5978 - Optimization contribution
  • theanxietybuster#8491 - Catching a project-ending typo

Most DragonRuby packages and libraries are named after various dragons. Dinraal is a Japanese Dragon from The Legend of Zelda: Breath of the Wild. Dinraal is the dragon of fire, and the gatekeeper of the Shrine at the Spring of Power.