com.eteks.sweethome3d.model

Class HomeDoorOrWindow

java.lang.Object

com.eteks.sweethome3d.model.HomeObject

com.eteks.sweethome3d.model.HomePieceOfFurniture

com.eteks.sweethome3d.model.HomeDoorOrWindow

All Implemented Interfaces:

DoorOrWindow, Elevatable, PieceOfFurniture, Selectable, java.io.Serializable, java.lang.Cloneable

public class HomeDoorOrWindow
extends HomePieceOfFurniture
implements DoorOrWindow

A door or a window in home.

Since:

1.7

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomeDoorOrWindow.Property The properties of a door or window that may change.

Nested classes/interfaces inherited from class com.eteks.sweethome3d.model.HomePieceOfFurniture

HomePieceOfFurniture.SortableProperty

Field Summary

Fields inherited from class com.eteks.sweethome3d.model.HomePieceOfFurniture

EMPTY_PROPERTY_ARRAY

Fields inherited from interface com.eteks.sweethome3d.model.PieceOfFurniture

DEFAULT_CUT_OUT_SHAPE, HIDE_EDGE_COLOR_MATERIAL, IDENTITY_ROTATION, SHOW_BACK_FACE

Constructor Summary

Constructors

Constructor and Description
HomeDoorOrWindow(DoorOrWindow doorOrWindow) Creates a home door or window from an existing one.
HomeDoorOrWindow(DoorOrWindow doorOrWindow, java.lang.String[] copiedProperties) Creates a home door or window from an existing one.
HomeDoorOrWindow(java.lang.String id, DoorOrWindow doorOrWindow) Creates a home door or window from an existing one.
HomeDoorOrWindow(java.lang.String id, DoorOrWindow doorOrWindow, java.lang.String[] copiedProperties) Creates a home door or window from an existing one.

Method Summary

Modifier and Type	Method and Description
HomeObject	duplicate() Returns a copy of this door or window.
java.lang.String	getCutOutShape() Returns the shape used to cut out walls that intersect this door or window.
Sash[]	getSashes() Returns a copy of the sashes attached to this door or window.
float	getWallDistance() Returns the distance between the back side of this door or window and the wall where it's located.
float	getWallHeight() Returns the height of the wall part in which this door or window should be placed.
float	getWallLeft() Returns the distance between the left side of this door or window and the wall part where it should be placed.
float	getWallThickness() Returns the thickness of the wall in which this door or window should be placed.
float	getWallTop() Returns the distance between the left side of this door or window and the wall part where it should be placed.
float	getWallWidth() Returns the width of the wall part in which this door or window should be placed.
boolean	isBoundToWall() Returns true if the location and the size of this door or window were bound to a wall, last time they were updated.
boolean	isDoorOrWindow() Returns always true.
boolean	isWallCutOutOnBothSides() Returns true if this door or window should cut out the both sides of the walls it intersects, even if its front or back side are within the wall thickness.
boolean	isWidthDepthDeformable() Returns false if the width and depth of this door or window may not be changed independently from each other.
void	setAngle(float angle) Sets the angle of this door or window and resets its boundToWall flag if the angle changed.
void	setBoundToWall(boolean boundToWall) Sets whether the location and the size of this door or window were bound to a wall, last time they were updated.
void	setCutOutShape(java.lang.String cutOutShape) Sets the shape used to cut out walls that intersect this door or window.
void	setDepth(float depth) Sets the depth of this door or window and resets its boundToWall flag if the depth changed.
void	setSashes(Sash[] sashes) Sets the sashes attached to this door or window.
void	setWallCutOutOnBothSides(boolean wallCutOutOnBothSides) Sets whether the width and depth of the new door or window may be changed independently from each other.
void	setWallDistance(float wallDistance) Sets the distance between the back side of this door or window and the wall where it's located.
void	setWallHeight(float wallHeight) Sets the height of the wall part in which this door or window should be placed.
void	setWallLeft(float wallLeft) Sets the distance between the left side of this door or window and the wall part where it should be placed.
void	setWallThickness(float wallThickness) Sets the thickness of the wall in which this door or window should be placed.
void	setWallTop(float wallTop) Sets the distance between the top side of this door or window and the wall part where it should be placed.
void	setWallWidth(float wallWidth) Sets the width of the wall part in which this door or window should be placed.
void	setWidthDepthDeformable(boolean widthDepthDeformable) Sets whether the width and depth of the new door or window may be changed independently from each other.
void	setX(float x) Sets the abscissa of this door or window and resets its boundToWall flag if the abscissa changed.
void	setY(float y) Sets the ordinate of this door or window and resets its boundToWall flag if the ordinate changed.

Methods inherited from class com.eteks.sweethome3d.model.HomePieceOfFurniture

clone, containsPoint, getAngle, getCatalogId, getColor, getCreator, getCurrency, getDepth, getDepthInPlan, getDescription, getDropOnTopElevation, getElevation, getFurnitureComparator, getGroundElevation, getHeight, getHeightInPlan, getIcon, getInformation, getLevel, getLicense, getModel, getModelFlags, getModelMaterials, getModelRotation, getModelSize, getModelTransformations, getName, getNameAngle, getNameStyle, getNameXOffset, getNameYOffset, getPitch, getPlanIcon, getPoints, getPrice, getPriceValueAddedTaxIncluded, getRoll, getShininess, getStaircaseCutOutShape, getTexture, getValueAddedTax, getValueAddedTaxPercentage, getWidth, getWidthInPlan, getX, getY, intersectsRectangle, isAtLevel, isBackFaceShown, isBottomLeftPointAt, isBottomRightPointAt, isDeformable, isHorizontallyRotatable, isHorizontallyRotated, isModelCenteredAtOrigin, isModelMirrored, isMovable, isNameCenterPointAt, isNameVisible, isParallelToWall, isPointAt, isResizable, isTexturable, isTopLeftPointAt, isTopRightPointAt, isVisible, move, scale, setBackFaceShown, setCatalogId, setColor, setCreator, setCurrency, setDepthInPlan, setDescription, setElevation, setHeight, setHeightInPlan, setIcon, setInformation, setLevel, setLicense, setModel, setModelCenteredAtOrigin, setModelFlags, setModelMaterials, setModelMirrored, setModelRotation, setModelSize, setModelTransformations, setMovable, setName, setNameAngle, setNameStyle, setNameVisible, setNameXOffset, setNameYOffset, setPitch, setPlanIcon, setPrice, setRoll, setShininess, setStaircaseCutOutShape, setTexture, setValueAddedTaxPercentage, setVisible, setWidth, setWidthInPlan

Methods inherited from class com.eteks.sweethome3d.model.HomeObject

addPropertyChangeListener, addPropertyChangeListener, createId, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, removePropertyChangeListener, removePropertyChangeListener, setProperty, setProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.eteks.sweethome3d.model.PieceOfFurniture

getColor, getContentProperty, getCreator, getCurrency, getDepth, getDescription, getDropOnTopElevation, getElevation, getHeight, getIcon, getInformation, getLicense, getModel, getModelFlags, getModelRotation, getModelSize, getName, getPlanIcon, getPrice, getProperty, getPropertyNames, getStaircaseCutOutShape, getValueAddedTaxPercentage, getWidth, isBackFaceShown, isContentProperty, isDeformable, isHorizontallyRotatable, isMovable, isResizable, isTexturable

Constructor Detail

HomeDoorOrWindow

public HomeDoorOrWindow(DoorOrWindow doorOrWindow)

Creates a home door or window from an existing one. No additional properties will be copied.

Parameters:

doorOrWindow - the door or window from which data are copied

HomeDoorOrWindow

public HomeDoorOrWindow(DoorOrWindow doorOrWindow,
                        java.lang.String[] copiedProperties)

Creates a home door or window from an existing one.

Parameters:

doorOrWindow - the door or window from which data are copied

copiedProperties - the names of the additional properties which should be copied from the existing piece or null if all properties should be copied.

Since:

7.2

HomeDoorOrWindow

public HomeDoorOrWindow(java.lang.String id,
                        DoorOrWindow doorOrWindow)

Creates a home door or window from an existing one. No additional properties will be copied.

Parameters:

id - the ID of the object

doorOrWindow - the door or window from which data are copied

Since:

6.4

HomeDoorOrWindow

public HomeDoorOrWindow(java.lang.String id,
                        DoorOrWindow doorOrWindow,
                        java.lang.String[] copiedProperties)

Creates a home door or window from an existing one.

Parameters:

id - the ID of the object

doorOrWindow - the door or window from which data are copied

copiedProperties - the names of the additional properties which should be copied from the existing piece or null if all properties should be copied.

Since:

7.2

Method Detail

getWallThickness

public float getWallThickness()

Returns the thickness of the wall in which this door or window should be placed.

Specified by:

getWallThickness in interface DoorOrWindow

Returns:

a value in percentage of the depth of the door or the window.

setWallThickness

public void setWallThickness(float wallThickness)

Sets the thickness of the wall in which this door or window should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallThickness - a value in percentage of the depth of the door or the window.

Since:

6.0

getWallDistance

public float getWallDistance()

Returns the distance between the back side of this door or window and the wall where it's located.

Specified by:

getWallDistance in interface DoorOrWindow

Returns:

a distance in percentage of the depth of the door or the window.

setWallDistance

public void setWallDistance(float wallDistance)

Sets the distance between the back side of this door or window and the wall where it's located. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallDistance - a distance in percentage of the depth of the door or the window.

Since:

6.0

getWallWidth

public float getWallWidth()

Returns the width of the wall part in which this door or window should be placed.

Returns:

a value in percentage of the width of the door or the window.

Since:

6.0

setWallWidth

public void setWallWidth(float wallWidth)

Sets the width of the wall part in which this door or window should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallWidth - a value in percentage of the width of the door or the window.

Since:

6.0

getWallLeft

public float getWallLeft()

Returns the distance between the left side of this door or window and the wall part where it should be placed.

Returns:

a distance in percentage of the width of the door or the window.

Since:

6.0

setWallLeft

public void setWallLeft(float wallLeft)

Sets the distance between the left side of this door or window and the wall part where it should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallLeft - a distance in percentage of the width of the door or the window.

Since:

6.0

getWallHeight

public float getWallHeight()

Returns the height of the wall part in which this door or window should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Returns:

a value in percentage of the height of the door or the window.

Since:

6.0

setWallHeight

public void setWallHeight(float wallHeight)

Sets the height of the wall part in which this door or window should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallHeight - a value in percentage of the height of the door or the window.

Since:

6.0

getWallTop

public float getWallTop()

Returns the distance between the left side of this door or window and the wall part where it should be placed.

Returns:

a distance in percentage of the height of the door or the window.

Since:

6.0

setWallTop

public void setWallTop(float wallTop)

Sets the distance between the top side of this door or window and the wall part where it should be placed. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

wallTop - a distance in percentage of the height of the door or the window.

Since:

6.0

getSashes

public Sash[] getSashes()

Returns a copy of the sashes attached to this door or window. If no sash is defined an empty array is returned.

Specified by:

getSashes in interface DoorOrWindow

setSashes

public void setSashes(Sash[] sashes)

Sets the sashes attached to this door or window. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

sashes - sashes of this window.

Since:

6.0

getCutOutShape

public java.lang.String getCutOutShape()

Returns the shape used to cut out walls that intersect this door or window.

Specified by:

getCutOutShape in interface DoorOrWindow

Returns:

null or a shape defined with the syntax of the d attribute of a SVG path element that fits in a square spreading from (0, 0) to (1, 1) which will be scaled afterwards to the real size of this door or window.

Since:

4.2

setCutOutShape

public void setCutOutShape(java.lang.String cutOutShape)

Sets the shape used to cut out walls that intersect this door or window. Once this piece is updated, listeners added to this piece will receive a change notification.

Parameters:

cutOutShape - a SVG path element.

Since:

6.5

isWallCutOutOnBothSides

public boolean isWallCutOutOnBothSides()

Returns true if this door or window should cut out the both sides of the walls it intersects, even if its front or back side are within the wall thickness.

Specified by:

isWallCutOutOnBothSides in interface DoorOrWindow

Since:

5.5

setWallCutOutOnBothSides

public void setWallCutOutOnBothSides(boolean wallCutOutOnBothSides)

Sets whether the width and depth of the new door or window may be changed independently from each other. Once this piece is updated, listeners added to this piece will receive a change notification.

Since:

6.5

isWidthDepthDeformable

public boolean isWidthDepthDeformable()

Returns false if the width and depth of this door or window may not be changed independently from each other. When false, this door or window will also make a hole in the wall when it's placed whatever its depth if its bouldToWall flag is true.

Specified by:

isWidthDepthDeformable in interface DoorOrWindow

Specified by:

isWidthDepthDeformable in interface PieceOfFurniture

Overrides:

isWidthDepthDeformable in class HomePieceOfFurniture

Since:

5.5

setWidthDepthDeformable

public void setWidthDepthDeformable(boolean widthDepthDeformable)

Sets whether the width and depth of the new door or window may be changed independently from each other. Once this piece is updated, listeners added to this piece will receive a change notification.

Since:

6.5

isBoundToWall

public boolean isBoundToWall()

Returns true if the location and the size of this door or window were bound to a wall, last time they were updated.

setBoundToWall

public void setBoundToWall(boolean boundToWall)

Sets whether the location and the size of this door or window were bound to a wall, last time they were updated. Once this piece is updated, listeners added to this piece will receive a change notification.

setX

public void setX(float x)

Sets the abscissa of this door or window and resets its boundToWall flag if the abscissa changed.

Overrides:

setX in class HomePieceOfFurniture

setY

public void setY(float y)

Sets the ordinate of this door or window and resets its boundToWall flag if the ordinate changed.

Overrides:

setY in class HomePieceOfFurniture

setAngle

public void setAngle(float angle)

Sets the angle of this door or window and resets its boundToWall flag if the angle changed.

Overrides:

setAngle in class HomePieceOfFurniture

setDepth

public void setDepth(float depth)

Sets the depth of this door or window and resets its boundToWall flag if the depth changed.

Overrides:

setDepth in class HomePieceOfFurniture

isDoorOrWindow

public boolean isDoorOrWindow()

Returns always true.

Specified by:

isDoorOrWindow in interface PieceOfFurniture

Overrides:

isDoorOrWindow in class HomePieceOfFurniture

duplicate

public HomeObject duplicate()

Returns a copy of this door or window.

Overrides:

duplicate in class HomeObject

Since:

6.4