org.opentrafficsim.core.geometry

Class OTSPolygon3D

java.lang.Object

org.opentrafficsim.core.geometry.OTSLine3D

org.opentrafficsim.core.geometry.OTSPolygon3D

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface

public class OTSPolygon3D
extends OTSLine3D

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.geometry.OTSLine3D

OTSLine3D.OffsetMethod

Field Summary

Fields inherited from class org.opentrafficsim.core.geometry.OTSLine3D

OFFSETMETHOD

Constructor Summary

Constructors

Constructor and Description
OTSPolygon3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)
OTSPolygon3D(com.vividsolutions.jts.geom.Geometry geometry)
OTSPolygon3D(com.vividsolutions.jts.geom.LineString lineString)
OTSPolygon3D(OTSPoint3D[] points)

Method Summary

Modifier and Type	Method and Description
boolean	contains(OTSPoint3D point) Determine if a point is horizontally (ignoring Z-coordinates) contained within this OTSPolygon3D.

Methods inherited from class org.opentrafficsim.core.geometry.OTSLine3D

concatenate, concatenate, createAndCleanOTSLine3D, createAndCleanOTSLine3D, equals, extract, extract, extractFractional, get, getBounds, getCoordinates, getFirst, getLast, getLength, getLengthSI, getLineString, getLocation, getLocation, getLocationExtended, getLocationExtendedSI, getLocationFraction, getLocationFraction, getLocationFractionExtended, getLocationSI, getPoints, hashCode, main, noiseFilteredLine, offsetLine, offsetLine, offsetLine, reverse, size, toExcel, toString, truncate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OTSPolygon3D

public OTSPolygon3D(OTSPoint3D[] points)
             throws OTSGeometryException

Parameters:

points - the array of points to construct this OTSLine3D from.

Throws:

OTSGeometryException - when the points has fewer than 2 entries or two successive points coincide

OTSPolygon3D

public OTSPolygon3D(com.vividsolutions.jts.geom.LineString lineString)
             throws OTSGeometryException

Parameters:

lineString - the lineString to construct this OTSLine3D from.

Throws:

OTSGeometryException - when the lineString has fewer than 2 entries or two successive points coincide

OTSPolygon3D

public OTSPolygon3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)
             throws OTSGeometryException

Parameters:

coordinates - the array of coordinates to construct this OTSLine3D from.

Throws:

OTSGeometryException - when coordinates has fewer than 2 entries or two successive coordinates coincide

OTSPolygon3D

public OTSPolygon3D(com.vividsolutions.jts.geom.Geometry geometry)
             throws OTSGeometryException

Parameters:

geometry - the geometry to construct this OTSLine3D from.

Throws:

OTSGeometryException - when geometry has fewer than 2 points or two successive points coincide

Method Detail

contains

public boolean contains(OTSPoint3D point)

Determine if a point is horizontally (ignoring Z-coordinates) contained within this OTSPolygon3D.
Derived from Paul Bourke's Determining if a point lies on the interior of a polygon.

Parameters:

point - OTSPoint3D; the point

Returns:

boolean; true if the point lies within this OTSPolygon3D; false if the point lies outside this OTSPolygon3D; true if the point coincides exactly with one of the points defining this OTSPolygon3D, unpredictable (but reproducible) if the point lies on the boundary of this OTSPolygon3D