Class CatalogDoorOrWindow
Extends
CatalogPieceOfFurniture.
Defined in: SweetHome3D.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CatalogDoorOrWindow(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, elevation, dropOnTopElevation, movable, cutOutShape, wallThickness, wallDistance, wallCutOutOnBothSides, widthDepthDeformable, sashes, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog door or window of the default catalog.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the shape used to cut out walls that intersect this new door or window.
|
|
|
Returns a copy of the sashes attached to this door or window.
|
|
|
Returns the default distance that should lie at the back side of this door or window.
|
|
|
Returns the default thickness of the wall in which this door or window should be placed.
|
|
|
Returns always
true. |
|
|
Returns always
false. |
|
|
Returns
true if this door or window should cut out the both sides
of the walls it intersects, even if its front or back side are within the wall thickness. |
|
|
Returns
false if the width and depth of the new door or window may
not be changed independently from each other. |
- 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, isModifiable, isMovable, isProportional, isResizable, isTexturable, matchesFilter
Class Detail
CatalogDoorOrWindow(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, elevation, dropOnTopElevation, movable, cutOutShape, wallThickness, wallDistance, wallCutOutOnBothSides, widthDepthDeformable, sashes, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog door or window of the default catalog.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} id
- the id of the new door or window, or
null - {string} name
- the name of the new door or window
- {string} description
- the description of the new door or window
- {string} information
- additional information associated to the new door or window
- {string} license
- license of the new door or window
- {java.lang.String[]} tags
- tags associated to the new door or window
- {number} creationDate
- creation date of the new door or window in milliseconds since the epoch
- {number} grade
- grade of the new door or window or
null - {Object} icon
- content of the icon of the new door or window
- {Object} planIcon
- content of the icon of the new piece displayed in plan
- {Object} model
- content of the 3D model of the new door or window
- {number} width
- the width in centimeters of the new door or window
- {number} depth
- the depth in centimeters of the new door or window
- {number} height
- the height in centimeters of the new door or window
- {number} elevation
- the elevation in centimeters of the new door or window
- {number} dropOnTopElevation
- a percentage of the height at which should be placed an object dropped on the new piece
- {boolean} movable
- if
true, the new door or window is movable - {string} cutOutShape
- the shape used to cut out walls that intersect the new door or window
- {number} wallThickness
- a value in percentage of the depth of the new door or window
- {number} wallDistance
- a distance in percentage of the depth of the new door or window
- {boolean} wallCutOutOnBothSides
- if
truethe new door or window should cut out the both sides of the walls it intersects - {boolean} widthDepthDeformable
- if
false, the width and depth of the new door or window may not be changed independently from each other - {com.eteks.sweethome3d.model.Sash[]} sashes
- the sashes attached to the new door or window
- {float[][]} modelRotation
- the rotation 3 by 3 matrix applied to the door or window model
- {number} modelFlags
- flags which should be applied to piece model
- {number} modelSize
- size of the 3D model of the new light
- {string} creator
- the creator of the model
- {boolean} resizable
- if
true, the size of the new door or window may be edited - {boolean} deformable
- if
true, the width, depth and height of the new piece may change independently from each other - {boolean} texturable
- if
falsethis piece should always keep the same color or texture. - {Big} price
- the price of the new door or window, or
null - {Big} valueAddedTaxPercentage
- the Value Added Tax percentage applied to the
price of the new door or window 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
{string}
getCutOutShape()
Returns the shape used to cut out walls that intersect this new door or window.
- Returns:
- {string}
{com.eteks.sweethome3d.model.Sash[]}
getSashes()
Returns a copy of the sashes attached to this door or window.
If no sash is defined an empty array is returned.
- Returns:
- {com.eteks.sweethome3d.model.Sash[]}
{number}
getWallDistance()
Returns the default distance that should lie at the back side of this door or window.
- Returns:
- {number} a distance in percentage of the depth of the door or the window.
{number}
getWallThickness()
Returns the default thickness of the wall in which this door or window should be placed.
- Returns:
- {number} a value in percentage of the depth of the door or the window.
{boolean}
isDoorOrWindow()
Returns always
true.
- Returns:
- {boolean}
{boolean}
isHorizontallyRotatable()
Returns always
false.
- Returns:
- {boolean}
{boolean}
isWallCutOutOnBothSides()
Returns
true if this door or window should cut out the both sides
of the walls it intersects, even if its front or back side are within the wall thickness.
- Returns:
- {boolean}
{boolean}
isWidthDepthDeformable()
Returns
false if the width and depth of the new door or window may
not be changed independently from each other.
- Returns:
- {boolean}
