com.eteks.sweethome3d.model
Class HomePieceOfFurniture

java.lang.Object
  com.eteks.sweethome3d.model.HomePieceOfFurniture

All Implemented Interfaces:

PieceOfFurniture, Selectable, Serializable, Cloneable

Direct Known Subclasses:

HomeDoorOrWindow, HomeFurnitureGroup, HomeLight

public class HomePieceOfFurniture
extends Object
implements PieceOfFurniture, Serializable, Selectable

A piece of furniture in home.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

static class	HomePieceOfFurniture.Property The properties of a piece of furniture that may change.
static class	HomePieceOfFurniture.SortableProperty The properties on which home furniture may be sorted.

Constructor Summary

HomePieceOfFurniture(PieceOfFurniture piece)
Creates a home piece of furniture from an existing piece.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds the property change listener in parameter to this piece.
HomePieceOfFurniture	clone() Returns a clone of this piece.
boolean	containsPoint(float x, float y, float margin) Returns true if this piece contains the point at (x, y) with a given margin.
float	getAngle() Returns the angle in radians of this piece of furniture.
String	getCatalogId() Returns the catalog ID of this piece of furniture or null if it doesn't exist.
Integer	getColor() Returns the color of this piece of furniture.
float	getDepth() Returns the depth of this piece of furniture.
String	getDescription() Returns the description of this piece of furniture.
float	getElevation() Returns the elevation of the bottom of this piece of furniture.
static Comparator<HomePieceOfFurniture>	getFurnitureComparator(HomePieceOfFurniture.SortableProperty property) Returns a comparator that compares furniture on a given property in ascending order.
float	getHeight() Returns the height of this piece of furniture.
Content	getIcon() Returns the icon of this piece of furniture.
Content	getModel() Returns the 3D model of this piece of furniture.
float[][]	getModelRotation() Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.
String	getName() Returns the name of this piece of furniture.
TextStyle	getNameStyle() Returns the text style used to display piece name.
float	getNameXOffset() Returns the distance along x axis applied to piece abscissa to display piece name.
float	getNameYOffset() Returns the distance along y axis applied to piece ordinate to display piece name.
Content	getPlanIcon() Returns the icon of this piece of furniture displayed in plan or null.
float[][]	getPoints() Returns the points of each corner of a piece.
BigDecimal	getPrice() Returns the price of this piece of furniture or null.
BigDecimal	getPriceValueAddedTaxIncluded() Returns the price of this piece of furniture, Value Added Tax included.
HomeTexture	getTexture() Returns the texture of this piece of furniture.
BigDecimal	getValueAddedTax() Returns the Value Added Tax applied to the price of this piece of furniture.
BigDecimal	getValueAddedTaxPercentage() Returns the Value Added Tax percentage applied to the price of this piece of furniture.
float	getWidth() Returns the width of this piece of furniture.
float	getX() Returns the abscissa of the center of this piece of furniture.
float	getY() Returns the ordinate of the center of this piece of furniture.
boolean	intersectsRectangle(float x0, float y0, float x1, float y1) Returns true if this piece intersects with the horizontal rectangle which opposite corners are at points (x0, y0) and (x1, y1).
boolean	isBackFaceShown() Returns true if the back face of the piece of furniture model should be displayed.
boolean	isBottomLeftPointAt(float x, float y, float margin) Returns true if the bottom left point of this piece is the point at (x, y) with a given margin.
boolean	isBottomRightPointAt(float x, float y, float margin) Returns true if the bottom right point of this piece is the point at (x, y) with a given margin.
boolean	isDoorOrWindow() Returns true if this piece of furniture is a door or a window.
boolean	isModelMirrored() Returns true if the model of this piece should be mirrored.
boolean	isMovable() Returns true if this piece of furniture is movable.
boolean	isNameCenterPointAt(float x, float y, float margin) Returns true if the center point at which is displayed the name of this piece is equal to the point at (x, y) with a given margin.
boolean	isNameVisible() Returns whether the name of this piece should be drawn or not.
boolean	isPointAt(float x, float y, float margin) Returns true if one of the corner of this piece is the point at (x, y) with a given margin.
boolean	isResizable() Returns true if this piece is resizable.
boolean	isTopLeftPointAt(float x, float y, float margin) Returns true if the top left point of this piece is the point at (x, y) with a given margin.
boolean	isTopRightPointAt(float x, float y, float margin) Returns true if the top right point of this piece is the point at (x, y) with a given margin.
boolean	isVisible() Returns true if this piece of furniture is visible.
void	move(float dx, float dy) Moves this piece of (dx, dy) units.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes the property change listener in parameter from this piece.
void	setAngle(float angle) Sets the angle of this piece.
void	setColor(Integer color) Sets the color of this piece of furniture or null if piece color is unchanged.
void	setDepth(float depth) Sets the depth of this piece of furniture.
void	setDescription(String description) Sets the description of this piece of furniture.
void	setElevation(float elevation) Sets the elevation of this piece of furniture.
void	setHeight(float height) Sets the height of this piece of furniture.
void	setModelMirrored(boolean modelMirrored) Sets whether the model of this piece of furniture is mirrored or not.
void	setName(String name) Sets the name of this piece of furniture.
void	setNameStyle(TextStyle nameStyle) Sets the text style used to display piece name.
void	setNameVisible(boolean nameVisible) Sets whether the name of this piece is visible or not.
void	setNameXOffset(float nameXOffset) Sets the distance along x axis applied to piece abscissa to display piece name.
void	setNameYOffset(float nameYOffset) Sets the distance along y axis applied to piece ordinate to display piece name.
void	setTexture(HomeTexture texture) Sets the texture of this piece of furniture or null if piece texture is unchanged.
void	setVisible(boolean visible) Sets whether this piece of furniture is visible or not.
void	setWidth(float width) Sets the width of this piece of furniture.
void	setX(float x) Sets the abscissa of the center of this piece.
void	setY(float y) Sets the ordinate of the center of this piece.

Methods inherited from class java.lang.Object

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

Constructor Detail

HomePieceOfFurniture

public HomePieceOfFurniture(PieceOfFurniture piece)

Creates a home piece of furniture from an existing piece.

Parameters:

piece - the piece from which data are copied

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds the property change listener in parameter to this piece.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes the property change listener in parameter from this piece.

getCatalogId

public String getCatalogId()

Returns the catalog ID of this piece of furniture or null if it doesn't exist.

getName

public String getName()

Returns the name of this piece of furniture.

Specified by:

getName in interface PieceOfFurniture

setName

public void setName(String name)

Sets the name of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.

isNameVisible

public boolean isNameVisible()

Returns whether the name of this piece should be drawn or not.

setNameVisible

public void setNameVisible(boolean nameVisible)

Sets whether the name of this piece is visible or not. Once this piece of furniture is updated, listeners added to this piece will receive a change notification.

getNameXOffset

public float getNameXOffset()

Returns the distance along x axis applied to piece abscissa to display piece name.

setNameXOffset

public void setNameXOffset(float nameXOffset)

Sets the distance along x axis applied to piece abscissa to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.

getNameYOffset

public float getNameYOffset()

Returns the distance along y axis applied to piece ordinate to display piece name.

setNameYOffset

public void setNameYOffset(float nameYOffset)

Sets the distance along y axis applied to piece ordinate to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.

getNameStyle

public TextStyle getNameStyle()

Returns the text style used to display piece name.

setNameStyle

public void setNameStyle(TextStyle nameStyle)

Sets the text style used to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.

getDescription

public String getDescription()

Returns the description of this piece of furniture. The returned value may be null.

Specified by:

getDescription in interface PieceOfFurniture

setDescription

public void setDescription(String description)

Sets the description of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.

getDepth

public float getDepth()

Returns the depth of this piece of furniture.

Specified by:

getDepth in interface PieceOfFurniture

setDepth

public void setDepth(float depth)

Sets the depth of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.

Throws:

IllegalStateException - if this piece of furniture isn't resizable

getHeight

public float getHeight()

Returns the height of this piece of furniture.

Specified by:

getHeight in interface PieceOfFurniture

setHeight

public void setHeight(float height)

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

Throws:

IllegalStateException - if this piece of furniture isn't resizable

getWidth

public float getWidth()

Returns the width of this piece of furniture.

Specified by:

getWidth in interface PieceOfFurniture

setWidth

public void setWidth(float width)

Sets the width of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.

Throws:

IllegalStateException - if this piece of furniture isn't resizable

getElevation

public float getElevation()

Returns the elevation of the bottom of this piece of furniture.

Specified by:

getElevation in interface PieceOfFurniture

setElevation

public void setElevation(float elevation)

Sets the elevation of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.

isMovable

public boolean isMovable()

Returns true if this piece of furniture is movable.

Specified by:

isMovable in interface PieceOfFurniture

isDoorOrWindow

public boolean isDoorOrWindow()

Returns true if this piece of furniture is a door or a window. As this method existed before HomeDoorOrWindow class, you shouldn't rely on the value returned by this method to guess if a piece is an instance of DoorOrWindow class.

Specified by:

isDoorOrWindow in interface PieceOfFurniture

getIcon

public Content getIcon()

Returns the icon of this piece of furniture.

Specified by:

getIcon in interface PieceOfFurniture

getPlanIcon

public Content getPlanIcon()

Returns the icon of this piece of furniture displayed in plan or null.

Specified by:

getPlanIcon in interface PieceOfFurniture

Since:

2.2

getModel

public Content getModel()

Returns the 3D model of this piece of furniture.

Specified by:

getModel in interface PieceOfFurniture

getColor

public Integer getColor()

Returns the color of this piece of furniture.

Specified by:

getColor in interface PieceOfFurniture

Returns:

the color of the piece as RGB code or null if piece color is unchanged.

setColor

public void setColor(Integer color)

Sets the color of this piece of furniture or null if piece color is unchanged. Once this piece is updated, listeners added to this piece will receive a change notification.

getTexture

public HomeTexture getTexture()

Returns the texture of this piece of furniture.

Returns:

the texture of the piece or null if piece texture is unchanged.

Since:

2.3

setTexture

public void setTexture(HomeTexture texture)

Sets the texture of this piece of furniture or null if piece texture is unchanged. Once this piece is updated, listeners added to this piece will receive a change notification.

Since:

2.3

isResizable

public boolean isResizable()

Returns true if this piece is resizable.

Specified by:

isResizable in interface PieceOfFurniture

getPrice

public BigDecimal getPrice()

Returns the price of this piece of furniture or null.

Specified by:

getPrice in interface PieceOfFurniture

getValueAddedTaxPercentage

public BigDecimal getValueAddedTaxPercentage()

Returns the Value Added Tax percentage applied to the price of this piece of furniture.

Specified by:

getValueAddedTaxPercentage in interface PieceOfFurniture

getValueAddedTax

public BigDecimal getValueAddedTax()

Returns the Value Added Tax applied to the price of this piece of furniture.

getPriceValueAddedTaxIncluded

public BigDecimal getPriceValueAddedTaxIncluded()

Returns the price of this piece of furniture, Value Added Tax included.

isVisible

public boolean isVisible()

Returns true if this piece of furniture is visible.

setVisible

public void setVisible(boolean visible)

Sets whether this piece of furniture is visible or not. Once this piece is updated, listeners added to this piece will receive a change notification.

getX

public float getX()

Returns the abscissa of the center of this piece of furniture.

setX

public void setX(float x)

Sets the abscissa of the center of this piece. Once this piece is updated, listeners added to this piece will receive a change notification.

getY

public float getY()

Returns the ordinate of the center of this piece of furniture.

setY

public void setY(float y)

Sets the ordinate of the center of this piece. Once this piece is updated, listeners added to this piece will receive a change notification.

getAngle

public float getAngle()

Returns the angle in radians of this piece of furniture.

setAngle

public void setAngle(float angle)

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

isModelMirrored

public boolean isModelMirrored()

Returns true if the model of this piece should be mirrored.

setModelMirrored

public void setModelMirrored(boolean modelMirrored)

Sets whether the model of this piece of furniture is mirrored or not. Once this piece is updated, listeners added to this piece will receive a change notification.

Throws:

IllegalStateException - if this piece of furniture isn't resizable

getModelRotation

public float[][] getModelRotation()

Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.

Specified by:

getModelRotation in interface PieceOfFurniture

isBackFaceShown

public boolean isBackFaceShown()

Returns true if the back face of the piece of furniture model should be displayed.

Specified by:

isBackFaceShown in interface PieceOfFurniture

getPoints

public float[][] getPoints()

Returns the points of each corner of a piece.

Specified by:

getPoints in interface Selectable

Returns:

an array of the 4 (x,y) coordinates of the piece corners.

intersectsRectangle

public boolean intersectsRectangle(float x0,
                                   float y0,
                                   float x1,
                                   float y1)

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

Specified by:

intersectsRectangle in interface Selectable

containsPoint

public boolean containsPoint(float x,
                             float y,
                             float margin)

Returns true if this piece contains the point at (x, y) with a given margin.

Specified by:

containsPoint in interface Selectable

isPointAt

public boolean isPointAt(float x,
                         float y,
                         float margin)

Returns true if one of the corner of this piece is the point at (x, y) with a given margin.

isTopLeftPointAt

public boolean isTopLeftPointAt(float x,
                                float y,
                                float margin)

Returns true if the top left point of this piece is the point at (x, y) with a given margin.

isTopRightPointAt

public boolean isTopRightPointAt(float x,
                                 float y,
                                 float margin)

Returns true if the top right point of this piece is the point at (x, y) with a given margin.

isBottomLeftPointAt

public boolean isBottomLeftPointAt(float x,
                                   float y,
                                   float margin)

Returns true if the bottom left point of this piece is the point at (x, y) with a given margin.

isBottomRightPointAt

public boolean isBottomRightPointAt(float x,
                                    float y,
                                    float margin)

Returns true if the bottom right point of this piece is the point at (x, y) with a given margin.

isNameCenterPointAt

public boolean isNameCenterPointAt(float x,
                                   float y,
                                   float margin)

Returns true if the center point at which is displayed the name of this piece is equal to the point at (x, y) with a given margin.

move

public void move(float dx,
                 float dy)

Moves this piece of (dx, dy) units.

Specified by:

move in interface Selectable

clone

public HomePieceOfFurniture clone()

Returns a clone of this piece.

Specified by:

clone in interface Selectable

Overrides:

clone in class Object

getFurnitureComparator

public static Comparator<HomePieceOfFurniture> getFurnitureComparator(HomePieceOfFurniture.SortableProperty property)

Returns a comparator that compares furniture on a given property in ascending order.