gov.nasa.worldwind.render.BasicShapeAttributes 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.render;
import gov.nasa.worldwind.Exportable;
import gov.nasa.worldwind.ogc.kml.KMLConstants;
import gov.nasa.worldwind.ogc.kml.impl.KMLExportUtil;
import gov.nasa.worldwind.util.*;
import javax.xml.stream.*;
import java.awt.*;
import java.io.*;
import static gov.nasa.worldwind.ogc.kml.impl.KMLExportUtil.kmlBoolean;
/**
* Basic implementation of the {@link gov.nasa.worldwind.render.ShapeAttributes} interface.
*
* @author dcollins
* @version $Id: BasicShapeAttributes.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public class BasicShapeAttributes implements ShapeAttributes
{
/** Indicates whether or not some of the shape's attributes are unresolved. Initially false. */
protected boolean unresolved;
/** Indicates whether or not the shape's interior is drawn. Initially false. */
protected boolean drawInterior;
/** Indicates whether or not the shape's outline is drawn. Initially false. */
protected boolean drawOutline;
/** Indicates whether or not the shape should be rendered with smooth lines and edges. Initially false. */
protected boolean enableAntialiasing;
/** Indicates whether lighting is applied to the shape. Initially false. */
protected boolean enableLighting;
/** Indicates the material properties of the shape's interior. Initially null. */
protected Material interiorMaterial;
/** Indicates the material properties of the shape's outline. Initially null. */
protected Material outlineMaterial;
/** Indicates the opacity of the shape's interior as a floating-point value in the range 0.0 to 1.0. Initially 0.0. */
protected double interiorOpacity;
/** Indicates the opacity of the shape's outline as a floating-point value in the range 0.0 to 1.0. Initially 0.0. */
protected double outlineOpacity;
/** Indicates the line width (in pixels) used when rendering the shape's outline. Initially 0.0. */
protected double outlineWidth;
/** Indicates the number of times each bit in the outline stipple pattern is repeated. Initially 0. */
protected int outlineStippleFactor;
/** Indicates the 16-bit integer that defines which pixels are rendered in the shape's outline. Initially 0. */
protected short outlineStipplePattern;
/** Indicates the image source that is applied as a texture to the shape's interior. Initially null. */
protected Object imageSource;
/** Indicates the amount the balloon's texture is scaled by as a floating-point value. Initially 0.0. */
protected double imageScale;
/**
* Creates a new BasicShapeAttributes with the default attributes. The default attributes are as
* follows:
*
* Attribute Default Value unresolved truedrawInterior truedrawOutline trueenableAntialiasing trueenableLighting falseinteriorMaterial {@link gov.nasa.worldwind.render.Material#WHITE} outlineMaterial {@link gov.nasa.worldwind.render.Material#BLACK} interiorOpacity 1.0 outlineOpacity 1.0 outlineWidth 1.0 outlineStippleFactor 0 outlineStipplePattern 0xF0F0 imageSource nullimageScale 1.0
*/
public BasicShapeAttributes()
{
// Note: update the above constructor comment if these defaults change.
this.drawInterior = true;
this.drawOutline = true;
this.enableAntialiasing = true;
this.enableLighting = false;
this.interiorMaterial = Material.WHITE;
this.outlineMaterial = Material.BLACK;
this.interiorOpacity = 1;
this.outlineOpacity = 1;
this.outlineWidth = 1;
this.outlineStippleFactor = 0;
this.outlineStipplePattern = (short) 0xF0F0;
this.imageSource = null;
this.imageScale = 1;
}
/**
* Creates a new BasicShapeAttributes configured with the specified attributes.
*
* @param attributes the attributes to configure the new BasicShapeAttributes with.
*
* @throws IllegalArgumentException if attributes is null.
*/
public BasicShapeAttributes(ShapeAttributes attributes)
{
if (attributes == null)
{
String message = Logging.getMessage("nullValue.AttributesIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.drawInterior = attributes.isDrawInterior();
this.drawOutline = attributes.isDrawOutline();
this.enableAntialiasing = attributes.isEnableAntialiasing();
this.enableLighting = attributes.isEnableLighting();
this.interiorMaterial = attributes.getInteriorMaterial();
this.outlineMaterial = attributes.getOutlineMaterial();
this.interiorOpacity = attributes.getInteriorOpacity();
this.outlineOpacity = attributes.getOutlineOpacity();
this.outlineWidth = attributes.getOutlineWidth();
this.outlineStippleFactor = attributes.getOutlineStippleFactor();
this.outlineStipplePattern = attributes.getOutlineStipplePattern();
this.imageSource = attributes.getImageSource();
this.imageScale = attributes.getImageScale();
}
/** {@inheritDoc} */
public ShapeAttributes copy()
{
return new BasicShapeAttributes(this);
}
/** {@inheritDoc} */
public void copy(ShapeAttributes attributes)
{
if (attributes != null)
{
this.drawInterior = attributes.isDrawInterior();
this.drawOutline = attributes.isDrawOutline();
this.enableAntialiasing = attributes.isEnableAntialiasing();
this.enableLighting = attributes.isEnableLighting();
this.interiorMaterial = attributes.getInteriorMaterial();
this.outlineMaterial = attributes.getOutlineMaterial();
this.interiorOpacity = attributes.getInteriorOpacity();
this.outlineOpacity = attributes.getOutlineOpacity();
this.outlineWidth = attributes.getOutlineWidth();
this.outlineStippleFactor = attributes.getOutlineStippleFactor();
this.outlineStipplePattern = attributes.getOutlineStipplePattern();
this.imageSource = attributes.getImageSource();
this.imageScale = attributes.getImageScale();
}
}
/** {@inheritDoc} */
public boolean isUnresolved()
{
return unresolved;
}
/** {@inheritDoc} */
public void setUnresolved(boolean unresolved)
{
this.unresolved = unresolved;
}
/** {@inheritDoc} */
public boolean isDrawInterior()
{
return this.drawInterior;
}
/** {@inheritDoc} */
public void setDrawInterior(boolean draw)
{
this.drawInterior = draw;
}
/** {@inheritDoc} */
public boolean isDrawOutline()
{
return this.drawOutline;
}
/** {@inheritDoc} */
public void setDrawOutline(boolean draw)
{
this.drawOutline = draw;
}
/** {@inheritDoc} */
public boolean isEnableAntialiasing()
{
return this.enableAntialiasing;
}
/** {@inheritDoc} */
public void setEnableAntialiasing(boolean enable)
{
this.enableAntialiasing = enable;
}
/** {@inheritDoc} */
public boolean isEnableLighting()
{
return enableLighting;
}
/** {@inheritDoc} */
public void setEnableLighting(boolean enableLighting)
{
this.enableLighting = enableLighting;
}
/** {@inheritDoc} */
public Material getInteriorMaterial()
{
return this.interiorMaterial;
}
/** {@inheritDoc} */
public void setInteriorMaterial(Material material)
{
if (material == null)
{
String message = Logging.getMessage("nullValue.MaterialIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.interiorMaterial = material;
}
/** {@inheritDoc} */
public Material getOutlineMaterial()
{
return this.outlineMaterial;
}
/** {@inheritDoc} */
public void setOutlineMaterial(Material material)
{
if (material == null)
{
String message = Logging.getMessage("nullValue.MaterialIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.outlineMaterial = material;
}
/** {@inheritDoc} */
public double getInteriorOpacity()
{
return this.interiorOpacity;
}
/** {@inheritDoc} */
public void setInteriorOpacity(double opacity)
{
if (opacity < 0 || opacity > 1)
{
String message = Logging.getMessage("generic.OpacityOutOfRange", opacity);
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.interiorOpacity = opacity;
}
/** {@inheritDoc} */
public double getOutlineOpacity()
{
return this.outlineOpacity;
}
/** {@inheritDoc} */
public void setOutlineOpacity(double opacity)
{
if (opacity < 0 || opacity > 1)
{
String message = Logging.getMessage("generic.OpacityOutOfRange", opacity);
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.outlineOpacity = opacity;
}
/** {@inheritDoc} */
public double getOutlineWidth()
{
return this.outlineWidth;
}
/** {@inheritDoc} */
public void setOutlineWidth(double width)
{
if (width < 0)
{
String message = Logging.getMessage("Geom.WidthIsNegative", width);
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.outlineWidth = width;
}
/** {@inheritDoc} */
public int getOutlineStippleFactor()
{
return this.outlineStippleFactor;
}
/** {@inheritDoc} */
public void setOutlineStippleFactor(int factor)
{
if (factor < 0)
{
String message = Logging.getMessage("generic.ArgumentOutOfRange", "factor < 0");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.outlineStippleFactor = factor;
}
/** {@inheritDoc} */
public short getOutlineStipplePattern()
{
return this.outlineStipplePattern;
}
/** {@inheritDoc} */
public void setOutlineStipplePattern(short pattern)
{
this.outlineStipplePattern = pattern;
}
/** {@inheritDoc} */
public Object getImageSource()
{
return this.imageSource;
}
/** {@inheritDoc} */
public void setImageSource(Object imageSource)
{
// Can be null
this.imageSource = imageSource;
}
/** {@inheritDoc} */
public double getImageScale()
{
return this.imageScale;
}
/** {@inheritDoc} */
public void setImageScale(double scale)
{
if (scale <= 0)
{
String message = Logging.getMessage("generic.ScaleOutOfRange", scale);
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.imageScale = scale;
}
/** {@inheritDoc} */
public void getRestorableState(RestorableSupport rs, RestorableSupport.StateObject so)
{
if (rs == null)
{
String message = Logging.getMessage("nullValue.RestorableSupportIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
rs.addStateValueAsBoolean(so, "drawInterior", this.isDrawInterior());
rs.addStateValueAsBoolean(so, "drawOutline", this.isDrawOutline());
rs.addStateValueAsBoolean(so, "enableAntialiasing", this.isEnableAntialiasing());
rs.addStateValueAsBoolean(so, "enableLighting", this.isEnableLighting());
this.getInteriorMaterial().getRestorableState(rs, rs.addStateObject(so, "interiorMaterial"));
this.getOutlineMaterial().getRestorableState(rs, rs.addStateObject(so, "outlineMaterial"));
rs.addStateValueAsDouble(so, "interiorOpacity", this.getInteriorOpacity());
rs.addStateValueAsDouble(so, "outlineOpacity", this.getOutlineOpacity());
rs.addStateValueAsDouble(so, "outlineWidth", this.getOutlineWidth());
rs.addStateValueAsInteger(so, "outlineStippleFactor", this.getOutlineStippleFactor());
rs.addStateValueAsInteger(so, "outlineStipplePattern", this.getOutlineStipplePattern());
if (this.getImageSource() != null && this.getImageSource() instanceof String)
rs.addStateValueAsString(so, "interiorImagePath", (String) this.getImageSource());
rs.addStateValueAsDouble(so, "interiorImageScale", this.getImageScale());
}
/** {@inheritDoc} */
public void restoreState(RestorableSupport rs, RestorableSupport.StateObject so)
{
if (rs == null)
{
String message = Logging.getMessage("nullValue.RestorableSupportIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
Boolean b = rs.getStateValueAsBoolean(so, "drawInterior");
if (b != null)
this.setDrawInterior(b);
b = rs.getStateValueAsBoolean(so, "drawOutline");
if (b != null)
this.setDrawOutline(b);
b = rs.getStateValueAsBoolean(so, "enableAntialiasing");
if (b != null)
this.setEnableAntialiasing(b);
b = rs.getStateValueAsBoolean(so, "enableLighting");
if (b != null)
this.setEnableLighting(b);
RestorableSupport.StateObject mo = rs.getStateObject(so, "interiorMaterial");
if (mo != null)
this.setInteriorMaterial(this.getInteriorMaterial().restoreState(rs, mo));
mo = rs.getStateObject(so, "outlineMaterial");
if (mo != null)
this.setOutlineMaterial(this.getOutlineMaterial().restoreState(rs, mo));
Double d = rs.getStateValueAsDouble(so, "interiorOpacity");
if (d != null)
this.setInteriorOpacity(d);
d = rs.getStateValueAsDouble(so, "outlineOpacity");
if (d != null)
this.setOutlineOpacity(d);
d = rs.getStateValueAsDouble(so, "outlineWidth");
if (d != null)
this.setOutlineWidth(d);
Integer i = rs.getStateValueAsInteger(so, "outlineStippleFactor");
if (i != null)
this.setOutlineStippleFactor(i);
i = rs.getStateValueAsInteger(so, "outlineStipplePattern");
if (i != null)
this.setOutlineStipplePattern(i.shortValue());
String s = rs.getStateValueAsString(so, "interiorImagePath");
if (s != null)
this.setImageSource(s);
d = rs.getStateValueAsDouble(so, "interiorImageScale");
if (d != null)
this.setImageScale(d);
}
@Override
public boolean equals(Object o)
{
if (this == o)
return true;
if (o == null || this.getClass() != o.getClass())
return false;
BasicShapeAttributes that = (BasicShapeAttributes) o;
if (this.unresolved != that.unresolved)
return false;
if (this.drawInterior != that.drawInterior)
return false;
if (this.drawOutline != that.drawOutline)
return false;
if (this.enableAntialiasing != that.enableAntialiasing)
return false;
if (this.enableLighting != that.enableLighting)
return false;
if (this.interiorMaterial != null ? !this.interiorMaterial.equals(that.interiorMaterial)
: that.interiorMaterial != null)
return false;
if (this.outlineMaterial != null ? !this.outlineMaterial.equals(that.outlineMaterial)
: that.outlineMaterial != null)
return false;
if (Double.compare(this.interiorOpacity, that.interiorOpacity) != 0)
return false;
if (Double.compare(this.outlineOpacity, that.outlineOpacity) != 0)
return false;
if (Double.compare(this.outlineWidth, that.outlineWidth) != 0)
return false;
if (this.outlineStippleFactor != that.outlineStippleFactor)
return false;
if (this.outlineStipplePattern != that.outlineStipplePattern)
return false;
if (this.imageSource != null ? !this.imageSource.equals(that.imageSource) : that.imageSource != null)
return false;
//noinspection RedundantIfStatement
if (Double.compare(this.imageScale, that.imageScale) != 0)
return false;
return true;
}
@Override
public int hashCode()
{
int result;
long temp;
result = (this.unresolved ? 1 : 0);
result = 31 * result + (this.drawInterior ? 1 : 0);
result = 31 * result + (this.drawOutline ? 1 : 0);
result = 31 * result + (this.enableAntialiasing ? 1 : 0);
result = 31 * result + (this.enableLighting ? 1 : 0);
result = 31 * result + (this.interiorMaterial != null ? this.interiorMaterial.hashCode() : 0);
result = 31 * result + (this.outlineMaterial != null ? this.outlineMaterial.hashCode() : 0);
temp = this.interiorOpacity != +0.0d ? Double.doubleToLongBits(this.interiorOpacity) : 0L;
result = 31 * result + (int) (temp ^ (temp >>> 32));
temp = this.outlineOpacity != +0.0d ? Double.doubleToLongBits(this.outlineOpacity) : 0L;
result = 31 * result + (int) (temp ^ (temp >>> 32));
temp = this.outlineWidth != +0.0d ? Double.doubleToLongBits(this.outlineWidth) : 0L;
result = 31 * result + (int) (temp ^ (temp >>> 32));
result = 31 * result + this.outlineStippleFactor;
result = 31 * result + (int) this.outlineStipplePattern;
result = 31 * result + (this.imageSource != null ? this.imageSource.hashCode() : 0);
temp = this.imageScale != +0.0d ? Double.doubleToLongBits(this.imageScale) : 0L;
result = 31 * result + (int) (temp ^ (temp >>> 32));
return result;
}
/** {@inheritDoc} */
public String isExportFormatSupported(String mimeType)
{
if (KMLConstants.KML_MIME_TYPE.equalsIgnoreCase(mimeType))
return Exportable.FORMAT_SUPPORTED;
else
return Exportable.FORMAT_NOT_SUPPORTED;
}
/** {@inheritDoc} */
public void export(String mimeType, Object output) throws IOException, UnsupportedOperationException
{
if (mimeType == null)
{
String message = Logging.getMessage("nullValue.Format");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (output == null)
{
String message = Logging.getMessage("nullValue.OutputBufferIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (KMLConstants.KML_MIME_TYPE.equalsIgnoreCase(mimeType))
{
try
{
exportAsKML(output);
}
catch (XMLStreamException e)
{
Logging.logger().throwing(getClass().getName(), "export", e);
throw new IOException(e);
}
}
else
{
String message = Logging.getMessage("Export.UnsupportedFormat", mimeType);
Logging.logger().warning(message);
throw new UnsupportedOperationException(message);
}
}
/**
* Export the placemark attributes to KML as a {@code