Class CatalogShelfUnit
Extends
CatalogPieceOfFurniture.
Defined in: SweetHome3D.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CatalogShelfUnit(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, elevation, dropOnTopElevation, shelfElevations, shelfBoxes, movable, staircaseCutOutShape, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, horizontallyRotatable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog shelf unit of the default catalog.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
|
|
|
Returns the elevation(s) at which other objects can be placed on this shelf unit.
|
- Methods borrowed from class 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
Class Detail
CatalogShelfUnit(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, elevation, dropOnTopElevation, shelfElevations, shelfBoxes, movable, staircaseCutOutShape, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, horizontallyRotatable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog shelf unit of the default catalog.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} id
- the id of the shelf unit or
null - {string} name
- the name of the shelf unit
- {string} description
- the description of the shelf unit
- {string} information
- additional information associated to the shelf unit
- {string} license
- license of the shelf unit
- {java.lang.String[]} tags
- tags associated to the shelf unit
- {number} creationDate
- creation date of the shelf unit in milliseconds since the epoch
- {number} grade
- grade of the piece of furniture or
null - {Object} icon
- content of the icon of the shelf unit
- {Object} planIcon
- content of the icon of the shelf unit displayed in plan
- {Object} model
- content of the 3D model of the shelf unit
- {number} width
- the width in centimeters of the shelf unit
- {number} depth
- the depth in centimeters of the shelf unit
- {number} height
- the height in centimeters of the shelf unit
- {number} elevation
- the elevation in centimeters of the shelf unit
- {number} dropOnTopElevation
- a percentage of the height at which should be placed an object dropped on the shelf unit
- {float[]} shelfElevations
- shelf elevation(s) at which other objects can be placed on the shelf unit
- {com.eteks.sweethome3d.model.BoxBounds[]} shelfBoxes
- coordinates of the shelf box(es) in which other objects can be placed in the shelf unit
- {boolean} movable
- if
true, the shelf unit is movable - {string} staircaseCutOutShape
- the shape used to cut out upper levels when they intersect with the piece like a staircase
- {float[][]} modelRotation
- the rotation 3 by 3 matrix applied to the piece model
- {number} modelFlags
- flags which should be applied to piece model
- {number} modelSize
- size of the 3D model of the shelf unit
- {string} creator
- the creator of the model
- {boolean} resizable
- if
true, the size of the shelf unit may be edited - {boolean} deformable
- if
true, the width, depth and height of the shelf unit may change independently from each other - {boolean} texturable
- if
falsethis piece should always keep the same color or texture - {boolean} horizontallyRotatable
- if
falsethis piece should not rotate around an horizontal axis - {Big} price
- the price of the shelf unit or
null - {Big} valueAddedTaxPercentage
- the Value Added Tax percentage applied to the
price of the shelf unit or
null - {string} currency
- the price currency, noted with ISO 4217 code, or
null - {Object} properties
- additional properties associating a key to a value or
null - {Object} contents
- additional contents associating a key to a value or
null
Method Detail
{com.eteks.sweethome3d.model.BoxBounds[]}
getShelfBoxes()
Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
- Returns:
- {com.eteks.sweethome3d.model.BoxBounds[]}
{float[]}
getShelfElevations()
Returns the elevation(s) at which other objects can be placed on this shelf unit.
- Returns:
- {float[]}
