com.eteks.sweethome3d.model

Class CatalogShelfUnit

java.lang.Object

com.eteks.sweethome3d.model.CatalogPieceOfFurniture

com.eteks.sweethome3d.model.CatalogShelfUnit

All Implemented Interfaces:

CatalogItem, PieceOfFurniture, ShelfUnit, java.lang.Cloneable, java.lang.Comparable<CatalogPieceOfFurniture>

public class CatalogShelfUnit
extends CatalogPieceOfFurniture
implements ShelfUnit

A catalog piece of furniture.

Since:

7.2

Author:

Emmanuel Puybaret

Field Summary

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

CatalogShelfUnit(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String license, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, float[] shelfElevations, BoxBounds[] shelfBoxes, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, int modelFlags, java.lang.Long modelSize, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, boolean horizontallyRotatable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,Content> contents) Creates an unmodifiable catalog shelf unit of the default catalog.

Method Summary

Modifier and Type	Method and Description
BoxBounds[]	getShelfBoxes() Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
float[]	getShelfElevations() Returns the elevation(s) at which other objects can be placed on this shelf unit.

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

clone, compareTo, equals, getCategory, getColor, getContentProperty, getCreationDate, getCreator, getCurrency, getDepth, getDescription, getDropOnTopElevation, getElevation, getFilterCriteria, getGrade, getHeight, getIcon, getIconPitch, getIconScale, getIconYaw, getId, getInformation, getLicense, getModel, getModelFlags, getModelRotation, getModelSize, getName, getPlanIcon, getPrice, getProperty, getPropertyNames, getStaircaseCutOutShape, getTags, getValueAddedTaxPercentage, getWidth, hashCode, isBackFaceShown, isContentProperty, isDeformable, isDoorOrWindow, isHorizontallyRotatable, isModifiable, isMovable, isProportional, isResizable, isTexturable, isWidthDepthDeformable, matchesFilter

Methods inherited from class java.lang.Object

finalize, getClass, 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, isDoorOrWindow, isHorizontallyRotatable, isMovable, isResizable, isTexturable, isWidthDepthDeformable

Constructor Detail

CatalogShelfUnit

public CatalogShelfUnit(java.lang.String id,
                        java.lang.String name,
                        java.lang.String description,
                        java.lang.String information,
                        java.lang.String license,
                        java.lang.String[] tags,
                        java.lang.Long creationDate,
                        java.lang.Float grade,
                        Content icon,
                        Content planIcon,
                        Content model,
                        float width,
                        float depth,
                        float height,
                        float elevation,
                        float dropOnTopElevation,
                        float[] shelfElevations,
                        BoxBounds[] shelfBoxes,
                        boolean movable,
                        java.lang.String staircaseCutOutShape,
                        float[][] modelRotation,
                        int modelFlags,
                        java.lang.Long modelSize,
                        java.lang.String creator,
                        boolean resizable,
                        boolean deformable,
                        boolean texturable,
                        boolean horizontallyRotatable,
                        java.math.BigDecimal price,
                        java.math.BigDecimal valueAddedTaxPercentage,
                        java.lang.String currency,
                        java.util.Map<java.lang.String,java.lang.String> properties,
                        java.util.Map<java.lang.String,Content> contents)

Creates an unmodifiable catalog shelf unit of the default catalog.

Parameters:

id - the id of the shelf unit or null

name - the name of the shelf unit

description - the description of the shelf unit

information - additional information associated to the shelf unit

license - license of the shelf unit

tags - tags associated to the shelf unit

creationDate - creation date of the shelf unit in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the shelf unit

planIcon - content of the icon of the shelf unit displayed in plan

model - content of the 3D model of the shelf unit

width - the width in centimeters of the shelf unit

depth - the depth in centimeters of the shelf unit

height - the height in centimeters of the shelf unit

elevation - the elevation in centimeters of the shelf unit

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the shelf unit

shelfElevations - shelf elevation(s) at which other objects can be placed on the shelf unit

shelfBoxes - coordinates of the shelf box(es) in which other objects can be placed in the shelf unit

movable - if true, the shelf unit is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

modelFlags - flags which should be applied to piece model

modelSize - size of the 3D model of the shelf unit

creator - the creator of the model

resizable - if true, the size of the shelf unit may be edited

deformable - if true, the width, depth and height of the shelf unit may change independently from each other

texturable - if false this piece should always keep the same color or texture

horizontallyRotatable - if false this piece should not rotate around an horizontal axis

price - the price of the shelf unit or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the shelf unit or null

currency - the price currency, noted with ISO 4217 code, or null

properties - additional properties associating a key to a value or null

contents - additional contents associating a key to a value or null

Method Detail

getShelfElevations

public float[] getShelfElevations()

Returns the elevation(s) at which other objects can be placed on this shelf unit.

Specified by:

getShelfElevations in interface ShelfUnit

getShelfBoxes

public BoxBounds[] getShelfBoxes()

Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.

Specified by:

getShelfBoxes in interface ShelfUnit