Class Wall

Extends HomeObject.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Wall(id, xStart, yStart, xEnd, yEnd, thickness, height, pattern) Creates a wall from (`xStart`,`yStart`) to (`xEnd`, `yEnd`), with given thickness, height and pattern.

Method Summary
Method Attributes	Method Name and Description
<static>	Wall.clone(walls) Returns a clone of the `walls` list.
	clone() Returns a clone of this wall expected its wall at start and wall at end aren't copied.
	containsPoint(x, y, includeBaseboards, margin) Returns `true` if this wall contains the point at (`x`, `y`) possibly including its baseboards, with a given `margin`.
	containsWallEndAt(x, y, margin) Returns `true` if this wall end line contains the point at (`x`, `y`) with a given `margin` around the wall end line.
	containsWallStartAt(x, y, margin) Returns `true` if this wall start line contains the point at (`x`, `y`) with a given `margin` around the wall start line.
<static>	Wall.duplicate(walls) Returns a duplicate of the `walls` list.
	getArcExtent() Returns the arc extent of a round wall or `null` if this wall isn't round.
	getHeight() Returns the height of this wall.
	getHeightAtEnd() Returns the height of this wall at its end point.
	getLeftSideBaseboard() Returns the left side baseboard of this wall.
	getLeftSideColor() Returns left side color of this wall.
	getLeftSideShininess() Returns the left side shininess of this wall.
	getLeftSideTexture() Returns the left side texture of this wall.
	getLength() Returns the length of this wall.
	getLevel() Returns the level which this wall belongs to.
	getPattern() Returns the pattern of this wall in the plan.
	getPoints(includeBaseboards) Returns the points of each corner of a wall possibly including its baseboards.
	getRightSideBaseboard() Returns the right side baseboard of this wall.
	getRightSideColor() Returns right side color of this wall.
	getRightSideShininess() Returns the right side shininess of this wall.
	getRightSideTexture() Returns the right side texture of this wall.
	getStartPointToEndPointDistance() Returns the distance from the start point of this wall to its end point.
	getThickness() Returns the thickness of this wall.
	getTopColor() Returns the color of the top of this wall in the 3D view.
	getWallAtEnd() Returns the wall joined to this wall at end point.
	getWallAtStart() Returns the wall joined to this wall at start point.
	getXArcCircleCenter() Returns the abscissa of the arc circle center of this wall.
	getXEnd() Returns the end point abscissa of this wall.
	getXStart() Returns the start point abscissa of this wall.
	getYArcCircleCenter() Returns the ordinate of the arc circle center of this wall.
	getYEnd() Returns the end point ordinate of this wall.
	getYStart() Returns the start point ordinate of this wall.
	intersectsRectangle(x0, y0, x1, y1) Returns `true` if this wall intersects with the horizontal rectangle which opposite corners are at points (`x0`, `y0`) and (`x1`, `y1`).
	isAtLevel(level) Returns `true` if this wall is at the given `level` or at a level with the same elevation and a smaller elevation index or if the elevation of its highest point is higher than `level` elevation.
	isMiddlePointAt(x, y, margin) Returns `true` if the middle point of this wall is the point at (`x`, `y`) with a given `margin`.
	isTrapezoidal() Returns `true` if the height of this wall is different at its start and end points.
	move(dx, dy) Moves this wall of (`dx`, `dy`) units.
	setArcExtent(arcExtent) Sets the arc extent of a round wall.
	setHeight(height) Sets the height of this wall.
	setHeightAtEnd(heightAtEnd) Sets the height of this wall at its end point.
	setLeftSideBaseboard(leftSideBaseboard) Sets the left side baseboard of this wall.
	setLeftSideColor(leftSideColor) Sets left side color of this wall.
	setLeftSideShininess(leftSideShininess) Sets the left side shininess of this wall.
	setLeftSideTexture(leftSideTexture) Sets the left side texture of this wall.
	setLevel(level) Sets the level of this wall.
	setPattern(pattern) Sets the pattern of this wall in the plan, and notifies listeners of this change.
	setRightSideBaseboard(rightSideBaseboard) Sets the right side baseboard of this wall.
	setRightSideColor(rightSideColor) Sets right side color of this wall.
	setRightSideShininess(rightSideShininess) Sets the right side shininess of this wall.
	setRightSideTexture(rightSideTexture) Sets the right side texture of this wall.
	setThickness(thickness) Sets wall thickness.
	setTopColor(topColor) Sets the color of the top of this wall in the 3D view, and notifies listeners of this change.
	setXEnd(xEnd) Sets the end point abscissa of this wall.
	setXStart(xStart) Sets the start point abscissa of this wall.
	setYEnd(yEnd) Sets the end point ordinate of this wall.
	setYStart(yStart) Sets the start point ordinate of this wall.

Methods borrowed from class HomeObject:: firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, setProperty

Class Detail

Wall(id, xStart, yStart, xEnd, yEnd, thickness, height, pattern)

Creates a wall from (xStart,yStart) to (xEnd, yEnd), with given thickness, height and pattern. Colors are null.
Author: Emmanuel Puybaret.

Parameters:
{string} id
{number} xStart
{number} yStart
{number} xEnd
{number} yEnd
{number} thickness
{number} height
{Object} pattern

Method Detail

<static> {Wall[]} Wall.clone(walls)

Returns a clone of the walls list. All existing walls are copied and their wall at start and end point are set with copied walls only if they belong to the returned list.

Parameters:
{Wall[]} walls

Returns:: {Wall[]}

{Wall} clone()

Returns a clone of this wall expected its wall at start and wall at end aren't copied.

Returns:: {Wall}

{boolean} containsPoint(x, y, includeBaseboards, margin)

Returns true if this wall contains the point at (x, y) possibly including its baseboards, with a given margin.

Parameters:
{number} x
{number} y
{boolean} includeBaseboards
{number} margin

Returns:: {boolean}

{boolean} containsWallEndAt(x, y, margin)

Returns true if this wall end line contains the point at (x, y) with a given margin around the wall end line.

Parameters:
{number} x
{number} y
{number} margin

Returns:: {boolean}

{boolean} containsWallStartAt(x, y, margin)

Returns true if this wall start line contains the point at (x, y) with a given margin around the wall start line.

Parameters:
{number} x
{number} y
{number} margin

Returns:: {boolean}

<static> {Wall[]} Wall.duplicate(walls)

Returns a duplicate of the walls list. All existing walls are copied and their wall at start and end point are set with copied walls only if they belong to the returned list. The id of duplicated walls are regenerated.

Parameters:
{Wall[]} walls

Returns:: {Wall[]}

{number} getArcExtent()

Returns the arc extent of a round wall or null if this wall isn't round.

Returns:: {number}

{number} getHeight()

Returns the height of this wall. If {@link #getHeightAtEnd() getHeightAtEnd} returns a value not null, the returned height should be considered as the height of this wall at its start point.

Returns:: {number}

{number} getHeightAtEnd()

Returns the height of this wall at its end point.

Returns:: {number}

{Baseboard} getLeftSideBaseboard()

Returns the left side baseboard of this wall.

Returns:: {Baseboard}

{number} getLeftSideColor()

Returns left side color of this wall. This is the color of the left side of this wall when you go through wall from start point to end point.

Returns:: {number}

{number} getLeftSideShininess()

Returns the left side shininess of this wall.

Returns:: {number} a value between 0 (matt) and 1 (very shiny)

{HomeTexture} getLeftSideTexture()

Returns the left side texture of this wall.

Returns:: {HomeTexture}

{number} getLength()

Returns the length of this wall.

Returns:: {number}

{Level} getLevel()

Returns the level which this wall belongs to.

Returns:: {Level}

{Object} getPattern()

Returns the pattern of this wall in the plan.

Returns:: {Object}

{float[][]} getPoints(includeBaseboards)

Returns the points of each corner of a wall possibly including its baseboards.

Parameters:
{boolean} includeBaseboards

Returns:: {float[][]}

{Baseboard} getRightSideBaseboard()

Returns the right side baseboard of this wall.

Returns:: {Baseboard}

{number} getRightSideColor()

Returns right side color of this wall. This is the color of the right side of this wall when you go through wall from start point to end point.

Returns:: {number}

{number} getRightSideShininess()

Returns the right side shininess of this wall.

Returns:: {number} a value between 0 (matt) and 1 (very shiny)

{HomeTexture} getRightSideTexture()

Returns the right side texture of this wall.

Returns:: {HomeTexture}

{number} getStartPointToEndPointDistance()

Returns the distance from the start point of this wall to its end point.

Returns:: {number}

{number} getThickness()

Returns the thickness of this wall.

Returns:: {number}

{number} getTopColor()

Returns the color of the top of this wall in the 3D view.

Returns:: {number}

{Wall} getWallAtEnd()

Returns the wall joined to this wall at end point.

Returns:: {Wall}

{Wall} getWallAtStart()

Returns the wall joined to this wall at start point.

Returns:: {Wall}

{number} getXArcCircleCenter()

Returns the abscissa of the arc circle center of this wall. If the wall isn't round, the return abscissa is at the middle of the wall.

Returns:: {number}

{number} getXEnd()

Returns the end point abscissa of this wall.

Returns:: {number}

{number} getXStart()

Returns the start point abscissa of this wall.

Returns:: {number}

{number} getYArcCircleCenter()

Returns the ordinate of the arc circle center of this wall. If the wall isn't round, the return ordinate is at the middle of the wall.

Returns:: {number}

{number} getYEnd()

Returns the end point ordinate of this wall.

Returns:: {number}

{number} getYStart()

Returns the start point ordinate of this wall.

Returns:: {number}

{boolean} intersectsRectangle(x0, y0, x1, y1)

Returns true if this wall intersects with the horizontal rectangle which opposite corners are at points (x0, y0) and (x1, y1).

Parameters:
{number} x0
{number} y0
{number} x1
{number} y1

Returns:: {boolean}

{boolean} isAtLevel(level)

Returns true if this wall is at the given level or at a level with the same elevation and a smaller elevation index or if the elevation of its highest point is higher than level elevation.

Parameters:
{Level} level

Returns:: {boolean}

{boolean} isMiddlePointAt(x, y, margin)

Returns true if the middle point of this wall is the point at (x, y) with a given margin.

Parameters:
{number} x
{number} y
{number} margin

Returns:: {boolean}

{boolean} isTrapezoidal()

Returns true if the height of this wall is different at its start and end points.

Returns:: {boolean}

move(dx, dy)

Moves this wall of (dx, dy) units.

Parameters:
{number} dx
{number} dy

setArcExtent(arcExtent)

Sets the arc extent of a round wall.

Parameters:
{number} arcExtent

setHeight(height)

Sets the height of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} height

setHeightAtEnd(heightAtEnd)

Sets the height of this wall at its end point. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} heightAtEnd

setLeftSideBaseboard(leftSideBaseboard)

Sets the left side baseboard of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{Baseboard} leftSideBaseboard

setLeftSideColor(leftSideColor)

Sets left side color of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} leftSideColor

setLeftSideShininess(leftSideShininess)

Sets the left side shininess of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} leftSideShininess

setLeftSideTexture(leftSideTexture)

Sets the left side texture of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{HomeTexture} leftSideTexture

setLevel(level)

Sets the level of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{Level} level

setPattern(pattern)

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

Parameters:
{Object} pattern

setRightSideBaseboard(rightSideBaseboard)

Sets the right side baseboard of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{Baseboard} rightSideBaseboard

setRightSideColor(rightSideColor)

Sets right side color of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} rightSideColor

setRightSideShininess(rightSideShininess)

Sets the right side shininess of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} rightSideShininess

setRightSideTexture(rightSideTexture)

Sets the right side texture of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{HomeTexture} rightSideTexture

setThickness(thickness)

Sets wall thickness. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} thickness

setTopColor(topColor)

Sets the color of the top of this wall in the 3D view, and notifies listeners of this change.

Parameters:
{number} topColor

setXEnd(xEnd)

Sets the end point abscissa of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} xEnd

setXStart(xStart)

Sets the start point abscissa of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} xStart

setYEnd(yEnd)

Sets the end point ordinate of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} yEnd

setYStart(yStart)

Sets the start point ordinate of this wall. Once this wall is updated, listeners added to this wall will receive a change notification.

Parameters:
{number} yStart

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

Classes

Class Wall