Sweet Home 3D 3.4

com.eteks.sweethome3d.model
Interface PieceOfFurniture

All Known Subinterfaces:
DoorOrWindow, Light
All Known Implementing Classes:
CatalogDoorOrWindow, CatalogLight, CatalogPieceOfFurniture, HomeDoorOrWindow, HomeFurnitureGroup, HomeLight, HomePieceOfFurniture

public interface PieceOfFurniture

A piece of furniture.

Author:
Emmanuel Puybaret

Method Summary
 java.lang.Integer getColor()
          Returns the color of this piece of furniture.
 java.lang.String getCurrency()
          Returns the price currency, noted with ISO 4217 code, or null if it has no price or default currency should be used.
 float getDepth()
          Returns the depth of this piece of furniture.
 java.lang.String getDescription()
          Returns the description of this piece of furniture.
 float getElevation()
          Returns the elevation of this piece of furniture.
 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.
 java.lang.String getName()
          Returns the name of this piece of furniture.
 Content getPlanIcon()
          Returns the icon of this piece of furniture displayed in plan or null.
 java.math.BigDecimal getPrice()
          Returns the price of this piece of furniture or null.
 java.lang.String getStaircaseCutOutShape()
          Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
 java.math.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.
 boolean isBackFaceShown()
          Returns true if the back face of the piece of furniture model should be displayed.
 boolean isDeformable()
          Returns true if this piece is deformable.
 boolean isDoorOrWindow()
          Returns true if this piece of furniture is a door or a window.
 boolean isMovable()
          Returns true if this piece of furniture is movable.
 boolean isResizable()
          Returns true if this piece is resizable.
 boolean isTexturable()
          Returns false if this piece should always keep the same color or texture.
 

Method Detail

getName

java.lang.String getName()
Returns the name of this piece of furniture.


getDescription

java.lang.String getDescription()
Returns the description of this piece of furniture.


getDepth

float getDepth()
Returns the depth of this piece of furniture.


getHeight

float getHeight()
Returns the height of this piece of furniture.


getWidth

float getWidth()
Returns the width of this piece of furniture.


getElevation

float getElevation()
Returns the elevation of this piece of furniture.


isMovable

boolean isMovable()
Returns true if this piece of furniture is movable.


isDoorOrWindow

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


getIcon

Content getIcon()
Returns the icon of this piece of furniture.


getPlanIcon

Content getPlanIcon()
Returns the icon of this piece of furniture displayed in plan or null.

Since:
2.2

getModel

Content getModel()
Returns the 3D model of this piece of furniture.


getModelRotation

float[][] getModelRotation()
Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.


getStaircaseCutOutShape

java.lang.String getStaircaseCutOutShape()
Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.

Since:
3.4

isBackFaceShown

boolean isBackFaceShown()
Returns true if the back face of the piece of furniture model should be displayed.


getColor

java.lang.Integer getColor()
Returns the color of this piece of furniture.


isResizable

boolean isResizable()
Returns true if this piece is resizable.


isDeformable

boolean isDeformable()
Returns true if this piece is deformable. The width, depth and height of a deformable piece may change independently from each other.

Since:
3.0

isTexturable

boolean isTexturable()
Returns false if this piece should always keep the same color or texture.

Since:
3.0

getPrice

java.math.BigDecimal getPrice()
Returns the price of this piece of furniture or null.


getValueAddedTaxPercentage

java.math.BigDecimal getValueAddedTaxPercentage()
Returns the Value Added Tax percentage applied to the price of this piece of furniture.


getCurrency

java.lang.String getCurrency()
Returns the price currency, noted with ISO 4217 code, or null if it has no price or default currency should be used.

Since:
3.4

Sweet Home 3D 3.4

? Copyrights 2006-2011 eTeks - All rights reserved
Distributed under GNU General Public License