CatalogPieceOfFurniture (Sweet Home 3D 4.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Sweet Home 3D 4.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.eteks.sweethome3d.model
Class CatalogPieceOfFurniture

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

All Implemented Interfaces:: PieceOfFurniture, Comparable<CatalogPieceOfFurniture>

Direct Known Subclasses:: CatalogDoorOrWindow, CatalogLight

public class CatalogPieceOfFurniture
extends Object
implements Comparable<CatalogPieceOfFurniture>, PieceOfFurniture
extends Object
implements Comparable<CatalogPieceOfFurniture>, PieceOfFurniture

A catalog piece of furniture.

Author:: Emmanuel Puybaret

Constructor Summary
`CatalogPieceOfFurniture(String name, Content icon, Content model, float width, float depth, float height, boolean movable, boolean doorOrWindow)` Deprecated. As of version 1.7, use constructor without `doorOrWindow` parameter since a catalog door and window is supposed to be an instance of `CatalogDoorOrWindow`
`CatalogPieceOfFurniture(String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, boolean doorOrWindow, Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional)` Deprecated. As of version 1.7, use constructor without `doorOrWindow` parameter since a catalog door and window is supposed to be an instance of `CatalogDoorOrWindow`
`CatalogPieceOfFurniture(String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional)` Creates a modifiable catalog piece of furniture with all its values.
`CatalogPieceOfFurniture(String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, String staircaseCutOutShape, Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional)` Creates a modifiable catalog piece of furniture with all its values.
`CatalogPieceOfFurniture(String id, String name, String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, String creator, boolean resizable, BigDecimal price, BigDecimal valueAddedTaxPercentage)` Creates an unmodifiable catalog piece of furniture of the default catalog.
`CatalogPieceOfFurniture(String id, String name, String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, String creator, boolean resizable, boolean deformable, boolean texturable, BigDecimal price, BigDecimal valueAddedTaxPercentage)` Creates an unmodifiable catalog piece of furniture of the default catalog.
`CatalogPieceOfFurniture(String id, String name, String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, String staircaseCutOutShape, float[][] modelRotation, String creator, boolean resizable, boolean deformable, boolean texturable, BigDecimal price, BigDecimal valueAddedTaxPercentage, String currency)` Creates an unmodifiable catalog piece of furniture of the default catalog.
`CatalogPieceOfFurniture(String id, String name, String description, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, boolean doorOrWindow, float[][] modelRotation, String creator, boolean resizable, BigDecimal price, BigDecimal valueAddedTaxPercentage)` Deprecated. As of version 1.7, use constructor without `doorOrWindow` parameter since a catalog door and window is supposed to be an instance of `CatalogDoorOrWindow`
`CatalogPieceOfFurniture(String id, String name, String description, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, String creator, boolean resizable, BigDecimal price, BigDecimal valueAddedTaxPercentage)` Creates an unmodifiable catalog piece of furniture of the default catalog.
`CatalogPieceOfFurniture(String id, String name, String description, String information, String[] tags, Long creationDate, Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, String staircaseCutOutShape, float[][] modelRotation, String creator, boolean resizable, boolean deformable, boolean texturable, BigDecimal price, BigDecimal valueAddedTaxPercentage, String currency)` Creates an unmodifiable catalog piece of furniture of the default catalog.

Method Summary
`int`	`compareTo(CatalogPieceOfFurniture piece)` Compares the names of this piece and the one in parameter.
`boolean`	`equals(Object obj)` Returns `true` if this piece and the one in parameter are the same objects.
`FurnitureCategory`	`getCategory()` Returns the category of this piece of furniture.
`Integer`	`getColor()` Returns the color of this piece of furniture.
`Long`	`getCreationDate()` Returns the creation date of this piece in milliseconds since the epoch, or `null` if no date is given to this piece.
`String`	`getCreator()` Returns the creator of this piece.
`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.
`String`	`getDescription()` Returns the description of this piece of furniture.
`float`	`getElevation()` Returns the elevation of this piece of furniture.
`Float`	`getGrade()` Returns the grade of this piece, or `null` if no grade is given to this piece.
`float`	`getHeight()` Returns the height of this piece of furniture.
`Content`	`getIcon()` Returns the icon of this piece of furniture.
`float`	`getIconYaw()` Returns the yaw angle used to create the piece icon.
`String`	`getId()` Returns the ID of this piece of furniture or `null`.
`String`	`getInformation()` Returns the additional information associated to this piece, or `null`.
`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.
`Content`	`getPlanIcon()` Returns the icon of this piece of furniture displayed in plan or `null`.
`BigDecimal`	`getPrice()` Returns the price of this piece of furniture or `null`.
`String`	`getStaircaseCutOutShape()` Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
`String[]`	`getTags()` Returns the tags associated to this piece.
`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.
`int`	`hashCode()` Returns default hash code.
`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`	`isModifiable()` Returns `true` if this piece is modifiable (not read from resources).
`boolean`	`isMovable()` Returns `true` if this piece of furniture is movable.
`boolean`	`isProportional()` Returns `true` if size proportions should be kept.
`boolean`	`isResizable()` Returns `true` if this piece is resizable.
`boolean`	`isTexturable()` Returns `false` if this piece should always keep the same color or texture.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               boolean movable,
                               boolean doorOrWindow)

Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow

Creates a catalog piece of furniture.

Parameters:: name - the name of the new piece; icon - content of the icon of the new piece; model - content of the 3D model of the new piece; width - the width in centimeters of the new piece; depth - the depth in centimeters of the new piece; height - the height in centimeters of the new piece; movable - if true, the new piece is movable; doorOrWindow - if true, the new piece is a door or a window

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(String id,
                               String name,
                               String description,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               boolean doorOrWindow,
                               float[][] modelRotation,
                               String creator,
                               boolean resizable,
                               BigDecimal price,
                               BigDecimal valueAddedTaxPercentage)

Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow