Class CatalogLight
Extends
CatalogPieceOfFurniture.
Defined in: SweetHome3D.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CatalogLight(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, dropOnTopElevation, elevation, movable, lightSources, lightSourceMaterialNames, staircaseCutOutShape, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, horizontallyRotatable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog light of the default catalog.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the material names of the light sources in the 3D model managed by this light.
|
|
|
Returns the sources managed by this light.
|
- 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
CatalogLight(id, name, description, information, license, tags, creationDate, grade, icon, planIcon, model, width, depth, height, dropOnTopElevation, elevation, movable, lightSources, lightSourceMaterialNames, staircaseCutOutShape, modelRotation, modelFlags, modelSize, creator, resizable, deformable, texturable, horizontallyRotatable, price, valueAddedTaxPercentage, currency, properties, contents)
Creates a catalog light of the default catalog.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} id
- the id of the new light, or
null - {string} name
- the name of the new light
- {string} description
- the description of the new light
- {string} information
- additional information associated to the new light
- {string} license
- license of the new light
- {java.lang.String[]} tags
- tags associated to the new light
- {number} creationDate
- creation date of the new light in milliseconds since the epoch
- {number} grade
- grade of the new light or
null - {Object} icon
- content of the icon of the new light
- {Object} planIcon
- content of the icon of the new piece displayed in plan
- {Object} model
- content of the 3D model of the new light
- {number} width
- the width in centimeters of the new light
- {number} depth
- the depth in centimeters of the new light
- {number} height
- the height in centimeters of the new light
- {number} dropOnTopElevation
- a percentage of the height at which should be placed an object dropped on the new piece
- {number} elevation
- the elevation in centimeters of the new light
- {boolean} movable
- if
true, the new light is movable - {com.eteks.sweethome3d.model.LightSource[]} lightSources
- the light sources of the new light
- {java.lang.String[]} lightSourceMaterialNames
- the material names of the light source in the 3D model of the new light
- {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 light 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 light 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 - {boolean} horizontallyRotatable
- if
falsethis piece should not rotate around an horizontal axis - {Big} price
- the price of the new light, or
null - {Big} valueAddedTaxPercentage
- the Value Added Tax percentage applied to the
price of the new light 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
{java.lang.String[]}
getLightSourceMaterialNames()
Returns the material names of the light sources in the 3D model managed by this light.
- Returns:
- {java.lang.String[]} a copy of light source material names array.
{com.eteks.sweethome3d.model.LightSource[]}
getLightSources()
Returns the sources managed by this light. Each light source point
is a percentage of the width, the depth and the height of this light,
with the abscissa origin at the left side of the piece,
the ordinate origin at the front side of the piece
and the elevation origin at the bottom side of the piece.
- Returns:
- {com.eteks.sweethome3d.model.LightSource[]} a copy of light sources array.
