Class Index | File Index

Classes


Class Camera


Extends HomeObject.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Camera(x, y, z, yaw, pitch, fieldOfView, time, lens)
Creates a camera at given location and angles.
Method Summary
Method Attributes Method Name and Description
 
Adds the property change listener in parameter to this camera.
 
Returns a clone of this camera.
<static>  
Camera.convertTimeToTimeZone(utcTime, timeZone)
Returns a time expressed in UTC time zone converted to the given time zone.
 
Returns the field of view in radians of this camera.
 
Returns the lens of this camera.
 
Returns the name of this camera.
 
Returns the pitch angle in radians of this camera.
 
Returns the time in milliseconds when this camera is used.
 
getX()
Returns the abscissa of this camera.
 
getY()
Returns the ordinate of this camera.
 
Returns the yaw angle in radians of this camera.
 
getZ()
Returns the elevation of this camera.
 
Removes the property change listener in parameter from this camera.
 
setCamera(camera)
Sets the location and angles of this camera from the camera in parameter.
 
setFieldOfView(fieldOfView)
Sets the field of view in radians of this camera and notifies listeners of this change.
 
setLens(lens)
Sets the lens of this camera and notifies listeners of this change.
 
setName(name)
Sets the name of this camera and notifies listeners of this change.
 
setPitch(pitch)
Sets the pitch angle in radians of this camera and notifies listeners of this change.
 
setTime(time)
Sets the use time in milliseconds since the Epoch in UTC time zone, and notifies listeners of this change.
 
setX(x)
Sets the abscissa of this camera and notifies listeners of this change.
 
setY(y)
Sets the ordinate of this camera and notifies listeners of this change.
 
setYaw(yaw)
Sets the yaw angle in radians of this camera and notifies listeners of this change.
 
setZ(z)
Sets the elevation of this camera and notifies listeners of this change.
Methods borrowed from class HomeObject:
getProperty, getPropertyNames, setProperty
Class Detail
Camera(x, y, z, yaw, pitch, fieldOfView, time, lens)
Creates a camera at given location and angles.
Author: Emmanuel Puybaret.
Parameters:
{number} x
{number} y
{number} z
{number} yaw
{number} pitch
{number} fieldOfView
{number} time
{Camera.Lens} lens
Method Detail
addPropertyChangeListener(listener)
Adds the property change listener in parameter to this camera.
Parameters:
{PropertyChangeListener} listener

{Camera} clone()
Returns a clone of this camera.
Returns:
{Camera}

<static> {number} Camera.convertTimeToTimeZone(utcTime, timeZone)
Returns a time expressed in UTC time zone converted to the given time zone.
Parameters:
{number} utcTime
{string} timeZone
Returns:
{number}

{number} getFieldOfView()
Returns the field of view in radians of this camera.
Returns:
{number}

{Camera.Lens} getLens()
Returns the lens of this camera.
Returns:
{Camera.Lens}

{string} getName()
Returns the name of this camera.
Returns:
{string}

{number} getPitch()
Returns the pitch angle in radians of this camera.
Returns:
{number}

{number} getTime()
Returns the time in milliseconds when this camera is used.
Returns:
{number} a time in milliseconds since the Epoch in UTC time zone

{number} getX()
Returns the abscissa of this camera.
Returns:
{number}

{number} getY()
Returns the ordinate of this camera.
Returns:
{number}

{number} getYaw()
Returns the yaw angle in radians of this camera.
Returns:
{number}

{number} getZ()
Returns the elevation of this camera.
Returns:
{number}

removePropertyChangeListener(listener)
Removes the property change listener in parameter from this camera.
Parameters:
{PropertyChangeListener} listener

setCamera(camera)
Sets the location and angles of this camera from the camera in parameter.
Parameters:
{Camera} camera

setFieldOfView(fieldOfView)
Sets the field of view in radians of this camera and notifies listeners of this change.
Parameters:
{number} fieldOfView

setLens(lens)
Sets the lens of this camera and notifies listeners of this change.
Parameters:
{Camera.Lens} lens

setName(name)
Sets the name of this camera and notifies listeners of this change.
Parameters:
{string} name

setPitch(pitch)
Sets the pitch angle in radians of this camera and notifies listeners of this change. Pitch axis is horizontal transverse axis.
Parameters:
{number} pitch

setTime(time)
Sets the use time in milliseconds since the Epoch in UTC time zone, and notifies listeners of this change.
Parameters:
{number} time

setX(x)
Sets the abscissa of this camera and notifies listeners of this change.
Parameters:
{number} x

setY(y)
Sets the ordinate of this camera and notifies listeners of this change.
Parameters:
{number} y

setYaw(yaw)
Sets the yaw angle in radians of this camera and notifies listeners of this change. Yaw axis is vertical axis.
Parameters:
{number} yaw

setZ(z)
Sets the elevation of this camera and notifies listeners of this change.
Parameters:
{number} z

© Copyrights 2017 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Oct 25 2017 16:36:08 GMT+0200 (CEST)