public class ViewVolume extends AbstractObject implements 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.
| Modifier and Type | Field and Description |
|---|---|
protected double |
bottomFov
|
protected double |
leftFov
|
protected double |
near
|
protected double |
rightFov
|
protected double |
topFov
|
protected List<AbstractObject> |
viewVolumeObjectExtension
|
protected List<Object> |
viewVolumeSimpleExtension |
id, objectSimpleExtension, targetId| Constructor and Description |
|---|
ViewVolume() |
| Modifier and Type | Method and Description |
|---|---|
ViewVolume |
addToObjectSimpleExtension(Object objectSimpleExtension)
add a value to the objectSimpleExtension property collection
|
ViewVolume |
addToViewVolumeObjectExtension(AbstractObject viewVolumeObjectExtension)
add a value to the viewVolumeObjectExtension property collection
|
ViewVolume |
addToViewVolumeSimpleExtension(Object viewVolumeSimpleExtension)
add a value to the viewVolumeSimpleExtension property collection
|
ViewVolume |
clone() |
boolean |
equals(Object obj) |
double |
getBottomFov() |
double |
getLeftFov() |
double |
getNear() |
double |
getRightFov() |
double |
getTopFov() |
List<AbstractObject> |
getViewVolumeObjectExtension() |
List<Object> |
getViewVolumeSimpleExtension() |
int |
hashCode() |
void |
setBottomFov(double value) |
void |
setLeftFov(double value) |
void |
setNear(double value) |
void |
setObjectSimpleExtension(List<Object> objectSimpleExtension) |
void |
setRightFov(double value) |
void |
setTopFov(double value) |
void |
setViewVolumeObjectExtension(List<AbstractObject> viewVolumeObjectExtension) |
void |
setViewVolumeSimpleExtension(List<Object> viewVolumeSimpleExtension) |
ViewVolume |
withBottomFov(double bottomFov)
fluent setter
|
ViewVolume |
withId(String id)
fluent setter
|
ViewVolume |
withLeftFov(double leftFov)
fluent setter
|
ViewVolume |
withNear(double near)
fluent setter
|
ViewVolume |
withObjectSimpleExtension(List<Object> objectSimpleExtension)
fluent setter
|
ViewVolume |
withRightFov(double rightFov)
fluent setter
|
ViewVolume |
withTargetId(String targetId)
fluent setter
|
ViewVolume |
withTopFov(double topFov)
fluent setter
|
ViewVolume |
withViewVolumeObjectExtension(List<AbstractObject> viewVolumeObjectExtension)
fluent setter
|
ViewVolume |
withViewVolumeSimpleExtension(List<Object> viewVolumeSimpleExtension)
fluent setter
|
getId, getObjectSimpleExtension, getTargetId, setId, setTargetIdprotected double leftFov
Angle, in degrees, between the camera's viewing direction and the left side of the view volume.
protected double rightFov
Angle, in degrees, between the camera's viewing direction and the right side of the view volume.
protected double bottomFov
Angle, in degrees, between the camera's viewing direction and the bottom side of the view volume.
protected double topFov
Angle, in degrees, between the camera's viewing direction and the top side of the view volume.
protected double near
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:
protected List<AbstractObject> viewVolumeObjectExtension
public double getLeftFov()
DoubleleftFovpublic void setLeftFov(double value)
value - allowed object is
DoubleleftFovpublic double getRightFov()
DoublerightFovpublic void setRightFov(double value)
value - allowed object is
DoublerightFovpublic double getBottomFov()
DoublebottomFovpublic void setBottomFov(double value)
value - allowed object is
DoublebottomFovpublic double getTopFov()
DoubletopFovpublic void setTopFov(double value)
value - allowed object is
DoubletopFovpublic double getNear()
Doublenearpublic void setNear(double value)
value - allowed object is
Doublenearpublic List<Object> getViewVolumeSimpleExtension()
viewVolumeSimpleExtensionpublic List<AbstractObject> getViewVolumeObjectExtension()
viewVolumeObjectExtensionpublic int hashCode()
hashCode in class AbstractObjectpublic boolean equals(Object obj)
equals in class AbstractObjectpublic void setViewVolumeSimpleExtension(List<Object> viewVolumeSimpleExtension)
viewVolumeSimpleExtension - viewVolumeSimpleExtensionpublic ViewVolume addToViewVolumeSimpleExtension(Object viewVolumeSimpleExtension)
viewVolumeSimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setViewVolumeObjectExtension(List<AbstractObject> viewVolumeObjectExtension)
viewVolumeObjectExtension - viewVolumeObjectExtensionpublic ViewVolume addToViewVolumeObjectExtension(AbstractObject viewVolumeObjectExtension)
viewVolumeObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic void setObjectSimpleExtension(List<Object> objectSimpleExtension)
setObjectSimpleExtension in class AbstractObjectobjectSimpleExtensionpublic ViewVolume addToObjectSimpleExtension(Object objectSimpleExtension)
AbstractObjectaddToObjectSimpleExtension in class AbstractObjectobjectSimpleExtension - Objects of the following type are allowed in the list: Objectpublic ViewVolume withLeftFov(double leftFov)
leftFov - required parametersetLeftFov(double)public ViewVolume withRightFov(double rightFov)
rightFov - required parametersetRightFov(double)public ViewVolume withBottomFov(double bottomFov)
bottomFov - required parametersetBottomFov(double)public ViewVolume withTopFov(double topFov)
topFov - required parametersetTopFov(double)public ViewVolume withNear(double near)
near - required parametersetNear(double)public ViewVolume withViewVolumeSimpleExtension(List<Object> viewVolumeSimpleExtension)
viewVolumeSimpleExtension - required parameter#setViewVolumeSimpleExtension(Listpublic ViewVolume withViewVolumeObjectExtension(List<AbstractObject> viewVolumeObjectExtension)
viewVolumeObjectExtension - required parameter#setViewVolumeObjectExtension(List) public ViewVolume withObjectSimpleExtension(List<Object> objectSimpleExtension)
AbstractObjectwithObjectSimpleExtension in class AbstractObjectobjectSimpleExtension - required parameter#setObjectSimpleExtension(Listpublic ViewVolume withId(String id)
AbstractObjectwithId in class AbstractObjectid - required parameterAbstractObject.setId(String)public ViewVolume withTargetId(String targetId)
AbstractObjectwithTargetId in class AbstractObjecttargetId - required parameterAbstractObject.setTargetId(String)public ViewVolume clone()
clone in class AbstractObjectCopyright © 2014 Micromata GmbH. All rights reserved.