de.micromata.opengis.kml.v_2_2_0
Class ViewVolume

java.lang.Object
  de.micromata.opengis.kml.v_2_2_0.AbstractObject
      de.micromata.opengis.kml.v_2_2_0.ViewVolume

All Implemented Interfaces:

java.lang.Cloneable

public class ViewVolume
extends AbstractObject
implements java.lang.Cloneable

Defines how much of the current scene is visible. Specifying the field of view is analogous to specifying the lens opening in a physical camera. A small field of view, like a telephoto lens, focuses on a small part of the scene. A large field of view, like a wide-angle lens, focuses on a large part of the scene.

Field Summary

protected double	bottomFov
protected double	leftFov
protected double	near
protected double	rightFov
protected double	topFov
protected java.util.List<AbstractObject>	viewVolumeObjectExtension
protected java.util.List<java.lang.Object>	viewVolumeSimpleExtension

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

id, objectSimpleExtension, targetId

Constructor Summary

ViewVolume()

Method Summary

ViewVolume	addToObjectSimpleExtension(java.lang.Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
ViewVolume	addToViewVolumeObjectExtension(AbstractObject viewVolumeObjectExtension) add a value to the viewVolumeObjectExtension property collection
ViewVolume	addToViewVolumeSimpleExtension(java.lang.Object viewVolumeSimpleExtension) add a value to the viewVolumeSimpleExtension property collection
ViewVolume	clone()
boolean	equals(java.lang.Object obj)
double	getBottomFov()
double	getLeftFov()
double	getNear()
double	getRightFov()
double	getTopFov()
java.util.List<AbstractObject>	getViewVolumeObjectExtension()
java.util.List<java.lang.Object>	getViewVolumeSimpleExtension()
int	hashCode()
void	setBottomFov(double value)
void	setLeftFov(double value)
void	setNear(double value)
void	setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
void	setRightFov(double value)
void	setTopFov(double value)
void	setViewVolumeObjectExtension(java.util.List<AbstractObject> viewVolumeObjectExtension)
void	setViewVolumeSimpleExtension(java.util.List<java.lang.Object> viewVolumeSimpleExtension)
ViewVolume	withBottomFov(double bottomFov) fluent setter
ViewVolume	withId(java.lang.String id) fluent setter
ViewVolume	withLeftFov(double leftFov) fluent setter
ViewVolume	withNear(double near) fluent setter
ViewVolume	withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension) fluent setter
ViewVolume	withRightFov(double rightFov) fluent setter
ViewVolume	withTargetId(java.lang.String targetId) fluent setter
ViewVolume	withTopFov(double topFov) fluent setter
ViewVolume	withViewVolumeObjectExtension(java.util.List<AbstractObject> viewVolumeObjectExtension) fluent setter
ViewVolume	withViewVolumeSimpleExtension(java.util.List<java.lang.Object> viewVolumeSimpleExtension) fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

leftFov

protected double leftFov

Angle, in degrees, between the camera's viewing direction and the left side of the view volume.

rightFov

protected double rightFov

Angle, in degrees, between the camera's viewing direction and the right side of the view volume.

bottomFov

protected double bottomFov

Angle, in degrees, between the camera's viewing direction and the bottom side of the view volume.

topFov

protected double topFov

Angle, in degrees, between the camera's viewing direction and the top side of the view volume.

near

protected double near

Angle, in degrees, between the camera's viewing direction and the left side of the view volume. Angle, in degrees, between the camera's viewing direction and the right side of the view volume. Angle, in degrees, between the camera's viewing direction and the bottom side of the view volume. Angle, in degrees, between the camera's viewing direction and the top side of the view volume. Measurement in meters along the viewing direction from the camera viewpoint to the PhotoOverlay shape.

Measurement in meters along the viewing direction from the camera viewpoint to the PhotoOverlay shape.

The field of view for a PhotoOverlay is defined by four planes, each of which is specified by an angle relative to the view vector. These four planes define the top, bottom, left, and right sides of the field of view, which has the shape of a truncated pyramid, as shown here:

The following diagrams show the four field-of-view angles within this pyramid:

The following diagrams show the four field-of-view angles within this pyramid:

viewVolumeSimpleExtension

protected java.util.List<java.lang.Object> viewVolumeSimpleExtension

viewVolumeObjectExtension

protected java.util.List<AbstractObject> viewVolumeObjectExtension