Class HomeFurnitureController
Defined in: SweetHome3D.js.
Constructor Attributes | Constructor Name and Description |
---|---|
HomeFurnitureController(home, preferences, viewFactory, contentManager, undoSupport)
Creates the controller of home furniture view with undo support.
|
Method Attributes | Method Name and Description |
---|---|
addPropertyChangeListener(property, listener)
Adds the property change
listener in parameter to this controller. |
|
displayView(parentView)
Displays the view controlled by this controller.
|
|
Returns additional edited properties.
|
|
getAngle()
Returns the edited angle in radians.
|
|
Returns the edited angle in degrees.
|
|
Returns whether furniture is a base plan item or not.
|
|
getColor()
Returns the edited color.
|
|
Returns the content manager associated to this controller.
|
|
getDepth()
Returns the edited depth.
|
|
Returns the edited description.
|
|
Returns the edited elevation.
|
|
Returns the edited height.
|
|
Returns the edited horizontal axis.
|
|
getIcon()
Returns the edited icon.
|
|
Returns the edited light power.
|
|
Returns the model materials controller of the piece.
|
|
Returns whether furniture model is mirrored or not.
|
|
Returns the preset model transformations at the given
index . |
|
Returns the names of the available preset model transformations.
|
|
Returns model transformations.
|
|
getName()
Returns the edited name.
|
|
Returns whether furniture name should be drawn or not.
|
|
getPaint()
Returns whether the piece is colored, textured, uses customized materials or unknown painted.
|
|
getPitch()
Returns the edited pitch in radians.
|
|
getPrice()
Returns the edited price.
|
|
getRoll()
Returns the edited roll angle in radians.
|
|
Returns whether the piece is shininess is the default one, matt, shiny or unknown.
|
|
Returns the texture controller of the piece.
|
|
Returns edited Value Added Tax percentage.
|
|
getView()
Returns the view associated with this controller.
|
|
Returns whether furniture is visible or not.
|
|
getWidth()
Returns the edited width.
|
|
getX()
Returns the edited abscissa.
|
|
getY()
Returns the edited ordinate.
|
|
Returns
true if base plan item is an enabled property. |
|
Returns
true if base plan item is an enabled property. |
|
Returns whether furniture model can be deformed or not.
|
|
Returns
true if light power is an editable property. |
|
Returns whether the price can be edited or not.
|
|
isPropertyEditable(property)
Returns
true if the given property is editable. |
|
Returns whether furniture proportions should be kept or not.
|
|
Returns whether furniture model can be resized or not.
|
|
Returns whether roll and pitch angles can be edited.
|
|
Returns whether the color or the texture of the furniture model can be changed or not.
|
|
Returns whether the Value Added Tax percentage can be edited or not.
|
|
Controls the modification of selected furniture in the edited home.
|
|
removePropertyChangeListener(property, listener)
Removes the property change
listener in parameter from this controller. |
|
setAdditionalProperties(additionalProperties)
Sets additional edited properties.
|
|
setBasePlanItem(basePlanItem)
Sets whether furniture is a base plan item or not.
|
|
setColor(color)
Sets the edited color.
|
|
setDescription(description)
Sets the edited description.
|
|
setElevation(elevation)
Sets the edited elevation.
|
|
setHorizontalAxis(horizontalAxis)
Sets the edited horizontal axis.
|
|
setLightPower(lightPower)
Sets the edited light power.
|
|
setModelMirrored(modelMirrored)
Sets whether furniture model is mirrored or not.
|
|
setModelTransformations(transformations, x, y, elevation, width, depth, height)
Sets model transformations and updated dimensions of the edited piece.
|
|
setName(name)
Sets the edited name.
|
|
setNameVisible(nameVisible)
Sets whether furniture name is visible or not.
|
|
setPaint(paint)
Sets whether the piece is colored, textured, uses customized materials or unknown painted.
|
|
setPitch(pitch)
Sets the edited pitch in radians.
|
|
setProportional(proportional)
Sets whether furniture proportions should be kept.
|
|
setRoll(roll)
Sets the edited roll angle in radians.
|
|
setShininess(shininess)
Sets whether the piece shininess is the default one, matt, shiny or unknown.
|
|
setValueAddedTaxPercentage(valueAddedTaxPercentage)
Sets the edited Value Added Tax percentage.
|
|
setVisible(visible)
Sets whether furniture is visible or not.
|
|
setX(x)
Sets the edited abscissa.
|
|
setY(y)
Sets the edited ordinate.
|
|
Updates edited properties from selected furniture in the home edited by this controller.
|
Class Detail
HomeFurnitureController(home, preferences, viewFactory, contentManager, undoSupport)
Creates the controller of home furniture view with undo support.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {Home} home
- {UserPreferences} preferences
- {Object} viewFactory
- {Object} contentManager
- {javax.swing.undo.UndoableEditSupport} undoSupport
Method Detail
addPropertyChangeListener(property, listener)
Adds the property change
listener
in parameter to this controller.
- Parameters:
- {string} property
- {PropertyChangeListener} listener
displayView(parentView)
Displays the view controlled by this controller.
- Parameters:
- {Object} parentView
{Object}
getAdditionalProperties()
Returns additional edited properties.
- Returns:
- {Object}
{number}
getAngle()
Returns the edited angle in radians.
- Returns:
- {number}
{number}
getAngleInDegrees()
Returns the edited angle in degrees.
- Returns:
- {number}
{boolean}
getBasePlanItem()
Returns whether furniture is a base plan item or not.
- Returns:
- {boolean}
{number}
getColor()
Returns the edited color.
- Returns:
- {number}
{Object}
getContentManager()
Returns the content manager associated to this controller.
- Returns:
- {Object}
{number}
getDepth()
Returns the edited depth.
- Returns:
- {number}
{string}
getDescription()
Returns the edited description.
- Returns:
- {string}
{number}
getElevation()
Returns the edited elevation.
- Returns:
- {number}
{number}
getHeight()
Returns the edited height.
- Returns:
- {number}
{HomeFurnitureController.FurnitureHorizontalAxis}
getHorizontalAxis()
Returns the edited horizontal axis.
- Returns:
- {HomeFurnitureController.FurnitureHorizontalAxis}
{Object}
getIcon()
Returns the edited icon.
- Returns:
- {Object}
{number}
getLightPower()
Returns the edited light power.
- Returns:
- {number}
{ModelMaterialsController}
getModelMaterialsController()
Returns the model materials controller of the piece.
- Returns:
- {ModelMaterialsController}
{boolean}
getModelMirrored()
Returns whether furniture model is mirrored or not.
- Returns:
- {boolean}
{com.eteks.sweethome3d.model.Transformation[]}
getModelPresetTransformations(index)
Returns the preset model transformations at the given
index
.
- Parameters:
- {number} index
- Returns:
- {com.eteks.sweethome3d.model.Transformation[]}
{string[]}
getModelPresetTransformationsNames()
Returns the names of the available preset model transformations.
- Returns:
- {string[]}
{com.eteks.sweethome3d.model.Transformation[]}
getModelTransformations()
Returns model transformations.
- Returns:
- {com.eteks.sweethome3d.model.Transformation[]}
{string}
getName()
Returns the edited name.
- Returns:
- {string}
{boolean}
getNameVisible()
Returns whether furniture name should be drawn or not.
- Returns:
- {boolean}
{HomeFurnitureController.FurniturePaint}
getPaint()
Returns whether the piece is colored, textured, uses customized materials or unknown painted.
- Returns:
- {HomeFurnitureController.FurniturePaint}
{number}
getPitch()
Returns the edited pitch in radians.
- Returns:
- {number}
{Big}
getPrice()
Returns the edited price.
- Returns:
- {Big}
{number}
getRoll()
Returns the edited roll angle in radians.
- Returns:
- {number}
{HomeFurnitureController.FurnitureShininess}
getShininess()
Returns whether the piece is shininess is the default one, matt, shiny or unknown.
- Returns:
- {HomeFurnitureController.FurnitureShininess}
{TextureChoiceController}
getTextureController()
Returns the texture controller of the piece.
- Returns:
- {TextureChoiceController}
{Big}
getValueAddedTaxPercentage()
Returns edited Value Added Tax percentage.
- Returns:
- {Big}
{Object}
getView()
Returns the view associated with this controller.
- Returns:
- {Object}
{boolean}
getVisible()
Returns whether furniture is visible or not.
- Returns:
- {boolean}
{number}
getWidth()
Returns the edited width.
- Returns:
- {number}
{number}
getX()
Returns the edited abscissa.
- Returns:
- {number}
{number}
getY()
Returns the edited ordinate.
- Returns:
- {number}
{boolean}
isBasePlanItemEditable()
Returns
true
if base plan item is an enabled property.
- Deprecated:
-
the method is wrongly named and should be replaced by
isBasePlanItemEnabled
.
- Returns:
- {boolean}
{boolean}
isBasePlanItemEnabled()
Returns
true
if base plan item is an enabled property.
- Returns:
- {boolean}
{boolean}
isDeformable()
Returns whether furniture model can be deformed or not.
- Returns:
- {boolean}
{boolean}
isLightPowerEditable()
Returns
true
if light power is an editable property.
- Returns:
- {boolean}
{boolean}
isPriceEditable()
Returns whether the price can be edited or not.
- Returns:
- {boolean}
{boolean}
isPropertyEditable(property)
Returns
true
if the given property
is editable.
Depending on whether a property is editable or not, the view associated to this controller
may render it differently.
- Parameters:
- {string} property
- Returns:
- {boolean}
{boolean}
isProportional()
Returns whether furniture proportions should be kept or not.
- Returns:
- {boolean}
{boolean}
isResizable()
Returns whether furniture model can be resized or not.
- Returns:
- {boolean}
{boolean}
isRollAndPitchEditable()
Returns whether roll and pitch angles can be edited.
- Returns:
- {boolean}
{boolean}
isTexturable()
Returns whether the color or the texture of the furniture model can be changed or not.
- Returns:
- {boolean}
{boolean}
isValueAddedTaxPercentageEditable()
Returns whether the Value Added Tax percentage can be edited or not.
- Returns:
- {boolean}
modifyFurniture()
Controls the modification of selected furniture in the edited home.
removePropertyChangeListener(property, listener)
Removes the property change
listener
in parameter from this controller.
- Parameters:
- {string} property
- {PropertyChangeListener} listener
setAdditionalProperties(additionalProperties)
Sets additional edited properties.
- Parameters:
- {Object} additionalProperties
setBasePlanItem(basePlanItem)
Sets whether furniture is a base plan item or not.
- Parameters:
- {boolean} basePlanItem
setColor(color)
Sets the edited color.
- Parameters:
- {number} color
setDescription(description)
Sets the edited description.
- Parameters:
- {string} description
setElevation(elevation)
Sets the edited elevation.
- Parameters:
- {number} elevation
setHorizontalAxis(horizontalAxis)
Sets the edited horizontal axis.
- Parameters:
- {HomeFurnitureController.FurnitureHorizontalAxis} horizontalAxis
setLightPower(lightPower)
Sets the edited light power.
- Parameters:
- {number} lightPower
setModelMirrored(modelMirrored)
Sets whether furniture model is mirrored or not.
- Parameters:
- {boolean} modelMirrored
setModelTransformations(transformations, x, y, elevation, width, depth, height)
Sets model transformations and updated dimensions of the edited piece.
- Parameters:
- {com.eteks.sweethome3d.model.Transformation[]} transformations
- {number} x
- {number} y
- {number} elevation
- {number} width
- {number} depth
- {number} height
setName(name)
Sets the edited name.
- Parameters:
- {string} name
setNameVisible(nameVisible)
Sets whether furniture name is visible or not.
- Parameters:
- {boolean} nameVisible
setPaint(paint)
Sets whether the piece is colored, textured, uses customized materials or unknown painted.
- Parameters:
- {HomeFurnitureController.FurniturePaint} paint
setPitch(pitch)
Sets the edited pitch in radians.
- Parameters:
- {number} pitch
setProportional(proportional)
Sets whether furniture proportions should be kept.
- Parameters:
- {boolean} proportional
setRoll(roll)
Sets the edited roll angle in radians.
- Parameters:
- {number} roll
setShininess(shininess)
Sets whether the piece shininess is the default one, matt, shiny or unknown.
- Parameters:
- {HomeFurnitureController.FurnitureShininess} shininess
setValueAddedTaxPercentage(valueAddedTaxPercentage)
Sets the edited Value Added Tax percentage.
- Parameters:
- {Big} valueAddedTaxPercentage
setVisible(visible)
Sets whether furniture is visible or not.
- Parameters:
- {boolean} visible
setX(x)
Sets the edited abscissa.
- Parameters:
- {number} x
setY(y)
Sets the edited ordinate.
- Parameters:
- {number} y
updateProperties()
Updates edited properties from selected furniture in the home edited by this controller.