VectorObject

java.lang.Object
- com.mousebird.maply.VectorObject

All Implemented Interfaces:

java.lang.Iterable<VectorObject>
```
public class VectorObject
extends java.lang.Object
implements java.lang.Iterable<VectorObject>
```
The Maply VectorObject represents a group of vector features. There can be a single point in here, multiple points, or even a combination of points, areals, and linears.
You can create these yourself, but they are typically read from data files, such as GeoJSON or Shapefiles.
The VectorObject is meant to be somewhat opaque (but not as opaque as originally planned). If you need to do a lot of manipulation of your vector data, it's best ot do it elsewhere and then convert to a VectorObject.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VectorObject.MaplyVectorObjectType

Nested Classes
Modifier and Type	Class and Description
`static class`	`VectorObject.MaplyVectorObjectType`

Constructor Summary

Constructors
Constructor and Description

VectorObject()
Construct empty.

Constructors
Constructor and Description
`VectorObject()` Construct empty.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAreal(Point2d[] pts)` Add an areal feature with one external loop.
`void`	`addAreal(Point2d[] ext, Point2d[][] holes)` Add an areal feature with a single exterior loop and one or more interior loops.
`void`	`addLinear(Point2d[] pts)` Add a linear feature
`void`	`addPoint(Point2d pt)` Add a single point
`VectorObject`	`arealsToLinears()` Convert any areal features to linears (just the outline) and return a new vector object or null.
`double`	`areaOfOuterLoops()` Area of all the out loops together.
`boolean`	`boundingBox(Point2d ll, Point2d ur)` Bounding box of all the various features together
`Point2d`	`center()` Calculate the center (not the centroid).
`Point2d`	`centroid()` Calculate the centroid of the object.
`VectorObject`	`clipToGrid(Point2d size)` Clip the given areal features to a grid of the given size.
`VectorObject`	`clipToMbr(Mbr mbr)` Clip the given features to an Mbr
`int`	`countPoints()` Returns the total number of points in a feature.
`VectorObject`	`deepCopy()` Make a complete copy of the vector object and return it.
`protected void`	`deepCopyNative(VectorObject vecObj)`
`VectorObject`	`filterClippedEdges()` Filter out edges created from clipping areal features on the server.
`void`	`finalize()`
`boolean`	`fromGeoJSON(java.lang.String json)` Load vector objects from a GeoJSON string.
`static java.util.Map<java.lang.String,VectorObject>`	`FromGeoJSONAssembly(java.lang.String json)` Load vector objects from a GeoJSON assembly, which is just a bunch of GeoJSON stuck together.
`boolean`	`fromShapeFile(java.lang.String fileName)` Load vector objects from a Shapefile.
`AttrDictionary`	`getAttributes()` Return attributes for the feature.
`boolean`	`getSelectable()` On if this features is selectable.
`VectorObject.MaplyVectorObjectType`	`getVectorType()` The vector type is one of point, linear, linear3d, areal, or a combination.
`VectorIterator`	`iterator()` Vector objects can be made of lots of smaller objects.
`Point2d`	`largestLoopCenter(Point2d ll, Point2d ur)` Find the largest loop and return its center.
`double`	`linearMiddle(Point2d middle)` Calculate the midpoint of a multi-point line.
`double`	`linearMiddle(Point2d middle, CoordSystem coordSys)` Calculate the midpoint of a multi-point line.
`VectorObject`	`linearsToAreals()` Convert any linears features into areals, by closing them and return a new vector object or null.
`void`	`mergeVectorsFrom(VectorObject other)` Merge the vectors from the other vector object into this one.
`boolean`	`middleCoordinate(Point2d middle)` Return the point right in the middle (index-wise) of a linear features.
`boolean`	`pointInside(Point2d pt)` Return true if the given point (in geo radians) is inside the vector feature.
`VectorObject`	`reproject(CoordSystem srcSystem, double scale, CoordSystem destSystem)` Reproject the vectors from the given system (geographic, by default) into the destination coordinate system.
`void`	`setAttributes(AttrDictionary attrs)` Reset the attributes for the feature.
`void`	`setSelectable(boolean newSelect)` Turn this on if you want the vector object to be selectable.
`VectorObject`	`subdivideToFlatGreatCircle(double epsilon)` Subdivide the edges in this feature to a given tolerance, using great circle math.
`VectorObject`	`subdivideToGlobe(double epsilon)` Subdivide the edges in this feature to a given tolerance.
`VectorObject`	`subdivideToGlobeGreatCircle(double epsilon)` Subdivide the edges in this feature to a given tolerance, using great circle math.
`VectorObject`	`tesselate()` Tesselate the areal features and return a new vector object.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - VectorObject
```
public VectorObject()
```
    Construct empty.
- Method Detail
  - getVectorType
```
public VectorObject.MaplyVectorObjectType getVectorType()
```
    The vector type is one of point, linear, linear3d, areal, or a combination.
  - setSelectable
```
public void setSelectable(boolean newSelect)
```
    Turn this on if you want the vector object to be selectable.
  - getSelectable
```
public boolean getSelectable()
```
    On if this features is selectable.
  - getAttributes
```
public AttrDictionary getAttributes()
```
    Return attributes for the feature. If there are multiple features, we get the first one.
  - setAttributes
```
public void setAttributes(AttrDictionary attrs)
```
    Reset the attributes for the feature.
  - addPoint
```
public void addPoint(Point2d pt)
```
    Add a single point
  - addLinear
```
public void addLinear(Point2d[] pts)
```
    Add a linear feature
  - addAreal
```
public void addAreal(Point2d[] pts)
```
    Add an areal feature with one external loop.
  - addAreal
```
public void addAreal(Point2d[] ext,
                     Point2d[][] holes)
```
    Add an areal feature with a single exterior loop and one or more interior loops.
  - mergeVectorsFrom
```
public void mergeVectorsFrom(VectorObject other)
```
    Merge the vectors from the other vector object into this one.
  - iterator
```
public VectorIterator iterator()
```
    Vector objects can be made of lots of smaller objects. If you need to access each of this individually, this iterator will handle that efficiently.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<VectorObject>
  - center
```
public Point2d center()
```
    Calculate the center (not the centroid).
  - centroid
```
public Point2d centroid()
```
    Calculate the centroid of the object. This assumes we've got at least one areal loop.
    
    Returns:
    
    Centroid of the object.
  - largestLoopCenter
```
public Point2d largestLoopCenter(Point2d ll,
                                 Point2d ur)
```
    Find the largest loop and return its center. Also returns the bounding box the loop.
    
    Parameters:
    
    ll - Lower left corner of the largest loop.
    
    ur - Upper right corner of the largest loop.
    
    Returns:
    
    Center of the largest loop.
  - linearMiddle
```
public double linearMiddle(Point2d middle)
```
    Calculate the midpoint of a multi-point line. Also return the rotation.
    
    Parameters:
    
    middle - Midpoint of the line
    
    Returns:
    
    Orientation along the long at that point
  - linearMiddle
```
public double linearMiddle(Point2d middle,
                           CoordSystem coordSys)
```
    Calculate the midpoint of a multi-point line. Also return the rotation. Does its work in the coordinate system passed in
    
    Parameters:
    
    middle - Midpoint of the line
    
    coordSys - Coordinate system to project into first.
    
    Returns:
    
    Orientation along the long at that point
  - middleCoordinate
```
public boolean middleCoordinate(Point2d middle)
```
    Return the point right in the middle (index-wise) of a linear features.
    
    Parameters:
    
    middle - Return point
    
    Returns:
    
    True if this was a linear
  - pointInside
```
public boolean pointInside(Point2d pt)
```
    Return true if the given point (in geo radians) is inside the vector feature. Only makes sense with areals.
  - areaOfOuterLoops
```
public double areaOfOuterLoops()
```
    Area of all the out loops together.
  - countPoints
```
public int countPoints()
```
    Returns the total number of points in a feature. Used for assessing size.
  - boundingBox
```
public boolean boundingBox(Point2d ll,
                           Point2d ur)
```
    Bounding box of all the various features together
  - subdivideToGlobe
```
public VectorObject subdivideToGlobe(double epsilon)
```
    Subdivide the edges in this feature to a given tolerance. This will break up long edges in a vector until they lie flat on a globe to a given epsilon. The epislon is in display coordinates (radius = 1.0). This routine breaks this up along geographic boundaries.
  - subdivideToGlobeGreatCircle
```
public VectorObject subdivideToGlobeGreatCircle(double epsilon)
```
    Subdivide the edges in this feature to a given tolerance, using great circle math. This will break up long edges in a vector until they lie flat on a globe to a given epsilon using a great circle route. The epsilon is in display coordinates (radius = 1.0).
  - subdivideToFlatGreatCircle
```
public VectorObject subdivideToFlatGreatCircle(double epsilon)
```
    Subdivide the edges in this feature to a given tolerance, using great circle math. This version samples a great circle to display on a flat map.
  - tesselate
```
public VectorObject tesselate()
```
    Tesselate the areal features and return a new vector object.
  - clipToGrid
```
public VectorObject clipToGrid(Point2d size)
```
    Clip the given areal features to a grid of the given size.
  - clipToMbr
```
public VectorObject clipToMbr(Mbr mbr)
```
    Clip the given features to an Mbr
  - reproject
```
public VectorObject reproject(CoordSystem srcSystem,
                              double scale,
                              CoordSystem destSystem)
```
    Reproject the vectors from the given system (geographic, by default) into the destination coordinate system. We don't explicitly track units, so if the coordinates need to be scaled, pass that in as well.
    
    Parameters:
    
    srcSystem - Source coordinate system (that the data is already in)
    
    scale - Scale factor to apply to the coordinates. 1.0 is a good default.
    
    destSystem - Destination coordinate system that we'll project data into.
    
    Returns:
    
    The new vector object or null.
  - filterClippedEdges
```
public VectorObject filterClippedEdges()
```
    Filter out edges created from clipping areal features on the server. In some very specific cases (OSM water) we get polygons that are obviously clipped along internal boundaries. We can clear this up with some very, very specific logic. Input must be closed areals and output is linears.
    
    Returns:
    
    The filtered vector object or null.
  - linearsToAreals
```
public VectorObject linearsToAreals()
```
    Convert any linears features into areals, by closing them and return a new vector object or null.
  - arealsToLinears
```
public VectorObject arealsToLinears()
```
    Convert any areal features to linears (just the outline) and return a new vector object or null.
  - fromGeoJSON
```
public boolean fromGeoJSON(java.lang.String json)
```
    Load vector objects from a GeoJSON string.
    
    Parameters:
    
    json - The GeoSJON string, presumably read from a file or over the network
    
    Returns:
    
    false if we were unable to parse the GeoJSON
  - fromShapeFile
```
public boolean fromShapeFile(java.lang.String fileName)
```
    Load vector objects from a Shapefile.
    
    Parameters:
    
    fileName - The filename of the Shapefile.
    
    Returns:
    
    false if we were unable to parse the Shapefile.
  - deepCopy
```
public VectorObject deepCopy()
```
    Make a complete copy of the vector object and return it.
  - deepCopyNative
```
protected void deepCopyNative(VectorObject vecObj)
```
  - FromGeoJSONAssembly
```
public static java.util.Map<java.lang.String,VectorObject> FromGeoJSONAssembly(java.lang.String json)
```
    Load vector objects from a GeoJSON assembly, which is just a bunch of GeoJSON stuck together.
    
    Parameters:
    
    json -
    
    Returns:
  - finalize
```
public void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class VectorObject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

VectorObject

Method Detail

getVectorType

setSelectable

getSelectable

getAttributes

setAttributes

addPoint

addLinear

addAreal

addAreal

mergeVectorsFrom

iterator

center

centroid

largestLoopCenter

linearMiddle

linearMiddle

middleCoordinate

pointInside

areaOfOuterLoops

countPoints

boundingBox

subdivideToGlobe

subdivideToGlobeGreatCircle

subdivideToFlatGreatCircle

tesselate

clipToGrid

clipToMbr

reproject

filterClippedEdges

linearsToAreals

arealsToLinears

fromGeoJSON

fromShapeFile

deepCopy

deepCopyNative

FromGeoJSONAssembly

finalize