Class Index | File Index

Classes


Class IncrementalHomeRecorder


Defined in: SweetHome3DJSApplication.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IncrementalHomeRecorder(application, configuration)
A home recorder that is able to save the application homes incrementally by sending undoable edits to the SH3D server.
Field Summary
Field Attributes Field Name and Description
<static>  
IncrementalHomeRecorder.DEFAULT_TRACKED_HOME_PROPERTIES
The home properties that are tracked by default by incremental recorders.
Method Summary
Method Attributes Method Name and Description
 
addHome(home)
Adds a home to be incrementally saved by this recorder.
 
configure(configuration)
Configures this incremental recorder's behavior.
 
Gets the home properties that are tracked and potentially written by this recorder.
 
readHome(homeName, observer)
Reads a home with this recorder.
 
removeHome(home)
Removes a home previously added with addHome.
 
Sends to the server all the currently waiting edits for the given home.
Class Detail
IncrementalHomeRecorder(application, configuration)
A home recorder that is able to save the application homes incrementally by sending undoable edits to the SH3D server.
Author: Renaud Pawlak, Emmanuel Puybaret.
Parameters:
{SweetHome3DJSApplication} application
{{readHomeURL: string|writeHomeEditsURL: string|closeHomeURL: string|pingURL: string|autoWriteDelay: number|trackedHomeProperties: string[]|autoWriteTrackedStateChange: boolean|writingObserver: {writeStarted: Function|writeSucceeded: Function|writeFailed: Function|connectionFound: Function|connectionLost: Function} }} configuration Optional
the recorder configuration
Field Detail
<static> IncrementalHomeRecorder.DEFAULT_TRACKED_HOME_PROPERTIES
The home properties that are tracked by default by incremental recorders.
Method Detail
addHome(home)
Adds a home to be incrementally saved by this recorder.
Parameters:
{Home} home

configure(configuration)
Configures this incremental recorder's behavior.
Parameters:
{Object} configuration
an object containing configuration fields

getTrackedHomeProperties()
Gets the home properties that are tracked and potentially written by this recorder.

readHome(homeName, observer)
Reads a home with this recorder.
Parameters:
{string} homeName
the home name on the server or the URL of the home if readHomeURL service is missing
{homeLoaded|homeError|progression} observer
callbacks used to follow the reading of the home

removeHome(home)
Removes a home previously added with addHome.
Parameters:
{Home} home

sendUndoableEdits(home)
Sends to the server all the currently waiting edits for the given home.
Parameters:
{Home} home

© Copyright 2021 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Mar 02 2021 19:55:52 GMT+0100 (CET)