Class UserPreferencesController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	UserPreferencesController(preferences, viewFactory, contentManager, homeController) Creates the controller of user preferences view.

Method Summary
Method Attributes	Method Name and Description
	addPropertyChangeListener(property, listener) Adds the property change `listener` in parameter to this controller.
	displayView(parentView) Displays the view controlled by this controller.
	getAutoSaveDelayForRecovery() Returns the edited auto recovery save delay.
	getCurrency() Returns the edited currency.
	getDefaultFontName() Returns the name of the font that should be used by default or `null` if the default font should be the default one in the application.
	getFurnitureModelIconSize() Returns the size used to generate icons of furniture viewed from top.
	getLanguage() Returns the edited language.
	getNewFloorThickness() Returns the edited new floor thickness.
	getNewWallHeight() Returns the edited new wall height.
	getNewWallPattern() Returns the edited new wall top pattern in plan.
	getNewWallThickness() Returns the edited new wall thickness.
	getUnit() Returns the edited unit.
	getView() Returns the view associated with this controller.
	getWallPattern() Returns the default walls top pattern in plan.
	isAerialViewCenteredOnSelectionEnabled() Returns whether aerial view should be centered on selection or not.
	isAutoSaveForRecoveryEnabled() Returns `true` if auto recovery save is enabled.
	isCheckUpdatesEnabled() Returns `true` if updates should be checked.
	isEditingIn3DViewEnabled() Returns whether interactive editing in 3D view is enabled or not.
	isFurnitureCatalogViewedInTree() Returns `true` if furniture catalog should be viewed in a tree.
	isFurnitureViewedFromTop() Returns how furniture should be displayed in plan.
	isGridVisible() Returns whether grid is visible or not.
	isMagnetismEnabled() Returns whether magnetism is enabled or not.
	isNavigationPanelVisible() Returns `true` if the navigation panel should be displayed.
	isObserverCameraSelectedAtChange() Returns whether the observer camera should be selected at each change.
	isPropertyEditable(property) Returns `true` if the given `property` is editable.
	isRoomFloorColoredOrTextured() Returns `true` if floor texture is visible in plan.
	isRulersVisible() Returns whether rulers are visible or not.
	isValueAddedTaxEnabled() Returns `true` if Value Added Tax should be taken in account in prices.
	modifyUserPreferences() Controls the modification of user preferences.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	resetDisplayedActionTips() Resets the displayed flags of action tips.
	setAerialViewCenteredOnSelectionEnabled(aerialViewCenteredOnSelectionEnabled) Sets whether aerial view should be centered on selection or not.
	setAutoSaveDelayForRecovery(autoSaveDelayForRecovery) Sets the edited auto recovery save delay.
	setAutoSaveForRecoveryEnabled(autoSaveForRecoveryEnabled) Sets whether auto recovery save is enabled or not.
	setCheckUpdatesEnabled(updatesChecked) Sets whether updates should be checked or not.
	setCurrency(currency) Sets the edited currency.
	setDefaultFontName(defaultFontName) Sets the name of the font that should be used by default.
	setEditingIn3DViewEnabled(editingIn3DViewEnabled) Sets whether interactive editing in 3D view is enabled or not.
	setFurnitureCatalogViewedInTree(furnitureCatalogViewedInTree) Sets whether the furniture catalog should be viewed in a tree or a different way.
	setFurnitureModelIconSize(furnitureModelIconSize) Sets the size used to generate icons of furniture viewed from top.
	setFurnitureViewedFromTop(furnitureViewedFromTop) Sets how furniture should be displayed in plan.
	setGridVisible(gridVisible) Sets whether grid is visible or not.
	setLanguage(language) Sets the edited language.
	setMagnetismEnabled(magnetismEnabled) Sets whether magnetism is enabled or not.
	setNavigationPanelVisible(navigationPanelVisible) Sets whether the navigation panel should be displayed or not.
	setNewFloorThickness(newFloorThickness) Sets the edited new floor thickness.
	setNewWallHeight(newWallHeight) Sets the edited new wall height.
	setNewWallPattern(newWallPattern) Sets the edited new wall top pattern in plan, and notifies listeners of this change.
	setNewWallThickness(newWallThickness) Sets the edited new wall thickness.
	setObserverCameraSelectedAtChange(observerCameraSelectedAtChange) Sets whether the observer camera should be selected at each change.
	setRoomFloorColoredOrTextured(floorTextureVisible) Sets whether floor texture is visible in plan or not.
	setRulersVisible(rulersVisible) Sets whether rulers are visible or not.
	setUnit(unit) Sets the edited unit.
	setValueAddedTaxEnabled(valueAddedTaxEnabled) Sets whether Value Added Tax should be taken in account in prices.
	setWallPattern(wallPattern) Sets default walls top pattern in plan, and notifies listeners of this change.
	updateProperties() Updates preferences properties edited by this controller.

Class Detail

UserPreferencesController(preferences, viewFactory, contentManager, homeController)

Creates the controller of user preferences view.
Author: Emmanuel Puybaret.

Parameters:
{UserPreferences} preferences
{Object} viewFactory
{Object} contentManager
{HomeController} homeController

Method Detail

addPropertyChangeListener(property, listener)

Adds the property change listener in parameter to this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

displayView(parentView)

Displays the view controlled by this controller.

Parameters:
{Object} parentView

{number} getAutoSaveDelayForRecovery()

Returns the edited auto recovery save delay.

Returns:: {number}

{string} getCurrency()

Returns the edited currency.

Returns:: {string}

{string} getDefaultFontName()

Returns the name of the font that should be used by default or null if the default font should be the default one in the application.

Returns:: {string}

{number} getFurnitureModelIconSize()

Returns the size used to generate icons of furniture viewed from top.

Returns:: {number}

{string} getLanguage()

Returns the edited language.

Returns:: {string}

{number} getNewFloorThickness()

Returns the edited new floor thickness.

Returns:: {number}

{number} getNewWallHeight()

Returns the edited new wall height.

Returns:: {number}

{Object} getNewWallPattern()

Returns the edited new wall top pattern in plan.

Returns:: {Object}

{number} getNewWallThickness()

Returns the edited new wall thickness.

Returns:: {number}

{LengthUnit} getUnit()

Returns the edited unit.

Returns:: {LengthUnit}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{Object} getWallPattern()

Returns the default walls top pattern in plan.

Returns:: {Object}

{boolean} isAerialViewCenteredOnSelectionEnabled()

Returns whether aerial view should be centered on selection or not.

Returns:: {boolean}

{boolean} isAutoSaveForRecoveryEnabled()

Returns true if auto recovery save is enabled.

Returns:: {boolean}

{boolean} isCheckUpdatesEnabled()

Returns true if updates should be checked.

Returns:: {boolean}

{boolean} isEditingIn3DViewEnabled()

Returns whether interactive editing in 3D view is enabled or not.

Returns:: {boolean}

{boolean} isFurnitureCatalogViewedInTree()

Returns true if furniture catalog should be viewed in a tree.

Returns:: {boolean}

{boolean} isFurnitureViewedFromTop()

Returns how furniture should be displayed in plan.

Returns:: {boolean}

{boolean} isGridVisible()

Returns whether grid is visible or not.

Returns:: {boolean}

{boolean} isMagnetismEnabled()

Returns whether magnetism is enabled or not.

Returns:: {boolean}

{boolean} isNavigationPanelVisible()

Returns true if the navigation panel should be displayed.

Returns:: {boolean}

{boolean} isObserverCameraSelectedAtChange()

Returns whether the observer camera should be selected at each change.

Returns:: {boolean}

{boolean} isPropertyEditable(property)

Returns true if the given property is editable. Depending on whether a property is editable or not, the view associated to this controller may render it differently. The implementation of this method always returns true except for LANGUAGE if it's not editable.

Parameters:
{string} property

Returns:: {boolean}

{boolean} isRoomFloorColoredOrTextured()

Returns true if floor texture is visible in plan.

Returns:: {boolean}

{boolean} isRulersVisible()

Returns whether rulers are visible or not.

Returns:: {boolean}

{boolean} isValueAddedTaxEnabled()

Returns true if Value Added Tax should be taken in account in prices.

Returns:: {boolean}

modifyUserPreferences()

Controls the modification of user preferences.

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

resetDisplayedActionTips()

Resets the displayed flags of action tips.

setAerialViewCenteredOnSelectionEnabled(aerialViewCenteredOnSelectionEnabled)

Sets whether aerial view should be centered on selection or not.

Parameters:
{boolean} aerialViewCenteredOnSelectionEnabled

setAutoSaveDelayForRecovery(autoSaveDelayForRecovery)

Sets the edited auto recovery save delay.

Parameters:
{number} autoSaveDelayForRecovery

setAutoSaveForRecoveryEnabled(autoSaveForRecoveryEnabled)

Sets whether auto recovery save is enabled or not.

Parameters:
{boolean} autoSaveForRecoveryEnabled

setCheckUpdatesEnabled(updatesChecked)

Sets whether updates should be checked or not.

Parameters:
{boolean} updatesChecked

setCurrency(currency)

Sets the edited currency.

Parameters:
{string} currency

setDefaultFontName(defaultFontName)

Sets the name of the font that should be used by default.

Parameters:
{string} defaultFontName

setEditingIn3DViewEnabled(editingIn3DViewEnabled)

Sets whether interactive editing in 3D view is enabled or not.

Parameters:
{boolean} editingIn3DViewEnabled

setFurnitureCatalogViewedInTree(furnitureCatalogViewedInTree)

Sets whether the furniture catalog should be viewed in a tree or a different way.

Parameters:
{boolean} furnitureCatalogViewedInTree

setFurnitureModelIconSize(furnitureModelIconSize)

Sets the size used to generate icons of furniture viewed from top.

Parameters:
{number} furnitureModelIconSize

setFurnitureViewedFromTop(furnitureViewedFromTop)

Sets how furniture should be displayed in plan.

Parameters:
{boolean} furnitureViewedFromTop

setGridVisible(gridVisible)

Sets whether grid is visible or not.

Parameters:
{boolean} gridVisible

setLanguage(language)

Sets the edited language.

Parameters:
{string} language

setMagnetismEnabled(magnetismEnabled)

Sets whether magnetism is enabled or not.

Parameters:
{boolean} magnetismEnabled

setNavigationPanelVisible(navigationPanelVisible)

Sets whether the navigation panel should be displayed or not.

Parameters:
{boolean} navigationPanelVisible

setNewFloorThickness(newFloorThickness)

Sets the edited new floor thickness.

Parameters:
{number} newFloorThickness

setNewWallHeight(newWallHeight)

Sets the edited new wall height.

Parameters:
{number} newWallHeight

setNewWallPattern(newWallPattern)

Sets the edited new wall top pattern in plan, and notifies listeners of this change.

Parameters:
{Object} newWallPattern

setNewWallThickness(newWallThickness)

Sets the edited new wall thickness.

Parameters:
{number} newWallThickness

setObserverCameraSelectedAtChange(observerCameraSelectedAtChange)

Sets whether the observer camera should be selected at each change.

Parameters:
{boolean} observerCameraSelectedAtChange

setRoomFloorColoredOrTextured(floorTextureVisible)

Sets whether floor texture is visible in plan or not.

Parameters:
{boolean} floorTextureVisible

setRulersVisible(rulersVisible)

Sets whether rulers are visible or not.

Parameters:
{boolean} rulersVisible

setUnit(unit)

Sets the edited unit.

Parameters:
{LengthUnit} unit

setValueAddedTaxEnabled(valueAddedTaxEnabled)

Sets whether Value Added Tax should be taken in account in prices.

Parameters:
{boolean} valueAddedTaxEnabled

setWallPattern(wallPattern)

Sets default walls top pattern in plan, and notifies listeners of this change.

Parameters:
{Object} wallPattern

updateProperties()

Updates preferences properties edited by this controller.

	© Copyright 2024 Space Mushrooms Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:25 GMT+0200 (CEST)

Classes

Class UserPreferencesController