Package AutoDeskR. July 10, 2017

Transcription

1 Type Package Title An Interface to the 'AutoDesk' 'API' Platform Package AutoDeskR July 10, 2017 An interface to the 'AutoDesk' 'API' Platform including the Authentication 'API' for obtaining authentication to the 'AutoDesk' Forge Platform, Data Management 'API' for managing data across the platform's cloud services, Design Automation 'API' for performing automated tasks on design files in the cloud, Model Derivative 'API' for translating design files into different formats, sending them to the viewer app, and extracting design data, and Viewer for rendering 2D and 3D models (see < for more information). Version URL BugReports Depends R (>= ) License Apache License file LICENSE LazyData TRUE Imports httr, jsonlite, shiny RoxygenNote Suggests knitr, rmarkdown VignetteBuilder knitr NeedsCompilation no Author Paul Govan [aut, cre] Maintainer Paul Govan <pgovan1@aggienetwork.com> Repository CRAN Date/Publication :04:57 UTC R topics documented: checkbucket checkfile

2 2 checkbucket checkpdf downloadfile getdata getmetadata getobjecttree getoutputurn gettoken makebucket makepdf translateobj translatesvf uploadfile viewer3d viewerui Index 15 checkbucket Check the Status of an App-Managed Bucket. Check the status of a recently created app-managed bucket using the Data Management API. checkbucket( = NULL, bucket = "mybucket") bucket A string. Token generated with gettoken function with bucket:create, bucket:read, and data:write A string. Name of the bucket. Defaults to mybucket. An object containing the bucketkey, bucketowner, and createddate. # Check the status of a bucket with the name "mybucket" resp <- checkbucket( = mytoken, bucket = "mybucket") resp

3 checkfile 3 checkfile Check the Status of a Translated File. Check the status of a recently translated file using the Model Derivative API. checkfile( = NULL, = NULL) # Check the status of the translated "aerial.dwg" svf file resp <- checkfile( = myencodedurn, = mytoken) resp checkpdf Check the status of a PDF. Check the status of a recently created PDF file using the Design Automation API. checkpdf(source = NULL, destination = NULL, = NULL)

4 4 downloadfile source destination A string. Publicly accessible web address of the input dwg file. A string. Publicly accessible web address for the output pdf file. A string. Token generated with gettoken function with code:all scope. mysource <- " mydestination <- " resp <- checkpdf(mysource, mydestination, = mytoken) resp downloadfile Download a file locally. Download a file from the Forge Platform using the Model Derivative API. downloadfile( = NULL, output_ = NULL, = NULL) output_ A string. Output_ retrieved via getoutputurn An object containing the result,, and additional activity information.

5 getdata 5 # Download the "aerial.dwg" png file myencodedoutputurn <- jsonlite::base64_enc(myoutputurn) resp <- downloadfile( <- myencodedurn, output_ <- myencodedoutputurn, = mytoken) getdata Get the Geometry Data for a File. Get the geometry of an uploaded file using the Model Derivative API. getdata(guid = NULL, = NULL, = NULL) guid A string. GUID retrieved via the getmetadata An object containing the geometry data for the selected file. # Get the geometry data for the "aerial.dwg" svf file resp <- getdata(guid <- myguid, <- myencodedurn, = mytoken)

6 6 getobjecttree getmetadata Get the Metadata for a File. Get the metadata of an uploaded file using the Model Derivative API. getmetadata( = NULL, = NULL) An object containing the type, name, and guid of the file. # Get the metadata for the "aerial.dwg" svf file resp <- getmetadata( <- myencodedurn, = mytoken) myguid <- resp$content$data$metadata[[1]]$guid getobjecttree Get the Object Tree of a File. Get the object tree of an uploaded file using the Model Derivative API. getobjecttree(guid = NULL, = NULL, = NULL)

7 getoutputurn 7 guid A string. GUID retrieved via the getmetadata An object containing the object tree for the selected file. the file. # Get the object tree for the "aerial.dwg" svf file resp <- getobjecttree(guid <- myguid, <- myencodedurn, = mytoken) resp getoutputurn Get the Output URN for a File. Get the output of a translated file using the Model Derivative API. getoutputurn(, ) An object containing the result,, and additional activity information.

8 8 gettoken # Get the output for the "aerial.dwg" obj file resp <- getoutputurn( <- myurn, = Sys.getenv("")) resp gettoken Get a 2-Legged Token for Authentication. Get a 2-legged for OAuth-based authentication to the AutoDesk Forge Platform. gettoken(id = NULL, secret = NULL, scope = "data:write data:read") id secret scope A string. Client ID for the app generated from the AutoDesk Dev Portal. A string. Client Secret for the app generated from the AutoDesk Dev Portal. A string. Space-separated list of required May be user-profile:read, data:read, data:write, data:create, data:search, bucket:create, bucket:read, bucket:update, bucket:delete, code:all, account:read, account:write, or a combination of these. An object containing the access_, code_type, and expires_in milliseconds. # Get a 2-legged with the "data:read" and "data:write" scopes resp <- gettoken(id = Sys.getenv("client_id"), secret = Sys.getenv("client_secret"), scope = "data:write data:read") mytoken <- resp$content$access_

9 makebucket 9 makebucket Make a Bucket for an App. Make an app-based bucket for storage of design files using the Data Management API. makebucket( = NULL, bucket = "mybucket", policy = "transient") bucket policy A string. Token generated with gettoken function with bucket:create, bucket:read, and data:write A string. Unique bucket name. Defaults to mybucket. A string. May be transient, temporary, or persistent. An object containing the bucketkey, bucketowner, and createddate. # Make a transient bucket with the name "mybucket" resp <- makebucket( = mytoken, bucket = "mybucket", policy = "transient") makepdf Convert a DWG to a PDF. Convert a publicly accessible DWG file to a publicly accessible PDF using the Design Automation API. makepdf(source = NULL, destination = NULL, = NULL)

10 10 translateobj source destination A string. Publicly accessible web address of the input dwg file. A string. Publicly accessible web address for the output pdf file. A string. Token generated with gettoken function with code:all scope. mysource <- " mydestination <- " resp <- makepdf(mysource, mydestination, = mytoken) translateobj Translate a File into OBJ Format. Translate an uploaded file into OBJ format using the Model Derivative API. translateobj( = NULL, = NULL) An object containing the result,, and additional activity information.

11 translatesvf 11 # Translate the "aerial.dwg" file into a obj file resp <- translateobj( <- myencodedurn, = mytoken) translatesvf Translate a File into SVF Format. Translate an uploaded file into SVF format using the Model Derivative API. translatesvf( = NULL, = NULL) An object containing the result,, and additional activity information. # Translate the "aerial.dwg" file into a svf file myencodedurn <- jsonlite::base64_enc(myurn) resp <- translatesvf( = myencodedurn, = mytoken)

12 12 uploadfile uploadfile Upload a File to an App-Managed Bucket. Upload a design file to an app-managed bucket using the Data Management API. uploadfile(file = NULL, = NULL, bucket = "mybucket") file bucket A string. File path. A string. Token generated with gettoken function with bucket:create, bucket:read, and data:write A string. Unique bucket name. Defaults to mybucket. An object containing the bucketkey, objectid (i.e. ), objectkey (i.e. file name), size, contenttype (i.e. "application/octet-stream"), location. and other content information. # Upload the "aerial.dwg" file to "mybucket" resp <- uploadfile(file = system.file("inst/samples/aerial.dwg", package = "AutoDeskR"), = mytoken, bucket = "mybucket") myurn <- resp$content$objectid

13 viewer3d 13 viewer3d Launch the Viewer. Launch the Viewer. viewer3d( = NULL, = NULL, viewertype = "header") A string. Token generated with gettoken function with data:read scope. viewertype A string. The type of viewer to instantiate. Either "header" for the default viewer, "headless" for a viewer without toolbar or panels, or "vr" to enter WebVR mode on a mobile device. # View the "aerial.dwg" file in the AutoDesk viewer myencodedurn <- jsonlite::base64_enc(myurn) viewer3d( <- myencodedurn, = mytoken) viewerui UI Module Function. UI Module Function. viewerui(id, = NULL, = NULL, viewertype = "header")

14 14 viewerui id viewertype A string. A namespace for the module. A string. Token generated with gettoken function with data:read scope. A string. The type of viewer to instantiate. Either "header" for the default viewer or "headless" for a viewer without toolbar or panels. ui <- function(request) { shiny::fluidpage( viewerui("pg", myencodedurn, mytoken) ) } server <- function(input, output, session) { } shiny::shinyapp(ui, server)

15 Index checkbucket, 2 checkfile, 3 checkpdf, 3 downloadfile, 4 getdata, 5 getmetadata, 5, 6, 7 getobjecttree, 6 getoutputurn, 4, 7 gettoken, 2 7, 8, 9 14 makebucket, 9 makepdf, 9 translateobj, 10 translatesvf, 11 uploadfile, 12 viewer3d, 13 viewerui, 13 15