Package org.opentrafficsim.base.geometry

Class CircleShape

java.lang.Object
org.opentrafficsim.base.geometry.CircleShape
All Implemented Interfaces:
OtsShape
public class CircleShape extends Object implements OtsShape
Shape defined by a circle.

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

Author:
Wouter Schakel

  • Field Summary

    Fields inherited from interface org.opentrafficsim.base.geometry.OtsShape

    CENTER, DEFAULT_POLYGON_SEGMENTS

  • Constructor Summary

    Constructors
    Constructor
    Description
    CircleShape(double radius)
    Constructor.
    CircleShape(double radius, int polygonSegments)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.djutils.draw.line.Polygon2d
    asPolygon()
    Returns a polygon representation of the bounds, such that an intersection can be derived.
    boolean
    contains(double x, double y)
    Check if a point is contained in this OtsShape.
    boolean
    contains(org.djutils.draw.point.Point2d point)
    Check if a point is contained in this OtsShape.
    double
    getMaxX()
    Return the absolute upper bound for x.
    double
    getMaxY()
    Return the absolute upper bound for y.
    double
    getMinX()
    Return the absolute lower bound for x.
    double
    getMinY()
    Return the absolute lower bound for y.
    double
    signedDistance(org.djutils.draw.point.Point2d point)
    Signed distance function.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.opentrafficsim.base.geometry.OtsShape

    getDeltaX, getDeltaY, midPoint

  • Constructor Details

    • CircleShape

      public CircleShape(double radius)
      Constructor.
      Parameters:
      radius - radius.

    • CircleShape

      public CircleShape(double radius, int polygonSegments)
      Constructor.
      Parameters:
      radius - radius.
      polygonSegments - number of segments in polygon representation.

  • Method Details

    • getMinX

      public double getMinX()
      Description copied from interface: OtsShape
      Return the absolute lower bound for x.
      Specified by:
      getMinX in interface OtsShape
      Returns:
      double; the absolute lower bound for x

    • getMaxX

      public double getMaxX()
      Description copied from interface: OtsShape
      Return the absolute upper bound for x.
      Specified by:
      getMaxX in interface OtsShape
      Returns:
      double; the absolute upper bound for x

    • getMinY

      public double getMinY()
      Description copied from interface: OtsShape
      Return the absolute lower bound for y.
      Specified by:
      getMinY in interface OtsShape
      Returns:
      double; the absolute lower bound for y

    • getMaxY

      public double getMaxY()
      Description copied from interface: OtsShape
      Return the absolute upper bound for y.
      Specified by:
      getMaxY in interface OtsShape
      Returns:
      double; the absolute upper bound for y

    • contains

      public boolean contains(org.djutils.draw.point.Point2d point) throws NullPointerException
      Description copied from interface: OtsShape
      Check if a point is contained in this OtsShape.
      Specified by:
      contains in interface OtsShape
      Parameters:
      point - the point
      Returns:
      true if the point is within this OtsShape; false if the point is not within this OtsShape. Results may be ill-defined for points on the edges of this Polygon.
      Throws:
      NullPointerException

    • contains

      public boolean contains(double x, double y)
      Description copied from interface: OtsShape
      Check if a point is contained in this OtsShape.
      Specified by:
      contains in interface OtsShape
      Parameters:
      x - x-coordinate
      y - y-coordinate
      Returns:
      true if the point is within this OtsShape; false if the point is not within this OtsShape. Results may be ill-defined for points on the edges of this Polygon.

    • signedDistance

      public double signedDistance(org.djutils.draw.point.Point2d point)
      Description copied from interface: OtsShape
      Signed distance function. The coordinates must be transformed to this bound's space. Negative distances returned are inside the bounds, with the absolute value of the distance towards the edge. The default implementation is based on the polygon representation and is expensive.
      Specified by:
      signedDistance in interface OtsShape
      Parameters:
      point - point for which distance is returned.
      Returns:
      distance from point to these bounds.

    • asPolygon

      public org.djutils.draw.line.Polygon2d asPolygon()
      Description copied from interface: OtsShape
      Returns a polygon representation of the bounds, such that an intersection can be derived.
      Specified by:
      asPolygon in interface OtsShape
      Returns:
      polygon representation of the bounds.

    • toString

      public String toString()
      Overrides:
      toString in class Object