de.micromata.opengis.kml.v_2_2_0
Class Orientation

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.Orientation
All Implemented Interfaces:
java.lang.Cloneable

public class Orientation
extends AbstractObject
implements java.lang.Cloneable

Describes rotation of a 3D model's coordinate system to position the object in Google Earth. See diagram below. 45.0 10.0 0.0


Field Summary
protected  double heading
          
protected  java.util.List<AbstractObject> orientationObjectExtension
          
protected  java.util.List<java.lang.Object> orientationSimpleExtension
           
protected  double roll
          
protected  double tilt
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
Orientation()
           
 
Method Summary
 Orientation addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 Orientation addToOrientationObjectExtension(AbstractObject orientationObjectExtension)
          add a value to the orientationObjectExtension property collection
 Orientation addToOrientationSimpleExtension(java.lang.Object orientationSimpleExtension)
          add a value to the orientationSimpleExtension property collection
 Orientation clone()
           
 boolean equals(java.lang.Object obj)
           
 double getHeading()
           
 java.util.List<AbstractObject> getOrientationObjectExtension()
           
 java.util.List<java.lang.Object> getOrientationSimpleExtension()
           
 double getRoll()
           
 double getTilt()
           
 int hashCode()
           
 void setHeading(double value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setOrientationObjectExtension(java.util.List<AbstractObject> orientationObjectExtension)
           
 void setOrientationSimpleExtension(java.util.List<java.lang.Object> orientationSimpleExtension)
           
 void setRoll(double value)
           
 void setTilt(double value)
           
 Orientation withHeading(double heading)
          fluent setter
 Orientation withId(java.lang.String id)
          fluent setter
 Orientation withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Orientation withOrientationObjectExtension(java.util.List<AbstractObject> orientationObjectExtension)
          fluent setter
 Orientation withOrientationSimpleExtension(java.util.List<java.lang.Object> orientationSimpleExtension)
          fluent setter
 Orientation withRoll(double roll)
          fluent setter
 Orientation withTargetId(java.lang.String targetId)
          fluent setter
 Orientation withTilt(double tilt)
          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

heading

protected double heading

Direction (azimuth) of the camera, in degrees. Default=0 (true North). (See diagram.) Values range from 0 to 360 degrees.

Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See diagram below.) Values range from 0 to 360 degrees.

Direction (that is, North, South, East, West), in degrees. Default=0 (North). (See diagram.) Values range from 0 to 360 degrees.

Rotation about the z axis (normal to the Earth's surface). A value of 0 (the default) equals North. A positive rotation is clockwise around the z axis and specified in degrees from 0 to 360.


tilt

protected double tilt

Angle between the direction of the LookAt position and the normal to the surface of the earth. (See diagram below.) Values range from 0 to 90 degrees. Values for cannot be negative. A value of 0 degrees indicates viewing from directly above. A value of 90 degrees indicates viewing along the horizon.

Rotation about the x axis. A positive rotation is clockwise around the x axis and specified in degrees from 0 to 360.

Rotation, in degrees, of the camera around the X axis. A value of 0 indicates that the view is aimed straight down toward the earth (the most common case). A value for 90 for indicates that the view is aimed toward the horizon. Values greater than 90 indicate that the view is pointed up into the sky. Values for are clamped at +180 degrees.


roll

protected double roll

Rotation about the z axis (normal to the Earth's surface). A value of 0 (the default) equals North. A positive rotation is clockwise around the z axis and specified in degrees from 0 to 360. Rotation about the x axis. A positive rotation is clockwise around the x axis and specified in degrees from 0 to 360. Rotation about the y axis. A positive rotation is clockwise around the y axis and specified in degrees from 0 to 360. This diagram illustrates the typical orientation of a model's axes:

Rotation about the y axis. A positive rotation is clockwise around the y axis and specified in degrees from 0 to 360.

Rotation, in degrees, of the camera around the Z axis. Values range from −180 to +180 degrees.

This diagram illustrates the typical orientation of a model's axes:


orientationSimpleExtension

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

orientationObjectExtension

protected java.util.List<AbstractObject> orientationObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

Orientation

public Orientation()
Method Detail

getHeading

public double getHeading()
Returns:
possible object is Double
See Also:
heading

setHeading

public void setHeading(double value)
Parameters:
value - allowed object is Double
See Also:
heading

getTilt

public double getTilt()
Returns:
possible object is Double
See Also:
tilt

setTilt

public void setTilt(double value)
Parameters:
value - allowed object is Double
See Also:
tilt

getRoll

public double getRoll()
Returns:
possible object is Double
See Also:
roll

setRoll

public void setRoll(double value)
Parameters:
value - allowed object is Double
See Also:
roll

getOrientationSimpleExtension

public java.util.List<java.lang.Object> getOrientationSimpleExtension()
See Also:
orientationSimpleExtension

getOrientationObjectExtension

public java.util.List<AbstractObject> getOrientationObjectExtension()
See Also:
orientationObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class AbstractObject

setOrientationSimpleExtension

public void setOrientationSimpleExtension(java.util.List<java.lang.Object> orientationSimpleExtension)
Parameters:
orientationSimpleExtension -
See Also:
orientationSimpleExtension

addToOrientationSimpleExtension

public Orientation addToOrientationSimpleExtension(java.lang.Object orientationSimpleExtension)
add a value to the orientationSimpleExtension property collection

Parameters:
orientationSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setOrientationObjectExtension

public void setOrientationObjectExtension(java.util.List<AbstractObject> orientationObjectExtension)
Parameters:
orientationObjectExtension -
See Also:
orientationObjectExtension

addToOrientationObjectExtension

public Orientation addToOrientationObjectExtension(AbstractObject orientationObjectExtension)
add a value to the orientationObjectExtension property collection

Parameters:
orientationObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class AbstractObject
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public Orientation addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

withHeading

public Orientation withHeading(double heading)
fluent setter

Parameters:
heading - required parameter
See Also:
setHeading(double)

withTilt

public Orientation withTilt(double tilt)
fluent setter

Parameters:
tilt - required parameter
See Also:
setTilt(double)

withRoll

public Orientation withRoll(double roll)
fluent setter

Parameters:
roll - required parameter
See Also:
setRoll(double)

withOrientationSimpleExtension

public Orientation withOrientationSimpleExtension(java.util.List<java.lang.Object> orientationSimpleExtension)
fluent setter

Parameters:
orientationSimpleExtension - required parameter
See Also:
#setOrientationSimpleExtension(List)

withOrientationObjectExtension

public Orientation withOrientationObjectExtension(java.util.List<AbstractObject> orientationObjectExtension)
fluent setter

Parameters:
orientationObjectExtension - required parameter
See Also:
#setOrientationObjectExtension(List)

withObjectSimpleExtension

public Orientation withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public Orientation withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class AbstractObject
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public Orientation withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class AbstractObject
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

clone

public Orientation clone()
Overrides:
clone in class AbstractObject