Class ObserverCameraController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	ObserverCameraController(home, preferences, viewFactory) Creates the controller of 3D view with undo support.

Method Summary
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.
	getElevation() Returns the edited camera elevation.
	getFieldOfView() Returns the edited observer field of view in radians.
	getFieldOfViewInDegrees() Returns the edited observer field of view in degrees.
	getMinimumElevation() Returns the minimum elevation.
	getPitch() Returns the edited pitch in radians.
	getPitchInDegrees() Returns the edited pitch in degrees.
	getView() Returns the view associated with this controller.
	getX() Returns the edited abscissa.
	getY() Returns the edited ordinate.
	getYaw() Returns the edited yaw in radians.
	getYawInDegrees() Returns the edited yaw in degrees.
	isElevationAdjusted() Returns `true` if the observer elevation should be adjusted according to the elevation of the selected level.
	isObserverCameraElevationAdjustedEditable() Returns `true` if the adjustment of the observer camera according to the current level is modifiable.
	modifyObserverCamera() Controls the modification of the observer camera of the edited home.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setElevation(elevation) Sets the edited camera elevation.
	setElevationAdjusted(observerCameraElevationAdjusted) Sets whether the observer elevation should be adjusted according to the elevation of the selected level.
	setX(x) Sets the edited abscissa.
	setY(y) Sets the edited ordinate.
	updateProperties() Updates edited properties from the 3D attributes of the home edited by this controller.

Class Detail

ObserverCameraController(home, preferences, viewFactory)

Creates the controller of 3D view with undo support.
Author: Emmanuel Puybaret.

Parameters:
{Home} home
{UserPreferences} preferences
{Object} viewFactory

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

{number} getElevation()

Returns the edited camera elevation.

Returns:: {number}

{number} getFieldOfView()

Returns the edited observer field of view in radians.

Returns:: {number}

{number} getFieldOfViewInDegrees()

Returns the edited observer field of view in degrees.

Returns:: {number}

{number} getMinimumElevation()

Returns the minimum elevation.

Returns:: {number}

{number} getPitch()

Returns the edited pitch in radians.

Returns:: {number}

{number} getPitchInDegrees()

Returns the edited pitch in degrees.

Returns:: {number}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{number} getX()

Returns the edited abscissa.

Returns:: {number}

{number} getY()

Returns the edited ordinate.

Returns:: {number}

{number} getYaw()

Returns the edited yaw in radians.

Returns:: {number}

{number} getYawInDegrees()

Returns the edited yaw in degrees.

Returns:: {number}

{boolean} isElevationAdjusted()

Returns true if the observer elevation should be adjusted according to the elevation of the selected level.

Returns:: {boolean}

{boolean} isObserverCameraElevationAdjustedEditable()

Returns true if the adjustment of the observer camera according to the current level is modifiable.

Returns:: {boolean}

modifyObserverCamera()

Controls the modification of the observer camera of the edited home.

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setElevation(elevation)

Sets the edited camera elevation.

Parameters:
{number} elevation

setElevationAdjusted(observerCameraElevationAdjusted)

Sets whether the observer elevation should be adjusted according to the elevation of the selected level.

Parameters:
{boolean} observerCameraElevationAdjusted

setX(x)

Sets the edited abscissa.

Parameters:
{number} x

setY(y)

Sets the edited ordinate.

Parameters:
{number} y

updateProperties()

Updates edited properties from the 3D attributes of the home edited by this controller.

	© 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 ObserverCameraController