References

summary
public	F router(): * Create an routers that switch to correct react component for different endpoints

actions

summary
public	F login(user: obj): object Sends a signal to the reducer to login with the given user
public	F logout(): object Sends a signal to the reducer to logout the current user
public	F refreshToken(token: object): object Sends a signal to the reducer to refresh the token
public	F asyncCollection(collectionID: string, uid: ): Fetch the specific collection specify by user
public	F asyncCollections(uid: ): Fetch the list of the user collection asynchronously Use when user login or added a new collection
public	F async createCollection(name: string, uid: *): boolean Creates a new collection
public	F deleteCollection(collectionID: string, name: string, uid: ): Sends a signal to the reducer to delete the specific collection of user
public	F syncCollection(payload: object): object Sends a signal to the reducer to load the retrieved collection
public	F syncCollections(payload: object): object Sends a signal to the reducer to sync the user collections
public	F fetchCourse(courseId: string): * Fetch specific course
public	F fetchCourses(): * Fetch all the courses available
public	F fetchLesson(json: ): Fetch the lesson that is supplied by the parameter.
public	F loadCourse(course: *): object Sends signal to the reducer to load the course retrieved
public	F loadLesson(lesson: object): * Sends signal to the reducer to load a new lesson supplied by parameter
public	F nextLesson(currentIndex: number, next: object): * Increment the lesson index and load the next lesson.
public	F previousLesson(currentIndex: number, prev: object): * Decrement the lesson index and load the previous lesson.
public	F setCurrentIndex(newIndex: number): object Sends signal to the reducer to update the current index of the Course
public	F syncCourses(payload: ): Sends a signal to the reducer to synchronize the courses
public	F fetchScene(id: string, uid: ): This does an async fetch to backend to grab the scene, then dispatches the necessary functions to update the state.
public	F recover(): * Sends a signal to the reducer to 'rewind' until last stable render
public	F refresh(text: string, uid: ): Sends a signal to the reducer to refresh with the given text
public	F render(text: string, uid: ): Sends a signal to the reducer to render the scene
public	F updateSavedText(savedText: ): Sends a signal to the reducer to update the savedText when user try to save or open scene/course
public	F asyncExampleProj(): * Fetch a eample scenes from the backend
public	F asyncUserProj(uid: ): Retrieved the list of user scenes
public	F deleteProj(uid: , id: string, name: string): Delete the specify user project
public	F async save(uid: , scene: , img: , sceneID: ): * Saves a scene to MongoDB
public	F syncExampleProj(payload: ): Sends signal to the reducer to sync the example project
public	F syncUserProj(payload: ): Sends signal to the reducer to sync the user project
public	F fetchReferenceExample(funcName: string): * Fetch specific example scene from backend.
public	F loadReferenceExample(refEx: object): * Sends a signal to the reducer to load the retrieved scene
public	F addCollectionID(payload: string): object Sends a signal to the reducer to add the scene to the collection
public	F changeCamMode(config: *): object Sends a signal to the reducer to change the mode of the camera
public	F changeFloorColor(color: string): object Sends a signal to the reducer to change the sky color
public	F changePerspective(): object Sends a signal to the reducer to change the perspective
public	F changeSettings(payload: *): object Sends a signal to the reducer to change the settings
public	F changeSkyColor(color: string): object Sends a signal to the reducer to change the sky color
public	F changeView(): object Sends a signal to the reducer to toggle to be view only(hide the editor) or not
public	F loadScene(data: string): * This function load data of scene to the redux store
public	F loadSettings(payload: *): object Sends a signal to the reducer to load the settings sends by the
public	F nameScene(name: string): * This function registers the scene's name with Redux
public	F removeCollectionID(payload: string): object Sends a signal to the reducer to add the scene to the collection
public	F resetFloorColor(): object Sends a signal to the reducer to reset the floor color
public	F resetSettings(): object Sends a signal to the reducer to reset the settings to default
public	F resetSkyColor(): object Sends a signal to the reducer to reset the sky color
public	F setCamera(x: number, y: number, z: number): object Sends a signal to the reducer to change the position of the camera
public	F setDesc(payload: string): object Sends a signal to the reducer to cahnge the description of the scene
public	F setNameDesc(payload: *): object Sends a signal to the reducer to change both name and description
public	F toggleCastShadow(): object Sends a signal to the reducer to toggle for light to cast shadow
public	F toggleCoordSky(): object Sends a signal to the reducer to toggle the coordinate floor
public	F toggleCursor(): object Sends a signal to the reducer to toggle for cursor to display cusor on screen
public	F toggleDefaultLight(): object Sends a signal to the reducer to toggle the default light
public	F toggleFloor(): object Sends a signal to the reducer to toggle the floor
public	F toggleLightIndicator(): object Sends a signal to the reducer to toggle for light to show light indicator
public	F updateMoveSpeed(speed: number): {"type": , "speed": } Sends a signal to the reducer to change the speed of movement
public	F asyncUserSettings(id: ):
public	F syncUserSettings(settings: ): {"type": , "settings": *}
public	F updateFontSize(fontSize: ): {"type": , "fontSize": *}
public	F updateUserSettings(id: , settings: ): *
public	V collectRef: string

components/collection

summary
public	C SelectProject React component for selecting list of projects from collection
public	V Collection: *

components/courses

summary
public	C Lesson React component for navigating the course lessons and displaying lesson name and description
public	V CourseSelect: *

components/editor

summary
public	C Editor Editor is a React Component that create the Ace Editor in the DOM.
public	C FontSize
public	C KeyboardShortcut React components create the button with KeyboardShortcut window
public	V customCompleter: {"getCompletions": *} Creates customCompleter for all MYR references and keywords for JS, color code, and assets

components/layouts

summary
public	F AssetReference(param0: object): HTMLElement Create a layout for model reference page.
public	F Collection(param0: object): HTMLElement Create a layout for collection page.
public	F Reference(param0: object): HTMLElement Create a layout for reference page.

components/reference

summary
public	C AssetReference
public	C ModelReference
public	C ReferenceExampleBox Reference Example Box is react component for displaying information about API in reference example scene
public	C Reference Reference is a react component that creates drawer contains references
public	C ReferencePage ReferencePage extends Reference class and overrides the render function to create as single page
public	C TextureReference

components/structural

summary
public	C Footer React component class for the footer includes link to about page, privacy policy, TOS, etc.
public	C View The View component return the aframe representation of the scene.
public	C WelcomeScene Welcome Scene component returns static aframe scene to embed in welcome screen
public	F m(model: ):
public	F t(tex: ):
public	V WelcomeScreen: *

components/structural/header

summary
public	C Header React component class for the header
public	C MyrTour MyrTour components shows the guide of MYR
public	C Sidebar The side bar provides a drawer with options to make changes to the scene.
public	V ProjectView: *

constants

summary
public	V ADD_COLLECTION: string
public	V CHANGE_CAM_MODE: string
public	V CHANGE_FLOOR_COLOR: string
public	V CHANGE_PERSPECTIVE: string
public	V CHANGE_SETTINGS: string
public	V CHANGE_SKY_COLOR: string
public	V CHANGE_VIEW: string
public	V DELETE_COLLECTION: string
public	V DELETE_PROJ: string
public	V EDITOR_CHANGE: string
public	V EDITOR_RECOVER: string
public	V EDITOR_REFRESH: string
public	V EDITOR_RENDER: string
public	V EDITOR_UPDATE_SAVEDTEXT: string
public	V LOAD_COURSE: string
public	V LOAD_LESSON: string
public	V LOAD_REF_EX: string
public	V LOAD_SCENE: string
public	V LOAD_SETTINGS: string
public	V LOGIN: string
public	V LOGOUT: string
public	V NAME_SCENE: string
public	V NEW_SCENE: string
public	V REFRESH_TOKEN: string
public	V REMOVE_COLLECTION: string
public	V RESET_FLOOR_COLOR: string
public	V RESET_SETTINGS: string
public	V RESET_SKY_COLOR: string
public	V SAVE_START: string
public	V SET_CAMERA: string
public	V SET_DESC: string
public	V SET_INDEX: string
public	V SET_NAME_DESC: string
public	V SYNC_COLLECTION: string
public	V SYNC_COLLECTIONS: string
public	V SYNC_COURSES: string
public	V SYNC_EXAMP_PROJ: string
public	V SYNC_USER_PROJ: string
public	V SYNC_USER_SETTINGS: string
public	V TOGGLE_CAST_SHADOW: string
public	V TOGGLE_COORD_SKY: string
public	V TOGGLE_CURSOR: string
public	V TOGGLE_DEFAULT_LIGHT: string
public	V TOGGLE_FLOOR: string
public	V TOGGLE_LIGHT_INDICATOR: string
public	V UPDATE_FONT_SIZE: string
public	V UPDATE_MOVE_SPEED: string
public	V COLLECTION: string
public	V GUIDED: string
public	V IDE: string
public	V REFERENCE: string
public	V REF_EXAMPLE: string

myr

summary
public	C Group Class representing a Group in MYR
public	C Myr
public	F arrayText(text: ): Return a react elements contain a cue-card for Array data type
public	F boolText(text: ): Return a react elements contain a cue-card for Boolean data type
public	F dataText(text: ): Return a react elements contain a cue-card for dynamic data type
public	F numberText(text: ): Return a react elements contain a cue-card for Number data type
public	F r(ref: ):
public	F stringText(text: ): Return a react elements contain a cue-card for String data type
public	V model: undefined[] List of model reference
public	V texture: undefined[] List of texture reference
public	V TourSteps: undefined[] Selector: Where to position the tour card.

reducers

summary
public	F classes(state: , action: ): * Collection Reducer
public	F course(state: , action: ): * Course Reducer
public	F editor(state: , action: ): * Editor Reducer
public	F project(state: , action: ): * Project Reducers
public	F referenceExample(state: , action: ): * Reference Example reducer
public	F scene(state: , action: ): * Scene Reducers
public	F user(state: , action: ): * User Reducers
public	V store: *
public	V DEF_SETTINGS: {"skyColor": string, "floorColor": string, "camConfig": , "showCoordHelper": boolean, "showFloor": boolean, "showCursor": boolean, "cameraPosition": string, "viewOnly": , "defaultLight": boolean, "castShadow": , "lightIndicator": , "moveSpeed": number, "collectionID": *}

utils

summary
public	F browserType(): string

Directories