Class RoomController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	RoomController(home, preferences, viewFactory, contentManager, undoSupport) 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.
	displayView(parentView) Displays the view controlled by this controller.
	getAreaVisible() Returns whether room area is visible or not.
	getCeilingColor() Returns the edited color of the ceiling.
	getCeilingFlat() Returns whether room ceiling should remain flat whatever its environment or not.
	getCeilingPaint() Returns whether the ceiling is colored, textured or unknown painted.
	getCeilingShininess() Returns the edited shininess of the ceiling.
	getCeilingTextureController() Returns the texture controller of the room ceiling.
	getCeilingVisible() Returns whether room ceiling is visible or not.
	getFloorColor() Returns the edited color of the floor.
	getFloorPaint() Returns whether the floor is colored, textured or unknown painted.
	getFloorShininess() Returns the edited shininess of the floor.
	getFloorTextureController() Returns the texture controller of the room floor.
	getFloorVisible() Returns whether room floor is visible or not.
	getName() Returns the edited name.
	getView() Returns the view associated with this controller.
	getWallSidesBaseboardController() Returns the controller of the wall sides baseboard.
	getWallSidesColor() Returns the edited color of the wall sides.
	getWallSidesPaint() Returns whether the wall sides are colored, textured or unknown painted.
	getWallSidesShininess() Returns the edited shininess of the wall sides.
	getWallSidesTextureController() Returns the texture controller of the room wall sides.
	isPropertyEditable(property) Returns `true` if the given `property` is editable.
	isSplitSurroundingWalls() Returns `true` if walls around the edited rooms should be split.
	isSplitSurroundingWallsNeeded() Returns `true` if walls around the edited rooms need to be split to avoid changing the color of wall sides that belong to neighborhood rooms.
	modifyRooms() Controls the modification of selected rooms in edited home.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setAreaVisible(areaVisible) Sets whether room area is visible or not.
	setCeilingColor(ceilingColor) Sets the edited color of the ceiling.
	setCeilingFlat(ceilingCeilingFlat) Sets whether room ceiling should remain flat whatever its environment or not.
	setCeilingPaint(ceilingPaint) Sets whether the ceiling is colored, textured or unknown painted.
	setCeilingShininess(ceilingShininess) Sets the edited shininess of the ceiling.
	setCeilingVisible(ceilingCeilingVisible) Sets whether room ceiling is visible or not.
	setFloorColor(floorColor) Sets the edited color of the floor.
	setFloorPaint(floorPaint) Sets whether the floor is colored, textured or unknown painted.
	setFloorShininess(floorShininess) Sets the edited shininess of the floor.
	setFloorVisible(floorVisible) Sets whether room floor is visible or not.
	setName(name) Sets the edited name.
	setSplitSurroundingWalls(splitSurroundingWalls) Sets whether walls around the edited rooms should be split or not.
	setWallSidesColor(wallSidesColor) Sets the edited color of the wall sides.
	setWallSidesPaint(wallSidesPaint) Sets whether the wall sides are colored, textured or unknown painted.
	setWallSidesShininess(wallSidesShininess) Sets the edited shininess of the wall sides.
	updateProperties() Updates edited properties from selected rooms in the home edited by this controller.

Class Detail

RoomController(home, preferences, viewFactory, contentManager, undoSupport)

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

Parameters:
{Home} home
{UserPreferences} preferences
{Object} viewFactory
{Object} contentManager
{javax.swing.undo.UndoableEditSupport} undoSupport

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

{boolean} getAreaVisible()

Returns whether room area is visible or not.

Returns:: {boolean}

{number} getCeilingColor()

Returns the edited color of the ceiling.

Returns:: {number}

{boolean} getCeilingFlat()

Returns whether room ceiling should remain flat whatever its environment or not.

Returns:: {boolean}

{RoomController.RoomPaint} getCeilingPaint()

Returns whether the ceiling is colored, textured or unknown painted.

Returns:: {RoomController.RoomPaint}

{number} getCeilingShininess()

Returns the edited shininess of the ceiling.

Returns:: {number}

{TextureChoiceController} getCeilingTextureController()

Returns the texture controller of the room ceiling.

Returns:: {TextureChoiceController}

{boolean} getCeilingVisible()

Returns whether room ceiling is visible or not.

Returns:: {boolean}

{number} getFloorColor()

Returns the edited color of the floor.

Returns:: {number}

{RoomController.RoomPaint} getFloorPaint()

Returns whether the floor is colored, textured or unknown painted.

Returns:: {RoomController.RoomPaint}

{number} getFloorShininess()

Returns the edited shininess of the floor.

Returns:: {number}

{TextureChoiceController} getFloorTextureController()

Returns the texture controller of the room floor.

Returns:: {TextureChoiceController}

{boolean} getFloorVisible()

Returns whether room floor is visible or not.

Returns:: {boolean}

{string} getName()

Returns the edited name.

Returns:: {string}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{BaseboardChoiceController} getWallSidesBaseboardController()

Returns the controller of the wall sides baseboard.

Returns:: {BaseboardChoiceController}

{number} getWallSidesColor()

Returns the edited color of the wall sides.

Returns:: {number}

{RoomController.RoomPaint} getWallSidesPaint()

Returns whether the wall sides are colored, textured or unknown painted.

Returns:: {RoomController.RoomPaint}

{number} getWallSidesShininess()

Returns the edited shininess of the wall sides.

Returns:: {number}

{TextureChoiceController} getWallSidesTextureController()

Returns the texture controller of the room wall sides.

Returns:: {TextureChoiceController}

{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 WALL properties.

Parameters:
{string} property

Returns:: {boolean}

{boolean} isSplitSurroundingWalls()

Returns true if walls around the edited rooms should be split.

Returns:: {boolean}

{boolean} isSplitSurroundingWallsNeeded()

Returns true if walls around the edited rooms need to be split to avoid changing the color of wall sides that belong to neighborhood rooms.

Returns:: {boolean}

modifyRooms()

Controls the modification of selected rooms in edited home.

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setAreaVisible(areaVisible)

Sets whether room area is visible or not.

Parameters:
{boolean} areaVisible

setCeilingColor(ceilingColor)

Sets the edited color of the ceiling.

Parameters:
{number} ceilingColor

setCeilingFlat(ceilingCeilingFlat)

Sets whether room ceiling should remain flat whatever its environment or not.

Parameters:
{boolean} ceilingCeilingFlat

setCeilingPaint(ceilingPaint)

Sets whether the ceiling is colored, textured or unknown painted.

Parameters:
{RoomController.RoomPaint} ceilingPaint

setCeilingShininess(ceilingShininess)

Sets the edited shininess of the ceiling.

Parameters:
{number} ceilingShininess

setCeilingVisible(ceilingCeilingVisible)

Sets whether room ceiling is visible or not.

Parameters:
{boolean} ceilingCeilingVisible

setFloorColor(floorColor)

Sets the edited color of the floor.

Parameters:
{number} floorColor

setFloorPaint(floorPaint)

Sets whether the floor is colored, textured or unknown painted.

Parameters:
{RoomController.RoomPaint} floorPaint

setFloorShininess(floorShininess)

Sets the edited shininess of the floor.

Parameters:
{number} floorShininess

setFloorVisible(floorVisible)

Sets whether room floor is visible or not.

Parameters:
{boolean} floorVisible

setName(name)

Sets the edited name.

Parameters:
{string} name

setSplitSurroundingWalls(splitSurroundingWalls)

Sets whether walls around the edited rooms should be split or not.

Parameters:
{boolean} splitSurroundingWalls

setWallSidesColor(wallSidesColor)

Sets the edited color of the wall sides.

Parameters:
{number} wallSidesColor

setWallSidesPaint(wallSidesPaint)

Sets whether the wall sides are colored, textured or unknown painted.

Parameters:
{RoomController.RoomPaint} wallSidesPaint

setWallSidesShininess(wallSidesShininess)

Sets the edited shininess of the wall sides.

Parameters:
{number} wallSidesShininess

updateProperties()

Updates edited properties from selected rooms in the home edited by this controller.

	© Copyright 2024 Emmanuel PUYBARET / eTeks Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Thu Apr 04 2024 17:30:26 GMT+0200 (CEST)

Classes

Class RoomController