# Rpolyhedra

#Introduction This package is a curation made based on the poly package found on http://www.netlib.org/polyhedra/ (Original Help message), and the polyhedra database found on http://dmccooey.com/polyhedra, both of which provide polyhedra databases on its own format. As such, Rpolyhedra provides with the following:

1. A module to scrape the polyhedra for the different sources found with features for incremental correction of issues found and to be found in scraping process.
2. A database of the scraped polyhedra.
3. An R6 polyhedron representation with ‘rgl’ package visualizing capabilites.

#Usage

For final users, the package provides a common interface for accesing public polyhedra databases, analize properties, compare and visualize them with RGL.

For advanced users, the package provides a simplified set of R6 objects to scrape and compare polyhedra databases.

##Scrape polyhedra In order to scrape, the following code can be executed to retrieve all polyhedra from the original files produced by the poly command.

    library(rgl)
    library(Rpolyhedra)
    polyhedra <- scrapePolyhedraSources(sources.config = PolyhedronScraperConfigurationNetlib.class$new(), max.quant = 5)

With following code, based on preloaded estimated scraping time, a batch of maximum filenames that could be scraped in 30 seconds will be scraped.

    library(rgl)
    library(Rpolyhedra)
    polyhedra <- scrapePolyhedraSources(sources.config = PolyhedronScraperConfigurationNetlib.class$new(), time2scrape.source = 30)

##Get available polyhedra Once the original files had been processed, a simple call to `getAvailablePolyhedra()` retrieves a list of the available polyhedra with properties and status in the polyhedra database:

    library(rgl)
    library(Rpolyhedra)
    getAvailablePolyhedra()

##Retrieve a polyhedron The access to a particular polyhedron can be done with a call to `getPolyhedron(<<source>>, <<polyhedron.name>>)`, which returns a Polyhedron object. For example, to retrieve a cube from the netlib database, the call would be:

    library(rgl)
    library(Rpolyhedra)
    cube <- getPolyhedron(source = "netlib", polyhedron.name = "cube")

#A demo To try package funcionality, a simple demo can be executed which shows the 5 regular polyhedra.

    library(rgl)
    library(Rpolyhedra)
    polyhedra.2.draw <- getAvailablePolyhedra(source = "netlib")[1:5]
    n <- length(polyhedra.2.draw)
    polyhedron.colors <- rainbow(n)
    polyhedron.scale <- 5

    open3d()
    par3d(FOV = 1)
    rgl.bg( sphere =FALSE, fogtype = "none", color=c("black"))
    rgl.viewpoint(theta = 0,phi=0,zoom=0.8,fov=1)
    i <- 1
    for (polyhedron.name in polyhedra.2.draw) {
      polyhedron <- getPolyhedron(source = "netlib", polyhedron.name)
      current.angle <- i/n * 2 * pi
      shape.rgl <- polyhedron$getRGLModel(1, c(polyhedron.scale * sin(current.angle),
                                               polyhedron.scale * cos(current.angle),
                                               0))
      shade3d(shape.rgl, color = polyhedron.colors[i])
      i <- i + 1
    }