src.gov.nasa.worldwind.formats.shapefile.ShapefileRecordMultiPoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation
Show all versions of worldwindx Show documentation
World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.
/*
* 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.formats.shapefile;
import javax.xml.stream.*;
import java.io.IOException;
import java.nio.ByteBuffer;
/**
* Represents a Shapefile record with a multi point shape type. Multi-point shapes represent a set of x,y coordinate
* pairs.
*
* Multi-points may have optional z-coordinates or m-coordinates that accompany each x,y coordinate pair. If a
* Multi-point has z-coordinates, then {@link #getZValues()} returns a non-null array of
* values. If a Multi-point has m-coordinates, then {@link #getMValues()} returns a non-null
* array of values.
*
* @author tag
* @version $Id: ShapefileRecordMultiPoint.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public class ShapefileRecordMultiPoint extends ShapefileRecord
{
protected double[] boundingRectangle;
protected double[] zRange; // non-null only for Z types
protected double[] zValues; // non-null only for Z types
protected double[] mRange; // will be null if no measures
protected double[] mValues; // will be null if no measures
/** {@inheritDoc} */
public ShapefileRecordMultiPoint(Shapefile shapeFile, ByteBuffer buffer)
{
super(shapeFile, buffer);
}
/**
* Returns a four-element array containing the record's bounding rectangle, or null if record parsing failed. The
* returned array is ordered as follows: minimum Y, maximum Y, minimum X, and maximum X. If the Shapefile's
* coordinate system is geographic, the elements can be interpreted as angular degrees in the order minimum
* latitude, maximum latitude, minimum longitude, and maximum longitude.
*
* @return the record's bounding rectangle, or null to denote the record parsing failed.
*/
public double[] getBoundingRectangle()
{
return this.boundingRectangle != null ? this.boundingRectangle : null;
}
/**
* Returns an iterator over all the points X and Y coordinates for a specified part of this record. Part numbers
* start at zero.
*
* @param partNumber the number of the part of this record - zero based.
*
* @return an {@link Iterable} over the points X and Y coordinates.
*/
public Iterable getPoints(int partNumber)
{
return this.getPointBuffer(partNumber).getCoords();
}
/**
* Returns the shape's Z range.
*
* @return the shape's Z range. The range minimum is at index 0, the maximum at index 1.
*/
public double[] getZRange()
{
return this.zRange;
}
/**
* Returns the shape's Z values.
*
* @return the shape's Z values.
*/
public double[] getZValues()
{
return this.zValues;
}
/**
* Returns the shape's optional measure range.
*
* @return the shape's measure range, or null if no measures are in the record. The range minimum is at index 0, the
* maximum at index 1.
*/
public double[] getMRange()
{
return this.mRange;
}
/**
* Returns the shape's optional measure values.
*
* @return the shape's measure values, or null if no measures are in the record.
*/
public double[] getMValues()
{
return this.mValues;
}
protected void doReadFromBuffer(Shapefile shapefile, ByteBuffer buffer)
{
// Read the bounding rectangle.
Shapefile.BoundingRectangle rect = shapefile.readBoundingRectangle(buffer);
this.boundingRectangle = rect.coords;
// Specify that the record's points should be normalized if the bounding rectangle is normalized. Ignore the
// shapefile's normalizePoints property to avoid normalizing records that don't need it.
if (rect.isNormalized)
this.setNormalizePoints(true);
// Read the number of points.
this.numberOfParts = 1;
this.numberOfPoints = buffer.getInt();
this.firstPartNumber = -1;
if (this.numberOfPoints > 0)
{
// Add the record's points to the Shapefile's point buffer, and record this record's part offset in the
// Shapefile's point buffer.
this.firstPartNumber = shapefile.addPoints(this, buffer, this.numberOfPoints);
}
// Read the optional Z value.
if (this.isZType())
this.readZ(buffer);
// Read the optional measure value.
if (this.isMeasureType())
this.readOptionalMeasures(buffer);
}
/**
* Read's the shape's Z values from the record buffer.
*
* @param buffer the record buffer to read from.
*/
protected void readZ(ByteBuffer buffer)
{
this.zRange = ShapefileUtils.readDoubleArray(buffer, 2);
this.zValues = ShapefileUtils.readDoubleArray(buffer, this.getNumberOfPoints());
}
/**
* Reads any optional measure values from the record buffer.
*
* @param buffer the record buffer to read from.
*/
protected void readOptionalMeasures(ByteBuffer buffer)
{
// Measure values are optional.
if (buffer.hasRemaining() && (buffer.limit() - buffer.position()) >= (this.getNumberOfPoints() * 8))
{
this.mRange = ShapefileUtils.readDoubleArray(buffer, 2);
this.mValues = ShapefileUtils.readDoubleArray(buffer, this.getNumberOfPoints());
}
}
/**
* Export the record to KML as a {@code } element.
*
* @param xmlWriter XML writer to receive the generated KML.
*
* @throws javax.xml.stream.XMLStreamException
* If an exception occurs while writing the KML
* @throws java.io.IOException If an exception occurs while exporting the data.
*/
@Override
public void exportAsKML(XMLStreamWriter xmlWriter) throws IOException, XMLStreamException
{
xmlWriter.writeStartElement("Placemark");
xmlWriter.writeStartElement("name");
xmlWriter.writeCharacters(Integer.toString(this.getRecordNumber()));
xmlWriter.writeEndElement();
// Write geometry
xmlWriter.writeStartElement("MultiGeometry");
String altitudeMode = this.isZType() ? "absolute" : "clampToGround";
Iterable points = this.getPoints(0);
double[] zValues = this.getZValues();
int index = 0;
for (double[] point : points)
{
xmlWriter.writeStartElement("Point");
double z = 0.0;
if (zValues != null && index < zValues.length)
z = zValues[index];
xmlWriter.writeStartElement("altitudeMode");
xmlWriter.writeCharacters(altitudeMode);
xmlWriter.writeEndElement();
String coordString = String.format("%f,%f,%f", point[0], point[1], z);
xmlWriter.writeStartElement("coordinates");
xmlWriter.writeCharacters(coordString);
xmlWriter.writeEndElement();
xmlWriter.writeEndElement(); // Point
index++;
}
xmlWriter.writeEndElement(); // MultiGeometry
xmlWriter.writeEndElement(); // Placemark
xmlWriter.flush();
}
}