gov.nasa.worldwind.layers.AirspaceLayer Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2012 United States Government as represented by the Administrator of the
* National Aeronautics and Space Administration.
* All Rights Reserved.
*/
package gov.nasa.worldwind.layers;
import gov.nasa.worldwind.render.DrawContext;
import gov.nasa.worldwind.render.airspaces.Airspace;
import gov.nasa.worldwind.util.Logging;
/**
* AirspaceLayer manages a list of airspaces for rendering and picking. AirspaceLayer was originally designed as a
* special purpose layer for {@link Airspace} shapes, but is now a redundant with {@link RenderableLayer}. Usage of
* AirspaceLayer should be replaced with RenderableLayer. Most methods on AirspaceLayer can be replaced with the
* equivalent methods of Airspace or RenderableLayer. The methods that are no longer supported are documented as such.
*
* @author dcollins
* @version $Id: AirspaceLayer.java 2231 2014-08-15 19:03:12Z dcollins $
* @deprecated Use {@link RenderableLayer} instead.
*/
public class AirspaceLayer extends AbstractLayer
{
private final java.util.Collection airspaces = new java.util.concurrent.ConcurrentLinkedQueue();
private Iterable airspacesOverride;
/** Creates a new Airspace with an empty collection of Airspaces. */
public AirspaceLayer()
{
}
/**
* Adds the specified airspace to this layer's internal collection. If this layer's internal collection
* has been overridden with a call to {@link #setAirspaces(Iterable)}, this will throw an exception.
*
* @param airspace the airspace to add.
*
* @throws IllegalArgumentException if the airspace is null.
* @throws IllegalStateException if a custom Iterable has been specified by a call to setRenderables.
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#addRenderable(gov.nasa.worldwind.render.Renderable)}
* instead.
*/
public void addAirspace(Airspace airspace)
{
if (airspace == null)
{
String msg = "nullValue.AirspaceIsNull";
Logging.logger().severe(msg);
throw new IllegalArgumentException(msg);
}
if (this.airspacesOverride != null)
{
String msg = Logging.getMessage("generic.LayerIsUsingCustomIterable");
Logging.logger().severe(msg);
throw new IllegalStateException(msg);
}
this.airspaces.add(airspace);
}
/**
* Adds the contents of the specified airspaces to this layer's internal collection. If this layer's
* internal collection has been overridden with a call to {@link #setAirspaces(Iterable)}, this will throw an
* exception.
*
* @param airspaces the airspaces to add.
*
* @throws IllegalArgumentException if the iterable is null.
* @throws IllegalStateException if a custom Iterable has been specified by a call to setRenderables.
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#addRenderables(Iterable)} instead.
*/
public void addAirspaces(Iterable airspaces)
{
if (airspaces == null)
{
String msg = Logging.getMessage("nullValue.IterableIsNull");
Logging.logger().severe(msg);
throw new IllegalArgumentException(msg);
}
if (this.airspacesOverride != null)
{
String msg = Logging.getMessage("generic.LayerIsUsingCustomIterable");
Logging.logger().severe(msg);
throw new IllegalStateException(msg);
}
for (Airspace airspace : airspaces)
{
// Internal list of airspaces does not accept null values.
if (airspace != null)
this.airspaces.add(airspace);
}
}
/**
* Removes the specified airspace from this layer's internal collection, if it exists. If this layer's
* internal collection has been overridden with a call to {@link #setAirspaces(Iterable)}, this will throw an
* exception.
*
* @param airspace the airspace to remove.
*
* @throws IllegalArgumentException if the airspace is null.
* @throws IllegalStateException if a custom Iterable has been specified by a call to setRenderables.
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#removeRenderable(gov.nasa.worldwind.render.Renderable)}
* instead.
*/
public void removeAirspace(Airspace airspace)
{
if (airspace == null)
{
String msg = "nullValue.AirspaceIsNull";
Logging.logger().severe(msg);
throw new IllegalArgumentException(msg);
}
if (this.airspacesOverride != null)
{
String msg = Logging.getMessage("generic.LayerIsUsingCustomIterable");
Logging.logger().severe(msg);
throw new IllegalStateException(msg);
}
this.airspaces.remove(airspace);
}
/**
* Clears the contents of this layer's internal Airspace collection. If this layer's internal collection has been
* overridden with a call to {@link #setAirspaces(Iterable)}, this will throw an exception.
*
* @throws IllegalStateException If a custom Iterable has been specified by a call to setAirspaces.
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#removeAllRenderables()} instead.
*/
public void removeAllAirspaces()
{
if (this.airspacesOverride != null)
{
String msg = Logging.getMessage("generic.LayerIsUsingCustomIterable");
Logging.logger().severe(msg);
throw new IllegalStateException(msg);
}
clearAirspaces();
}
private void clearAirspaces()
{
if (this.airspaces != null && this.airspaces.size() > 0)
this.airspaces.clear();
}
/**
* Returns the Iterable of Airspaces currently in use by this layer. If the caller has specified a custom Iterable
* via {@link #setAirspaces(Iterable)}, this will returns a reference to that Iterable. If the caller passed
* setAirspaces a null parameter, or if setAirspaces has not been called, this returns a
* view of this layer's internal collection of Airspaces.
*
* @return Iterable of currently active Airspaces.
*
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#getRenderables()} instead.
*/
public Iterable getAirspaces()
{
if (this.airspacesOverride != null)
{
return this.airspacesOverride;
}
else
{
// Return an unmodifiable reference to the internal list of airspaces.
// This prevents callers from changing this list and invalidating any invariants we have established.
return java.util.Collections.unmodifiableCollection(this.airspaces);
}
}
/**
* Returns the Iterable of currently active Airspaces. If the caller has specified a custom Iterable via {@link
* #setAirspaces(Iterable)}, this will returns a reference to that Iterable. If the caller passed
* setAirspaces a null parameter, or if setAirspaces has not been called, this returns a
* view of this layer's internal collection of Airspaces.
*
* @return Iterable of currently active Airspaces.
*/
private Iterable getActiveAirspaces()
{
if (this.airspacesOverride != null)
{
return this.airspacesOverride;
}
else
{
return this.airspaces;
}
}
/**
* Overrides the collection of currently active Airspaces with the specified airspaceIterable. This
* layer will maintain a reference to airspaceIterable strictly for picking and rendering. This layer
* will not modify the Iterable reference. However, this will clear the internal collection of Airspaces, and will
* prevent any modification to its contents via addAirspace, addAirspaces, or removeAirspaces.
*
* If the specified airspaceIterable is null, this layer will revert to maintaining its internal
* collection.
*
* @param airspaceIterable Iterable to use instead of this layer's internal collection, or null to use this layer's
*
* @deprecated Use {@link RenderableLayer} and {@link RenderableLayer#setRenderables(Iterable)} instead.
*/
public void setAirspaces(Iterable airspaceIterable)
{
this.airspacesOverride = airspaceIterable;
// Clear the internal collection of Airspaces.
clearAirspaces();
}
/**
* Returns false.
*
* @return false
*
* @deprecated Use {@link gov.nasa.worldwind.render.ShapeAttributes#isEnableAntialiasing()} on each Airspace
* instance in the layer.
*/
public boolean isEnableAntialiasing()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enable ignored.
*
* @deprecated Use {@link gov.nasa.worldwind.render.ShapeAttributes#setEnableAntialiasing(boolean)} on each Airspace
* instance in the layer.
*/
public void setEnableAntialiasing(boolean enable)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Control over airspace blending is no longer supported. Airspaces implicitly blend themselves with
* other objects in the scene.
*/
public boolean isEnableBlending()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enable ignored.
*
* @deprecated Control over airspace blending is no longer supported. Airspaces implicitly blend themselves with
* other objects in the scene.
*/
public void setEnableBlending(boolean enable)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#isEnableDepthOffset()} on each Airspace
* instance in the layer.
*/
public boolean isEnableDepthOffset()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enable ignored.
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#setEnableDepthOffset(boolean)} on each
* Airspace instance in the layer.
*/
public void setEnableDepthOffset(boolean enable)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Use {@link gov.nasa.worldwind.render.ShapeAttributes#isEnableLighting()} on each Airspace instance in
* the layer.
*/
public boolean isEnableLighting()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enable ignored.
*
* @deprecated Use {@link gov.nasa.worldwind.render.ShapeAttributes#isEnableLighting()} on each Airspace instance in
* the layer.
*/
public void setEnableLighting(boolean enable)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Control over drawing Airspace extents is no longer supported.
*/
public boolean isDrawExtents()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param draw ignored
*
* @deprecated Control over drawing Airspace extents is no longer supported.
*/
public void setDrawExtents(boolean draw)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Control over drawing Airspace in wireframe mode is no longer supported.
*/
public boolean isDrawWireframe()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param draw ignored
*
* @deprecated Control over drawing Airspace in wireframe mode is no longer supported.
*/
public void setDrawWireframe(boolean draw)
{
// deprecated method
}
/**
* Returns 0.
*
* @return 0
*
* @deprecated Control over Airspace depth offset is no longer supported. See {@link
* gov.nasa.worldwind.render.airspaces.Airspace#setEnableDepthOffset(boolean)}.
*/
public Double getDepthOffsetFactor()
{
return 0d; // deprecated method
}
/**
* Does nothing.
*
* @param factor ignored
*
* @deprecated Control over Airspace depth factor is no longer supported. See {@link
* gov.nasa.worldwind.render.airspaces.Airspace#setEnableDepthOffset(boolean)}.
*/
public void setDepthOffsetFactor(Double factor)
{
// deprecated method
}
/**
* Returns 0.
*
* @return 0
*
* @deprecated Control over Airspace depth units is no longer supported. See {@link
* gov.nasa.worldwind.render.airspaces.Airspace#setEnableDepthOffset(boolean)}.
*/
public Double getDepthOffsetUnits()
{
return 0d; // deprecated method
}
/**
* Does nothing.
*
* @param units ignored
*
* @deprecated Control over Airspace depth units is no longer supported. See {@link
* gov.nasa.worldwind.render.airspaces.Airspace#setEnableDepthOffset(boolean)}.
*/
public void setDepthOffsetUnits(Double units)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#isEnableBatchRendering()} on each Airspace
* instance in the layer.
*/
public boolean isEnableBatchRendering()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enableBatchRendering ignored
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#setEnableBatchRendering(boolean)} on each
* Airspace instance in the layer.
*/
public void setEnableBatchRendering(boolean enableBatchRendering)
{
// deprecated method
}
/**
* Returns false.
*
* @return false
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#isEnableBatchPicking()} on each Airspace
* instance in the layer.
*/
public boolean isEnableBatchPicking()
{
return false; // deprecated method
}
/**
* Does nothing.
*
* @param enableBatchPicking ignored
*
* @deprecated Use {@link gov.nasa.worldwind.render.airspaces.Airspace#setEnableBatchPicking(boolean)} on each
* Airspace instance in the layer.
*/
public void setEnableBatchPicking(boolean enableBatchPicking)
{
// deprecated method
}
@Override
protected void doPick(DrawContext dc, java.awt.Point pickPoint)
{
for (Airspace airspace : this.getActiveAirspaces())
{
try
{
if (airspace != null) // caller-specified Iterables can include null elements
airspace.render(dc);
}
catch (Exception e)
{
String msg = Logging.getMessage("generic.ExceptionWhileRenderingAirspace");
Logging.logger().log(java.util.logging.Level.SEVERE, msg, e);
// continue to next airspace
}
}
}
@Override
protected void doRender(DrawContext dc)
{
for (Airspace airspace : this.getActiveAirspaces())
{
try
{
if (airspace != null) // caller-specified Iterables can include null elements
airspace.render(dc);
}
catch (Exception e)
{
String msg = Logging.getMessage("generic.ExceptionWhileRenderingAirspace");
Logging.logger().log(java.util.logging.Level.SEVERE, msg, e);
// continue to next airspace
}
}
}
@Override
public String toString()
{
return Logging.getMessage("layers.AirspaceLayer.Name");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy