Class BaseboardChoiceController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	BaseboardChoiceController(preferences, viewFactory, contentManager) Creates the controller of room view with undo support.

Method Summary
Method Attributes	Method Name and Description
	addPropertyChangeListener(property, listener) Adds the property change `listener` in parameter to this controller.
	getColor() Returns the edited color of the baseboard.
	getHeight() Returns the edited height of the baseboard.
	getMaxHeight() Returns the maximum height allowed for the edited baseboard.
	getPaint() Returns whether the baseboard side is colored, textured or unknown painted.
	getTextureController() Returns the texture controller of the baseboard.
	getThickness() Returns the edited thickness of the baseboard.
	getView() Returns the view associated with this controller.
	getVisible() Returns `true` if the baseboard should be visible.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setBaseboard(baseboard) Set controller properties from the given `baseboard`.
	setColor(baseboardColor) Sets the edited color of the baseboard.
	setHeight(baseboardHeight) Sets the edited height of the baseboard.
	setMaxHeight(maxHeight) Sets the maximum height allowed for the edited baseboard.
	setPaint(baseboardPaint) Sets whether the baseboard is as its wall, colored, textured or unknown painted.
	setThickness(baseboardThickness) Sets the edited thickness of the baseboard.
	setVisible(baseboardVisible) Sets whether the baseboard should be visible.

Class Detail

BaseboardChoiceController(preferences, viewFactory, contentManager)

Creates the controller of room view with undo support.
Author: Emmanuel Puybaret.

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

Method Detail

addPropertyChangeListener(property, listener)

Adds the property change listener in parameter to this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

{number} getColor()

Returns the edited color of the baseboard.

Returns:: {number}

{number} getHeight()

Returns the edited height of the baseboard.

Returns:: {number}

{number} getMaxHeight()

Returns the maximum height allowed for the edited baseboard.

Returns:: {number}

{BaseboardChoiceController.BaseboardPaint} getPaint()

Returns whether the baseboard side is colored, textured or unknown painted.

Returns:: {BaseboardChoiceController.BaseboardPaint} BaseboardPaint#DEFAULT, BaseboardPaint#COLORED, BaseboardPaint#TEXTURED or null

{TextureChoiceController} getTextureController()

Returns the texture controller of the baseboard.

Returns:: {TextureChoiceController}

{number} getThickness()

Returns the edited thickness of the baseboard.

Returns:: {number}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{boolean} getVisible()

Returns true if the baseboard should be visible.

Returns:: {boolean}

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setBaseboard(baseboard)

Set controller properties from the given baseboard.

Parameters:
{Baseboard} baseboard

setColor(baseboardColor)

Sets the edited color of the baseboard.

Parameters:
{number} baseboardColor

setHeight(baseboardHeight)

Sets the edited height of the baseboard.

Parameters:
{number} baseboardHeight

setMaxHeight(maxHeight)

Sets the maximum height allowed for the edited baseboard.

Parameters:
{number} maxHeight

setPaint(baseboardPaint)

Sets whether the baseboard is as its wall, colored, textured or unknown painted.

Parameters:
{BaseboardChoiceController.BaseboardPaint} baseboardPaint

setThickness(baseboardThickness)

Sets the edited thickness of the baseboard.

Parameters:
{number} baseboardThickness

setVisible(baseboardVisible)

Sets whether the baseboard should be visible.

Parameters:
{boolean} baseboardVisible

	© 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:22 GMT+0200 (CEST)

Classes

Class BaseboardChoiceController