de.micromata.opengis.kml.v_2_2_0
Class Lod

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

public class Lod
extends AbstractObject
implements java.lang.Cloneable

(required) Measurement in screen pixels that represents the minimum limit of the visibility range for a given Region. Google Earth calculates the size of the Region when projected onto screen space. Then it computes the square root of the Region's area (if, for example, the Region is square and the viewpoint is directly above the Region, and the Region is not tilted, this measurement is equal to the width of the projected Region). If this measurement falls within the limits defined by and (and if the is in view), the Region is active. If this limit is not reached, the associated geometry is considered to be too far from the user's viewpoint to be drawn. Measurement in screen pixels that represents the maximum limit of the visibility range for a given Region. A value of −1, the default, indicates "active to infinite size." Distance over which the geometry fades, from fully opaque to fully transparent. This ramp value, expressed in screen pixels, is applied at the minimum end of the LOD (visibility) limits. Distance over which the geometry fades, from fully transparent to fully opaque. This ramp value, expressed in screen pixels, is applied at the maximum end of the LOD (visibility) limits.


Field Summary
protected  java.util.List<AbstractObject> lodObjectExtension
          
protected  java.util.List<java.lang.Object> lodSimpleExtension
           
protected  double maxFadeExtent
          
protected  double maxLodPixels
          
protected  double minFadeExtent
          
protected  double minLodPixels
           (required)
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
Lod()
           
 
Method Summary
 Lod addToLodObjectExtension(AbstractObject lodObjectExtension)
          add a value to the lodObjectExtension property collection
 Lod addToLodSimpleExtension(java.lang.Object lodSimpleExtension)
          add a value to the lodSimpleExtension property collection
 Lod addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 Lod clone()
           
 boolean equals(java.lang.Object obj)
           
 java.util.List<AbstractObject> getLodObjectExtension()
           
 java.util.List<java.lang.Object> getLodSimpleExtension()
           
 double getMaxFadeExtent()
           
 double getMaxLodPixels()
           
 double getMinFadeExtent()
           
 double getMinLodPixels()
           
 int hashCode()
           
 void setLodObjectExtension(java.util.List<AbstractObject> lodObjectExtension)
           
 void setLodSimpleExtension(java.util.List<java.lang.Object> lodSimpleExtension)
           
 void setMaxFadeExtent(double value)
           
 void setMaxLodPixels(double value)
           
 void setMinFadeExtent(double value)
           
 void setMinLodPixels(double value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 Lod withId(java.lang.String id)
          fluent setter
 Lod withLodObjectExtension(java.util.List<AbstractObject> lodObjectExtension)
          fluent setter
 Lod withLodSimpleExtension(java.util.List<java.lang.Object> lodSimpleExtension)
          fluent setter
 Lod withMaxFadeExtent(double maxFadeExtent)
          fluent setter
 Lod withMaxLodPixels(double maxLodPixels)
          fluent setter
 Lod withMinFadeExtent(double minFadeExtent)
          fluent setter
 Lod withMinLodPixels(double minLodPixels)
          fluent setter
 Lod withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 Lod withTargetId(java.lang.String targetId)
          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

minLodPixels

protected double minLodPixels
(required)

Measurement in screen pixels that represents the minimum limit of the visibility range for a given Region. Google Earth calculates the size of the Region when projected onto screen space. Then it computes the square root of the Region's area (if, for example, the Region is square and the viewpoint is directly above the Region, and the Region is not tilted, this measurement is equal to the width of the projected Region). If this measurement falls within the limits defined by and (and if the is in view), the Region is active. If this limit is not reached, the associated geometry is considered to be too far from the user's viewpoint to be drawn.


maxLodPixels

protected double maxLodPixels

Measurement in screen pixels that represents the maximum limit of the visibility range for a given Region. A value of −1, the default, indicates "active to infinite size."


minFadeExtent

protected double minFadeExtent

Distance over which the geometry fades, from fully opaque to fully transparent. This ramp value, expressed in screen pixels, is applied at the minimum end of the LOD (visibility) limits.


maxFadeExtent

protected double maxFadeExtent

Distance over which the geometry fades, from fully transparent to fully opaque. This ramp value, expressed in screen pixels, is applied at the maximum end of the LOD (visibility) limits.

In the following diagram, if P=the calculated projected pixel size, the circled numbers indicate the following: if (P < minLodPixels) opacity=0 //#1 in diagram else if(P < minLodPixels + minFadeExtent) opacity=(P - minLodPixels)/minFadeExtent //#2 in diagram else if (P < maxLodPixels - maxFadeExtent) opacity=1 //#3 in diagram else if (P < maxLodPixels) opacity=(maxLodPixels-P)/maxFadeExtent //#4 in diagram else opacity=0 //#5 in diagram


lodSimpleExtension

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

lodObjectExtension

protected java.util.List<AbstractObject> lodObjectExtension

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

Lod

public Lod()
Method Detail

getMinLodPixels

public double getMinLodPixels()
Returns:
possible object is Double
See Also:
minLodPixels

setMinLodPixels

public void setMinLodPixels(double value)
Parameters:
value - allowed object is Double
See Also:
minLodPixels

getMaxLodPixels

public double getMaxLodPixels()
Returns:
possible object is Double
See Also:
maxLodPixels

setMaxLodPixels

public void setMaxLodPixels(double value)
Parameters:
value - allowed object is Double
See Also:
maxLodPixels

getMinFadeExtent

public double getMinFadeExtent()
Returns:
possible object is Double
See Also:
minFadeExtent

setMinFadeExtent

public void setMinFadeExtent(double value)
Parameters:
value - allowed object is Double
See Also:
minFadeExtent

getMaxFadeExtent

public double getMaxFadeExtent()
Returns:
possible object is Double
See Also:
maxFadeExtent

setMaxFadeExtent

public void setMaxFadeExtent(double value)
Parameters:
value - allowed object is Double
See Also:
maxFadeExtent

getLodSimpleExtension

public java.util.List<java.lang.Object> getLodSimpleExtension()
See Also:
lodSimpleExtension

getLodObjectExtension

public java.util.List<AbstractObject> getLodObjectExtension()
See Also:
lodObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractObject

equals

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

setLodSimpleExtension

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

addToLodSimpleExtension

public Lod addToLodSimpleExtension(java.lang.Object lodSimpleExtension)
add a value to the lodSimpleExtension property collection

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

setLodObjectExtension

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

addToLodObjectExtension

public Lod addToLodObjectExtension(AbstractObject lodObjectExtension)
add a value to the lodObjectExtension property collection

Parameters:
lodObjectExtension - 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 Lod 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).

withMinLodPixels

public Lod withMinLodPixels(double minLodPixels)
fluent setter

Parameters:
minLodPixels - required parameter
See Also:
setMinLodPixels(double)

withMaxLodPixels

public Lod withMaxLodPixels(double maxLodPixels)
fluent setter

Parameters:
maxLodPixels - required parameter
See Also:
setMaxLodPixels(double)

withMinFadeExtent

public Lod withMinFadeExtent(double minFadeExtent)
fluent setter

Parameters:
minFadeExtent - required parameter
See Also:
setMinFadeExtent(double)

withMaxFadeExtent

public Lod withMaxFadeExtent(double maxFadeExtent)
fluent setter

Parameters:
maxFadeExtent - required parameter
See Also:
setMaxFadeExtent(double)

withLodSimpleExtension

public Lod withLodSimpleExtension(java.util.List<java.lang.Object> lodSimpleExtension)
fluent setter

Parameters:
lodSimpleExtension - required parameter
See Also:
#setLodSimpleExtension(List)

withLodObjectExtension

public Lod withLodObjectExtension(java.util.List<AbstractObject> lodObjectExtension)
fluent setter

Parameters:
lodObjectExtension - required parameter
See Also:
#setLodObjectExtension(List)

withObjectSimpleExtension

public Lod 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 Lod 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 Lod 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 Lod clone()
Overrides:
clone in class AbstractObject