de.micromata.opengis.kml.v_2_2_0
Class Model

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

public class Model
extends Geometry
implements java.lang.Cloneable

A 3D object described in a COLLADA file (referenced in the tag). COLLADA files have a .dae file extension. Models are created in their own coordinate space and then located, positioned, and scaled in Google Earth. See the "Topics in KML" page on Regions for more detail.

Google Earth supports only triangles and lines as primitive types. The maximum number of triangles allowed is 21845. Google Earth does not support animation or skinning. Google Earth does not support external geometry references.

Google Earth supports the COLLADA common profile, with the following exceptions:

Syntax:
<Model id="ID">
   <!-- specific to Model -->
   <altitudeMode>clampToGround</altitudeMode> 
       <!-- kml:altitudeModeEnum: clampToGround,relativeToGround,or absolute -->
       <!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor -->
   <Location> 
     <longitude></longitude> <!-- kml:angle180 -->
     <latitude></latitude>   <!-- kml:angle90 -->  
     <altitude>0</altitude>  <!-- double --> 
   </Location> 
   <Orientation>               
     <heading>0</heading>    <!-- kml:angle360 -->
     <tilt>0</tilt>          <!-- kml:angle360 -->
     <roll>0</roll>          <!-- kml:angle360 -->
   </Orientation> 
   <Scale> 
     <x>1</x>                <!-- double -->
     <y>1</y>                <!-- double -->
     <z>1</z>                <!-- double -->
   </Scale> 
   <Link>...</Link>
   <ResourceMap>
     <Alias>
       <targetHref>...</targetHref>   <!-- anyURI -->
       <sourceHref>...</sourceHref>   <!-- anyURI -->
     </Alias>
   </ResourceMap>
 </Model>
Extends:


Field Summary
protected  AltitudeMode altitudeMode
          AltitudeMode
protected  Link link
           (required).
protected  Location location
          
protected  java.util.List<AbstractObject> modelObjectExtension
          
protected  java.util.List<java.lang.Object> modelSimpleExtension
           
protected  Orientation orientation
          
protected  ResourceMap resourceMap
          
protected  Scale scale
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Geometry
geometryObjectExtension, geometrySimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
Model()
           
 
Method Summary
 Model addToGeometryObjectExtension(AbstractObject geometryObjectExtension)
          add a value to the geometryObjectExtension property collection
 Model addToGeometrySimpleExtension(java.lang.Object geometrySimpleExtension)
          add a value to the geometrySimpleExtension property collection
 Model addToModelObjectExtension(AbstractObject modelObjectExtension)
          add a value to the modelObjectExtension property collection
 Model addToModelSimpleExtension(java.lang.Object modelSimpleExtension)
          add a value to the modelSimpleExtension property collection
 Model addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 Model clone()
           
 Link createAndSetLink()
          Creates a new instance of Link and set it to link.
 Location createAndSetLocation()
          Creates a new instance of Location and set it to location.
 Orientation createAndSetOrientation()
          Creates a new instance of Orientation and set it to orientation.
 ResourceMap createAndSetResourceMap()
          Creates a new instance of ResourceMap and set it to resourceMap.
 Scale createAndSetScale()
          Creates a new instance of Scale and set it to scale.
 boolean equals(java.lang.Object obj)
           
 AltitudeMode getAltitudeMode()
           
 Link getLink()
           
 Location getLocation()
           
 java.util.List<AbstractObject> getModelObjectExtension()
           
 java.util.List<java.lang.Object> getModelSimpleExtension()
           
 Orientation getOrientation()
           
 ResourceMap getResourceMap()
           
 Scale getScale()
           
 int hashCode()
           
 void setAltitudeMode(AltitudeMode value)
           
 void setGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
           
 void setGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
           
 void setLink(Link value)
           
 void setLocation(Location value)
           
 void setModelObjectExtension(java.util.List<AbstractObject> modelObjectExtension)
           
 void setModelSimpleExtension(java.util.List<java.lang.Object> modelSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setOrientation(Orientation value)
           
 void setResourceMap(ResourceMap value)
           
 void setScale(Scale value)
           
 Model withAltitudeMode(AltitudeMode altitudeMode)
          fluent setter
 Model withGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
          fluent setter
 Model withGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
          fluent setter
 Model withId(java.lang.String id)
          fluent setter
 Model withLink(Link link)
          fluent setter
 Model withLocation(Location location)
          fluent setter
 Model withModelObjectExtension(java.util.List<AbstractObject> modelObjectExtension)
          fluent setter
 Model withModelSimpleExtension(java.util.List<java.lang.Object> modelSimpleExtension)
          fluent setter
 Model withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Model withOrientation(Orientation orientation)
          fluent setter
 Model withResourceMap(ResourceMap resourceMap)
          fluent setter
 Model withScale(Scale scale)
          fluent setter
 Model withTargetId(java.lang.String targetId)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Geometry
getGeometryObjectExtension, getGeometrySimpleExtension
 
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

altitudeMode

protected AltitudeMode altitudeMode
AltitudeMode

clampToGround, relativeToGround, absolute

See Also: See and


location

protected Location location

Specifies the exact coordinates of the Model's origin in latitude, longitude, and altitude. Latitude and longitude measurements are standard lat-lon projection with WGS84 datum. Altitude is distance above the earth's surface, in meters, and is interpreted according to or . 39.55375305703105 -118.9813220168456 1223


orientation

protected Orientation orientation

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


scale

protected Scale scale

Note: The tag has been deprecated. Use instead.

Resizes the icon.

Scales a model along the x, y, and z axes in the model's coordinate space. 2.5 2.5 3.5


link

protected Link link
(required). see .

specifies the location of any of the following:

If the file specified in is a local file, the and elements are not used.

KML files fetched by network links Image files used in any Overlay (the element specifies the image in an Overlay; has the same fields as ) Model files used in the element

Specifies the URL of the website containing this KML or KMZ file. Be sure to include the namespace for this element in any KML file that uses it: xmlns:atom="http://www.w3.org/2005/Atom" (see the sample that follows).

Specifies the file to load and optional refresh parameters. See .

The element replaces the element of contained in earlier KML releases and adds functionality for the element (introduced in KML 2.1). In Google Earth releases 3.0 and earlier, the element is ignored.

The file is conditionally loaded and refreshed, depending on the refresh parameters supplied here. Two different sets of refresh parameters can be specified: one set is based on time ( and ) and one is based on the current "camera" view ( and ). In addition, Link specifies whether to scale the bounding box parameters that are sent to the server ( and provides a set of optional viewing parameters that can be sent to the server () as well as a set of optional parameters containing version and language information.

Tip: To display the top-level Folder or Document within a Network Link in the List View, assign an ID to the Folder or Document. Without this ID, only the child object names are displayed in the List View.

When a file is fetched, the URL that is sent to the server is composed of three pieces of information:

the href (Hypertext Reference) that specifies the file to load. an arbitrary format string that is created from (a) parameters that you specify in the element or (b) bounding box parameters (this is the default and is used if no element is included in the file). a second format string that is specified in the element.

Syntax:
<Link id="ID">
   <!-- specific to Link -->
   <href>...</href>                      <!-- string -->
   <refreshMode>onChange</refreshMode>   
     <!-- refreshModeEnum: onChange, onInterval, or onExpire -->   
   <refreshInterval>4</refreshInterval>  <!-- float -->
   <viewRefreshMode>never</viewRefreshMode> 
     <!-- viewRefreshModeEnum: never, onStop, onRequest, onRegion -->
   <viewRefreshTime>4</viewRefreshTime>  <!-- float -->
   <viewBoundScale>1</viewBoundScale>    <!-- float -->
   <viewFormat>BBOX=[bboxWest],[bboxSouth],[bboxEast],[bboxNorth]</viewFormat>
                                         <!-- string -->
   <httpQuery>...</httpQuery>            <!-- string -->
 </Link>
Extends:


resourceMap

protected ResourceMap resourceMap


modelSimpleExtension

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

modelObjectExtension

protected java.util.List<AbstractObject> modelObjectExtension

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

Model

public Model()
Method Detail

getAltitudeMode

public AltitudeMode getAltitudeMode()
Returns:
possible object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

setAltitudeMode

public void setAltitudeMode(AltitudeMode value)
Parameters:
value - allowed object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

getLocation

public Location getLocation()
Returns:
possible object is Location
See Also:
location

setLocation

public void setLocation(Location value)
Parameters:
value - allowed object is Location
See Also:
location

getOrientation

public Orientation getOrientation()
Returns:
possible object is Orientation
See Also:
orientation

setOrientation

public void setOrientation(Orientation value)
Parameters:
value - allowed object is Orientation
See Also:
orientation

getScale

public Scale getScale()
Returns:
possible object is Scale
See Also:
scale

setScale

public void setScale(Scale value)
Parameters:
value - allowed object is Scale
See Also:
scale

getLink

public Link getLink()
Returns:
possible object is Link
See Also:
link

setLink

public void setLink(Link value)
Parameters:
value - allowed object is Link
See Also:
link

getResourceMap

public ResourceMap getResourceMap()
Returns:
possible object is ResourceMap
See Also:
resourceMap

setResourceMap

public void setResourceMap(ResourceMap value)
Parameters:
value - allowed object is ResourceMap
See Also:
resourceMap

getModelSimpleExtension

public java.util.List<java.lang.Object> getModelSimpleExtension()
See Also:
modelSimpleExtension

getModelObjectExtension

public java.util.List<AbstractObject> getModelObjectExtension()
See Also:
modelObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class Geometry

equals

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

createAndSetLocation

public Location createAndSetLocation()
Creates a new instance of Location and set it to location. This method is a short version for: Location location = new Location(); this.setLocation(location);


createAndSetOrientation

public Orientation createAndSetOrientation()
Creates a new instance of Orientation and set it to orientation. This method is a short version for: Orientation orientation = new Orientation(); this.setOrientation(orientation);


createAndSetScale

public Scale createAndSetScale()
Creates a new instance of Scale and set it to scale. This method is a short version for: Scale scale = new Scale(); this.setScale(scale);


createAndSetLink

public Link createAndSetLink()
Creates a new instance of Link and set it to link. This method is a short version for: Link link = new Link(); this.setLink(link);


createAndSetResourceMap

public ResourceMap createAndSetResourceMap()
Creates a new instance of ResourceMap and set it to resourceMap. This method is a short version for: ResourceMap resourceMap = new ResourceMap(); this.setResourceMap(resourceMap);


setModelSimpleExtension

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

addToModelSimpleExtension

public Model addToModelSimpleExtension(java.lang.Object modelSimpleExtension)
add a value to the modelSimpleExtension property collection

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

setModelObjectExtension

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

addToModelObjectExtension

public Model addToModelObjectExtension(AbstractObject modelObjectExtension)
add a value to the modelObjectExtension property collection

Parameters:
modelObjectExtension - 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 Geometry
See Also:
objectSimpleExtension

addToObjectSimpleExtension

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

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

setGeometrySimpleExtension

public void setGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
Overrides:
setGeometrySimpleExtension in class Geometry
See Also:
geometrySimpleExtension

addToGeometrySimpleExtension

public Model addToGeometrySimpleExtension(java.lang.Object geometrySimpleExtension)
Description copied from class: Geometry
add a value to the geometrySimpleExtension property collection

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

setGeometryObjectExtension

public void setGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
Overrides:
setGeometryObjectExtension in class Geometry
See Also:
geometryObjectExtension

addToGeometryObjectExtension

public Model addToGeometryObjectExtension(AbstractObject geometryObjectExtension)
Description copied from class: Geometry
add a value to the geometryObjectExtension property collection

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

withAltitudeMode

public Model withAltitudeMode(AltitudeMode altitudeMode)
fluent setter

Parameters:
altitudeMode - required parameter
See Also:
#setAltitudeMode(Object)

withLocation

public Model withLocation(Location location)
fluent setter

Parameters:
location - required parameter
See Also:
setLocation(Location)

withOrientation

public Model withOrientation(Orientation orientation)
fluent setter

Parameters:
orientation - required parameter
See Also:
setOrientation(Orientation)

withScale

public Model withScale(Scale scale)
fluent setter

Parameters:
scale - required parameter
See Also:
setScale(Scale)

withLink

public Model withLink(Link link)
fluent setter

Parameters:
link - required parameter
See Also:
setLink(Link)

withResourceMap

public Model withResourceMap(ResourceMap resourceMap)
fluent setter

Parameters:
resourceMap - required parameter
See Also:
setResourceMap(ResourceMap)

withModelSimpleExtension

public Model withModelSimpleExtension(java.util.List<java.lang.Object> modelSimpleExtension)
fluent setter

Parameters:
modelSimpleExtension - required parameter
See Also:
#setModelSimpleExtension(List)

withModelObjectExtension

public Model withModelObjectExtension(java.util.List<AbstractObject> modelObjectExtension)
fluent setter

Parameters:
modelObjectExtension - required parameter
See Also:
#setModelObjectExtension(List)

withObjectSimpleExtension

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

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

withId

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

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

withTargetId

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

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

withGeometrySimpleExtension

public Model withGeometrySimpleExtension(java.util.List<java.lang.Object> geometrySimpleExtension)
Description copied from class: Geometry
fluent setter

Overrides:
withGeometrySimpleExtension in class Geometry
Parameters:
geometrySimpleExtension - required parameter
See Also:
#setGeometrySimpleExtension(List)

withGeometryObjectExtension

public Model withGeometryObjectExtension(java.util.List<AbstractObject> geometryObjectExtension)
Description copied from class: Geometry
fluent setter

Overrides:
withGeometryObjectExtension in class Geometry
Parameters:
geometryObjectExtension - required parameter
See Also:
#setGeometryObjectExtension(List)

clone

public Model clone()
Overrides:
clone in class Geometry