com.eteks.sweethome3d.model

Class Camera

java.lang.Object

com.eteks.sweethome3d.model.HomeObject

com.eteks.sweethome3d.model.Camera

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ObserverCamera

public class Camera
extends HomeObject

Camera characteristics in home.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Camera.Lens The kind of lens that can be used with a camera.
static class	Camera.Property The properties of a camera that may change.

Constructor Summary

Constructors

Constructor and Description
Camera(float x, float y, float z, float yaw, float pitch, float fieldOfView) Creates a camera at given location and angles at midday and using a pinhole lens.
Camera(float x, float y, float z, float yaw, float pitch, float fieldOfView, long time, Camera.Lens lens) Creates a camera at given location and angles.
Camera(java.lang.String id, float x, float y, float z, float yaw, float pitch, float fieldOfView) Creates a camera at given location and angles at midday and using a pinhole lens.
Camera(java.lang.String id, float x, float y, float z, float yaw, float pitch, float fieldOfView, long time, Camera.Lens lens) Creates a camera at given location and angles.

Method Summary

Modifier and Type	Method and Description
Camera	clone() Returns a clone of this camera.
static long	convertTimeToTimeZone(long utcTime, java.lang.String timeZone) Returns a time expressed in UTC time zone converted to the given time zone.
float	getFieldOfView() Returns the field of view in radians of this camera.
Camera.Lens	getLens() Returns the lens of this camera.
java.lang.String	getName() Returns the name of this camera.
float	getPitch() Returns the pitch angle in radians of this camera.
java.lang.String	getRenderer() Returns the rendering engine used to create photos.
long	getTime() Returns the time in milliseconds when this camera is used.
float	getX() Returns the abscissa of this camera.
float	getY() Returns the ordinate of this camera.
float	getYaw() Returns the yaw angle in radians of this camera.
float	getZ() Returns the elevation of this camera.
void	setCamera(Camera camera) Sets the location and angles of this camera from the camera in parameter.
void	setFieldOfView(float fieldOfView) Sets the field of view in radians of this camera and notifies listeners of this change.
void	setLens(Camera.Lens lens) Sets the lens of this camera and notifies listeners of this change.
void	setName(java.lang.String name) Sets the name of this camera and notifies listeners of this change.
void	setPitch(float pitch) Sets the pitch angle in radians of this camera and notifies listeners of this change.
void	setRenderer(java.lang.String renderer) Sets the rendering engine used to create photos.
void	setTime(long time) Sets the use time in milliseconds since the Epoch in UTC time zone, and notifies listeners of this change.
void	setX(float x) Sets the abscissa of this camera and notifies listeners of this change.
void	setY(float y) Sets the ordinate of this camera and notifies listeners of this change.
void	setYaw(float yaw) Sets the yaw angle in radians of this camera and notifies listeners of this change.
void	setZ(float z) Sets the elevation of this camera and notifies listeners of this change.

Methods inherited from class com.eteks.sweethome3d.model.HomeObject

addPropertyChangeListener, addPropertyChangeListener, createId, duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, removePropertyChangeListener, removePropertyChangeListener, setProperty, setProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Camera

public Camera(float x,
              float y,
              float z,
              float yaw,
              float pitch,
              float fieldOfView)

Creates a camera at given location and angles at midday and using a pinhole lens.

Camera

public Camera(java.lang.String id,
              float x,
              float y,
              float z,
              float yaw,
              float pitch,
              float fieldOfView)

Creates a camera at given location and angles at midday and using a pinhole lens.

Since:

6.4

Camera

public Camera(float x,
              float y,
              float z,
              float yaw,
              float pitch,
              float fieldOfView,
              long time,
              Camera.Lens lens)

Creates a camera at given location and angles.

Since:

3.0

Camera

public Camera(java.lang.String id,
              float x,
              float y,
              float z,
              float yaw,
              float pitch,
              float fieldOfView,
              long time,
              Camera.Lens lens)

Creates a camera at given location and angles.

Since:

6.4

Method Detail

getName

public java.lang.String getName()

Returns the name of this camera.

Since:

3.0

setName

public void setName(java.lang.String name)

Sets the name of this camera and notifies listeners of this change.

Since:

3.0

getYaw

public float getYaw()

Returns the yaw angle in radians of this camera.

setYaw

public void setYaw(float yaw)

Sets the yaw angle in radians of this camera and notifies listeners of this change. Yaw axis is vertical axis.

getPitch

public float getPitch()

Returns the pitch angle in radians of this camera.

setPitch

public void setPitch(float pitch)

Sets the pitch angle in radians of this camera and notifies listeners of this change. Pitch axis is horizontal transverse axis.

getFieldOfView

public float getFieldOfView()

Returns the field of view in radians of this camera.

setFieldOfView

public void setFieldOfView(float fieldOfView)

Sets the field of view in radians of this camera and notifies listeners of this change.

getX

public float getX()

Returns the abscissa of this camera.

setX

public void setX(float x)

Sets the abscissa of this camera and notifies listeners of this change.

getY

public float getY()

Returns the ordinate of this camera.

setY

public void setY(float y)

Sets the ordinate of this camera and notifies listeners of this change.

getZ

public float getZ()

Returns the elevation of this camera.

setZ

public void setZ(float z)

Sets the elevation of this camera and notifies listeners of this change.

getTime

public long getTime()

Returns the time in milliseconds when this camera is used.

Returns:

a time in milliseconds since the Epoch in UTC time zone

Since:

3.0

setTime

public void setTime(long time)

Sets the use time in milliseconds since the Epoch in UTC time zone, and notifies listeners of this change.

Since:

3.0

convertTimeToTimeZone

public static long convertTimeToTimeZone(long utcTime,
                                         java.lang.String timeZone)

Returns a time expressed in UTC time zone converted to the given time zone.

Since:

3.0

getLens

public Camera.Lens getLens()

Returns the lens of this camera.

Since:

3.0

setLens

public void setLens(Camera.Lens lens)

Sets the lens of this camera and notifies listeners of this change.

Since:

3.0

setRenderer

public void setRenderer(java.lang.String renderer)

Sets the rendering engine used to create photos.

Since:

7.0

getRenderer

public java.lang.String getRenderer()

Returns the rendering engine used to create photos.

Since:

7.0

setCamera

public void setCamera(Camera camera)

Sets the location and angles of this camera from the camera in parameter.

Since:

2.3

clone

public Camera clone()

Returns a clone of this camera.

Overrides:

clone in class HomeObject

Since:

2.3