Class Level

Extends HomeObject.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Level(id, name, elevation, floorThickness, height) Creates a home level.

Method Summary
Method Attributes	Method Name and Description
	clone() Returns a clone of this level.
	getBackgroundImage() Returns the plan background image of this level.
	getElevation() Returns the elevation of the bottom of this level.
	getElevationIndex() Returns the index of this level used to order levels at the same elevation.
	getFloorThickness() Returns the floor thickness of this level.
	getHeight() Returns the height of this level.
	getName() Returns the name of this level.
	isViewable() Returns `true` if this level is viewable.
	isViewableAndVisible() Returns `true` if this level is viewable and visible.
	isVisible() Returns `true` if this level is visible.
	setBackgroundImage(backgroundImage) Sets the plan background image of this level and fires a `PropertyChangeEvent`.
	setElevation(elevation) Sets the elevation of this level.
	setElevationIndex(elevationIndex) Sets the index of this level used to order levels at the same elevation.
	setFloorThickness(floorThickness) Sets the floor thickness of this level.
	setHeight(height) Sets the height of this level.
	setName(name) Sets the name of this level.
	setViewable(viewable) Sets whether this level is viewable or not.
	setVisible(visible) Sets whether this level is visible or not.

Methods borrowed from class HomeObject:: duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, setProperty

Class Detail

Level(id, name, elevation, floorThickness, height)

Creates a home level.
Author: Emmanuel Puybaret.

Parameters:
{string} id: the ID of the level
{string} name: the name of the level
{number} elevation: the elevation of the bottom of the level
{number} floorThickness: the floor thickness of the level
{number} height: the height of the level

Method Detail

{Level} clone()

Returns a clone of this level.

Returns:: {Level}

{BackgroundImage} getBackgroundImage()

Returns the plan background image of this level.

Returns:: {BackgroundImage}

{number} getElevation()

Returns the elevation of the bottom of this level.

Returns:: {number}

{number} getElevationIndex()

Returns the index of this level used to order levels at the same elevation.

Returns:: {number}

{number} getFloorThickness()

Returns the floor thickness of this level.

Returns:: {number}

{number} getHeight()

Returns the height of this level.

Returns:: {number}

{string} getName()

Returns the name of this level.

Returns:: {string}

{boolean} isViewable()

Returns true if this level is viewable.

Returns:: {boolean}

{boolean} isViewableAndVisible()

Returns true if this level is viewable and visible.

Returns:: {boolean}

{boolean} isVisible()

Returns true if this level is visible.

Returns:: {boolean}

setBackgroundImage(backgroundImage)

Sets the plan background image of this level and fires a PropertyChangeEvent.

Parameters:
{BackgroundImage} backgroundImage

setElevation(elevation)

Sets the elevation of this level. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{number} elevation

setElevationIndex(elevationIndex)

Sets the index of this level used to order levels at the same elevation.

Parameters:
{number} elevationIndex

setFloorThickness(floorThickness)

Sets the floor thickness of this level. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{number} floorThickness

setHeight(height)

Sets the height of this level. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{number} height

setName(name)

Sets the name of this level. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{string} name

setViewable(viewable)

Sets whether this level is viewable or not. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{boolean} viewable

setVisible(visible)

Sets whether this level is visible or not. Once this level is updated, listeners added to this level will receive a change notification.

Parameters:
{boolean} visible

	© Copyright 2024 Space Mushrooms Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:24 GMT+0200 (CEST)

Classes

Class Level