Project

Project

Methods

_removeFromCloud() → {Project}

Creates a copy of this project and all data stored within. The copy is not automatically stored anywhere.

Returns:
Type
Project

(async) _saveScreenshot() → {Object}

Fetch data for this project. Needed to access data, custom data and freeze frames.

Returns:

The project data.

Type
Object

(async) addFreezeFrame() → {Project}

Take a freeze frame and save it to the list of freeze frames. The augmented reality camera needs to be active.

Returns:
Type
Project

(async) downloadFreezeFrames(onProgress) → {Array.<FreezeFrame>}

Download all freeze frames necessary for this project.

Parameters:
Name Type Description
onProgress function

Callback function for download progress between 0 and 100.

Returns:

The freeze frame list.

Type
Array.<FreezeFrame>

(async) loadFreezeFrame(freezeFrame)

Loads a specific freeze frame from this project.

Parameters:
Name Type Description
freezeFrame FreezeFrame

loadState(flags) → {Promise}

Loads the scene state from the project

Parameters:
Name Type Description
flags object
Returns:

resolved when done.

Type
Promise

(async) removeFromCloud() → {Promise}

Removes project from cloud storage

Returns:

resolved when done.

Type
Promise

removeLocally() → {Promise}

Removes project from local permanent storage

Returns:

resolved when done.

Type
Promise

(async) saveScreenshot() → {String}

Sets the screenshot for this project.

Returns:

The screenshot url.

Type
String

saveState(url)

Saves the scene state into the project

Parameters:
Name Type Description
url string

screenshot URL

setFlags(flags)

Sets storage flags

Parameters:
Name Type Description
flags object

storeLocally() → {Promise}

Stores project to local permanent storage

Returns:

resolved when done.

Type
Promise

storeToCloud() → {Promise}

Stores project to cloud storage

Returns:

resolved when done.

Type
Promise