Class RecordedUserPreferences
Extends
UserPreferences.
Defined in: UserPreferences.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
RecordedUserPreferences(configuration)
User's preferences, synchronized with a backend.
|
- Fields borrowed from class UserPreferences:
- furnitureCatalog, newWallPattern, patternsCatalog, texturesCatalog, unit, wallPattern
| Method Attributes | Method Name and Description |
|---|---|
|
readFurnitureCatalogFromResource(furnitureCatalogUrls, furnitureResourcesUrlBase)
Returns the furniture catalog contained from the given resources.
|
|
|
readModifiableTexture(properties, index)
Returns the modifiable texture read from
properties at the given index. |
|
|
readModifiableTextureCategory(properties, index)
Returns the category of a texture at the given
index
read from properties. |
|
|
readTexturesCatalogFromResource(texturesCatalogUrls, texturesResourcesUrlBase)
Returns the textures catalog contained from the the given resources.
|
|
|
write()
Writes user preferences to properties, and sends to the
writePreferencesUrl (if
given at the creation) a JSON content describing preferences. |
- Methods borrowed from class UserPreferences:
- addPropertyChangeListener, getDefaultFontName, getDefaultSupportedLanguages, getFurnitureModelIconSize, getLanguage, getLengthUnit, getLocalizedString, getLocalizedStringKeys, getNewFloorThickness, getNewRoomFloorColor, getNewWallBaseboardHeight, getNewWallBaseboardThickness, getNewWallHeight, getNewWallPattern, getNewWallThickness, getPatternsCatalog, getResourceBundles, getSupportedLanguages, isAerialViewCenteredOnSelectionEnabled, isEditingIn3DViewEnabled, isFurnitureViewedFromTop, isGridVisible, isMagnetismEnabled, isNavigationPanelVisible, isObserverCameraSelectedAtChange, isRoomFloorColoredOrTextured, removePropertyChangeListener, setAerialViewCenteredOnSelectionEnabled, setCheckUpdatesEnabled, setDefaultFontName, setEditingIn3DViewEnabled, setFloorColoredOrTextured, setFurnitureModelIconSize, setFurnitureViewedFromTop, setGridVisible, setLanguage, setMagnetismEnabled, setNavigationPanelVisible, setNewFloorThickness, setNewRoomFloorColor, setNewWallBaseboardHeight, setNewWallBaseboardThickness, setNewWallHeight, setNewWallPattern, setNewWallThickness, setObserverCameraSelectedAtChange, setSupportedLanguages, setUnit
Class Detail
RecordedUserPreferences(configuration)
User's preferences, synchronized with a backend.
Author: Louis Grignon, Emmanuel Puybaret.
Author: Louis Grignon, Emmanuel Puybaret.
- Parameters:
- {{furnitureCatalogURLs: string[]|furnitureResourcesURLBase: string|texturesCatalogURLs: string[]|texturesResourcesURLBase: string|writePreferencesURL: string|readPreferencesURL: string|writeResourceURL: string|readResourceURL: string|writePreferencesResourceURL: string|readPreferencesResourceURL: string|defaultUserLanguage: string|writingObserver: {writeStarted: Function|writeSucceeded: Function|writeFailed: Function|connectionFound: Function|connectionLost: Function} }} configuration Optional
- preferences configuration. If configuration.writePreferencesResourceURL / configuration.readPreferencesResourceURL is missing, configuration.writeResourceURL / configuration.readResourceURL will be used.
Method Detail
readFurnitureCatalogFromResource(furnitureCatalogUrls, furnitureResourcesUrlBase)
Returns the furniture catalog contained from the given resources.
- Parameters:
- {Array} furnitureCatalogUrls
- {String} furnitureResourcesUrlBase
readModifiableTexture(properties, index)
Returns the modifiable texture read from
properties at the given index.
- Parameters:
- {string|string} properties
- {number} index
- the index of the read texture
- Returns:
- the read texture or
nullif the texture at the given index doesn't exist.
readModifiableTextureCategory(properties, index)
Returns the category of a texture at the given
index
read from properties.
- Parameters:
- {string|string} properties
- {number} index
- the index of the read texture
readTexturesCatalogFromResource(texturesCatalogUrls, texturesResourcesUrlBase)
Returns the textures catalog contained from the the given resources.
- Parameters:
- {Array} texturesCatalogUrls
- {String} texturesResourcesUrlBase
write()
Writes user preferences to properties, and sends to the
writePreferencesUrl (if
given at the creation) a JSON content describing preferences.
