getPolyhedron: Get polyhedron

View source: R/public-lib.R

getPolyhedronR Documentation

Get polyhedron

Description

Gets a polyhedron from the database. It returns an R6 Class with all its characteristics and functions. The object returned, of type Polyhedron, allows to the user to get access to all the functionality provided.

Usage

getPolyhedron(source = "netlib", polyhedron.name)

Arguments

source

string vector, which can be obtained from getAvailableSources()

polyhedron.name

a valid name of a polyhedron in the database. Current names can be found with getAvailablePolyhedra()

Value

polyhedron R6 object

See Also

getAvailablePolyhedra, getAvailableSources

Examples

tetrahedron <- getPolyhedron(
  source = "netlib",
  polyhedron.name = "tetrahedron"
)

# returns name of polyhedra
tetrahedron$getName()

# polyhedron state
tetrahedron.state <- tetrahedron$getState()

# Johnson symbol and Schlafli symbol
tetrahedron.state$getSymbol()

# vertex data.frame
tetrahedron.state$getVertices()

# List of faces of solid representation (3D)
tetrahedron.state$getSolid()

# List of faces of net representation (2D)
tetrahedron.state$getNet()


ropensci/Rpolyhedra documentation built on Oct. 7, 2022, 6:56 p.m.