Class WallController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	WallController(home, preferences, viewFactory, contentManager, undoSupport) Creates the controller of wall 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.
	getArcExtentInDegrees() Returns the edited arc extent.
	getArcLength() Returns the length of wall after applying the edited arc extent.
	getDistanceToEndPoint() Returns the edited distance to end point.
	getLeftSideBaseboardController() Returns the controller of the wall left side baseboard.
	getLeftSideColor() Returns the edited color of the left side.
	getLeftSidePaint() Returns whether the left side is colored, textured or unknown painted.
	getLeftSideShininess() Returns the edited left side shininess.
	getLeftSideTextureController() Returns the texture controller of the wall left side.
	getLength() Returns the edited length.
	getPattern() Returns the pattern of edited wall in plan.
	getRectangularWallHeight() Returns the edited height of a rectangular wall.
	getRightSideBaseboardController() Returns the controller of the wall right side baseboard.
	getRightSideColor() Returns the edited color of the right side.
	getRightSidePaint() Returns whether the right side is colored, textured or unknown painted.
	getRightSideShininess() Returns the edited right side shininess.
	getRightSideTextureController() Returns the texture controller of the wall right side.
	getShape() Returns whether the edited wall is a rectangular wall, a sloping wall or unknown.
	getSlopingWallHeightAtEnd() Returns the edited height at end of a sloping wall.
	getSlopingWallHeightAtStart() Returns the edited height at start of a sloping wall.
	getThickness() Returns the edited thickness.
	getTopColor() Returns the edited top color in the 3D view.
	getTopPaint() Returns whether the top of the wall in the 3D view uses default rendering, is colored, or unknown painted.
	getView() Returns the view associated with this controller.
	getXEnd() Returns the edited abscissa of the end point.
	getXStart() Returns the edited abscissa of the start point.
	getYEnd() Returns the edited ordinate of the end point.
	getYStart() Returns the edited ordinate of the start point.
	isEditablePoints() Returns whether the point coordinates can be be edited or not.
	modifyWalls() Controls the modification of selected walls in edited home.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setArcExtentInDegrees(arcExtentInDegrees) Sets the edited arc extent.
	setEditablePoints(editablePoints) Sets whether the point coordinates can be be edited or not.
	setLeftSideColor(leftSideColor) Sets the edited color of the left side.
	setLeftSidePaint(leftSidePaint) Sets whether the left side is colored, textured or unknown painted.
	setLeftSideShininess(leftSideShininess) Sets the edited left side shininess.
	setPattern(pattern) Sets the pattern of edited wall in plan, and notifies listeners of this change.
	setRectangularWallHeight(rectangularWallHeight) Sets the edited height of a rectangular wall.
	setRightSideColor(rightSideColor) Sets the edited color of the right side.
	setRightSidePaint(rightSidePaint) Sets whether the right side is colored, textured or unknown painted.
	setRightSideShininess(rightSideShininess) Sets the edited right side shininess.
	setShape(shape) Sets whether the edited wall is a rectangular wall, a sloping wall or unknown.
	setSlopingWallHeightAtEnd(sloppingWallHeightAtEnd) Sets the edited height at end of a sloping wall.
	setSlopingWallHeightAtStart(slopingWallHeightAtStart) Sets the edited height at start of a sloping wall.
	setThickness(thickness) Sets the edited thickness.
	setTopColor(topColor) Sets the edited top color in the 3D view.
	setTopPaint(topPaint) Sets whether the top of the wall in the 3D view uses default rendering, is colored, or unknown painted.
	setXEnd(xEnd) Sets the edited abscissa of the end point.
	setXStart(xStart) Sets the edited abscissa of the start point.
	setYEnd(yEnd) Sets the edited ordinate of the end point.
	setYStart(yStart) Sets the edited ordinate of the start point.
	updateProperties() Updates edited properties from selected walls in the home edited by this controller.

Class Detail

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

Creates the controller of wall 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

{number} getArcExtentInDegrees()

Returns the edited arc extent.

Returns:: {number}

{number} getArcLength()

Returns the length of wall after applying the edited arc extent.

Returns:: {number} the arc length or null if data is missing to compute it

{number} getDistanceToEndPoint()

Returns the edited distance to end point.

Returns:: {number}

{BaseboardChoiceController} getLeftSideBaseboardController()

Returns the controller of the wall left side baseboard.

Returns:: {BaseboardChoiceController}

{number} getLeftSideColor()

Returns the edited color of the left side.

Returns:: {number}

{WallController.WallPaint} getLeftSidePaint()

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

Returns:: {WallController.WallPaint} WallPaint#COLORED, WallPaint#TEXTURED or null

{number} getLeftSideShininess()

Returns the edited left side shininess.

Returns:: {number}

{TextureChoiceController} getLeftSideTextureController()

Returns the texture controller of the wall left side.

Returns:: {TextureChoiceController}

{number} getLength()

Returns the edited length.

Returns:: {number}

{Object} getPattern()

Returns the pattern of edited wall in plan.

Returns:: {Object}

{number} getRectangularWallHeight()

Returns the edited height of a rectangular wall.

Returns:: {number}

{BaseboardChoiceController} getRightSideBaseboardController()

Returns the controller of the wall right side baseboard.

Returns:: {BaseboardChoiceController}

{number} getRightSideColor()

Returns the edited color of the right side.

Returns:: {number}

{WallController.WallPaint} getRightSidePaint()

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

Returns:: {WallController.WallPaint} WallPaint#COLORED, WallPaint#TEXTURED or null

{number} getRightSideShininess()

Returns the edited right side shininess.

Returns:: {number}

{TextureChoiceController} getRightSideTextureController()

Returns the texture controller of the wall right side.

Returns:: {TextureChoiceController}

{WallController.WallShape} getShape()

Returns whether the edited wall is a rectangular wall, a sloping wall or unknown.

Returns:: {WallController.WallShape}

{number} getSlopingWallHeightAtEnd()

Returns the edited height at end of a sloping wall.

Returns:: {number}

{number} getSlopingWallHeightAtStart()

Returns the edited height at start of a sloping wall.

Returns:: {number}

{number} getThickness()

Returns the edited thickness.

Returns:: {number}

{number} getTopColor()

Returns the edited top color in the 3D view.

Returns:: {number}

{WallController.WallPaint} getTopPaint()

Returns whether the top of the wall in the 3D view uses default rendering, is colored, or unknown painted.

Returns:: {WallController.WallPaint} WallPaint#DEFAULT, WallPaint#COLORED or null

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{number} getXEnd()

Returns the edited abscissa of the end point.

Returns:: {number}

{number} getXStart()

Returns the edited abscissa of the start point.

Returns:: {number}

{number} getYEnd()

Returns the edited ordinate of the end point.

Returns:: {number}

{number} getYStart()

Returns the edited ordinate of the start point.

Returns:: {number}

{boolean} isEditablePoints()

Returns whether the point coordinates can be be edited or not.

Returns:: {boolean}

modifyWalls()

Controls the modification of selected walls in edited home.

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setArcExtentInDegrees(arcExtentInDegrees)

Sets the edited arc extent.

Parameters:
{number} arcExtentInDegrees

setEditablePoints(editablePoints)

Sets whether the point coordinates can be be edited or not.

Parameters:
{boolean} editablePoints

setLeftSideColor(leftSideColor)

Sets the edited color of the left side.

Parameters:
{number} leftSideColor

setLeftSidePaint(leftSidePaint)

Sets whether the left side is colored, textured or unknown painted.

Parameters:
{WallController.WallPaint} leftSidePaint

setLeftSideShininess(leftSideShininess)

Sets the edited left side shininess.

Parameters:
{number} leftSideShininess

setPattern(pattern)

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

Parameters:
{Object} pattern

setRectangularWallHeight(rectangularWallHeight)

Sets the edited height of a rectangular wall.

Parameters:
{number} rectangularWallHeight

setRightSideColor(rightSideColor)

Sets the edited color of the right side.

Parameters:
{number} rightSideColor

setRightSidePaint(rightSidePaint)

Sets whether the right side is colored, textured or unknown painted.

Parameters:
{WallController.WallPaint} rightSidePaint

setRightSideShininess(rightSideShininess)

Sets the edited right side shininess.

Parameters:
{number} rightSideShininess

setShape(shape)

Sets whether the edited wall is a rectangular wall, a sloping wall or unknown.

Parameters:
{WallController.WallShape} shape

setSlopingWallHeightAtEnd(sloppingWallHeightAtEnd)

Sets the edited height at end of a sloping wall.

Parameters:
{number} sloppingWallHeightAtEnd

setSlopingWallHeightAtStart(slopingWallHeightAtStart)

Sets the edited height at start of a sloping wall.

Parameters:
{number} slopingWallHeightAtStart

setThickness(thickness)

Sets the edited thickness.

Parameters:
{number} thickness

setTopColor(topColor)

Sets the edited top color in the 3D view.

Parameters:
{number} topColor

setTopPaint(topPaint)

Sets whether the top of the wall in the 3D view uses default rendering, is colored, or unknown painted.

Parameters:
{WallController.WallPaint} topPaint

setXEnd(xEnd)

Sets the edited abscissa of the end point.

Parameters:
{number} xEnd

setXStart(xStart)

Sets the edited abscissa of the start point.

Parameters:
{number} xStart

setYEnd(yEnd)

Sets the edited ordinate of the end point.

Parameters:
{number} yEnd

setYStart(yStart)

Sets the edited ordinate of the start point.

Parameters:
{number} yStart

updateProperties()

Updates edited properties from selected walls in the home 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 WallController