ImageScience 3.0.0

imagescience.shape
Class Circle

java.lang.Object
  extended by imagescience.shape.Circle
All Implemented Interfaces:
Shape

public class Circle
extends java.lang.Object
implements Shape

A circle in the x-y plane.


Constructor Summary
Circle()
          Default constructor.
Circle(Circle circle)
          Copy constructor.
Circle(double x, double y, double radius)
          Constructs a circle with given center position and radius.
 
Method Summary
 double area()
          Returns the area spanned by the circle.
 Image bitmap(boolean binary)
          Computes a bitmapped version of the shape.
 Bounds bounds()
          Computes the bounding box of the shape.
 void center(double x, double y)
          Sets the center position of the circle.
 boolean contains(double x, double y)
          Indicates the position of a point relative to the circle.
 boolean contains(Point point)
          Indicates the position of a point relative to the circle.
 java.awt.geom.GeneralPath contour()
          Returns the contour of the circle.
 Shape duplicate()
          Duplicates the shape.
 boolean empty()
          Indicates whether the shape is empty.
 boolean equals(Shape shape)
          Indicates whether this object has the same shape as the given object.
 double perimeter()
          Returns the perimeter of the circle.
 void position(double x, double y)
          Sets the center position of the circle.
 double radius()
          Returns the radius of the circle.
 void radius(double radius)
          Sets the radius of the circle.
 void set(double x, double y, double radius)
          Sets the center position and radius of the circle.
 void translate(double dx, double dy)
          Translates the circle over the given distance.
 double x()
          Returns the x-coordinate of the center position of the circle.
 void x(double x)
          Sets the x-coordinate of the center position of the circle.
 double y()
          Returns the y-coordinate of the center position of the circle.
 void y(double y)
          Sets the y-coordinate of the center position of the circle.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Circle

public Circle()
Default constructor. Results in a circle with center position at the origin and with unit radius.


Circle

public Circle(double x,
              double y,
              double radius)
Constructs a circle with given center position and radius.

Parameters:
x - The x-coordinate of the center position of the circle.
y - The y-coordinate of the center position of the circle.
radius - The radius of the circle.
Throws:
java.lang.IllegalArgumentException - If radius is less than 0.

Circle

public Circle(Circle circle)
Copy constructor.

Parameters:
circle - The circle to be copied. All information is copied and no memory is shared with this circle.
Throws:
java.lang.NullPointerException - If circle is null.
Method Detail

x

public void x(double x)
Sets the x-coordinate of the center position of the circle.

Parameters:
x - The x-coordinate of the center position of the circle.

y

public void y(double y)
Sets the y-coordinate of the center position of the circle.

Parameters:
y - The y-coordinate of the center position of the circle.

center

public void center(double x,
                   double y)
Sets the center position of the circle. The same as method position(double,double).

Parameters:
x - The x-coordinate of the center position of the circle.
y - The y-coordinate of the center position of the circle.

position

public void position(double x,
                     double y)
Sets the center position of the circle. The same as method center(double,double).

Parameters:
x - The x-coordinate of the center position of the circle.
y - The y-coordinate of the center position of the circle.

translate

public void translate(double dx,
                      double dy)
Translates the circle over the given distance.

Parameters:
dx - The distance in the x-dimension over which to translate.
dy - The distance in the y-dimension over which to translate.

duplicate

public Shape duplicate()
Description copied from interface: Shape
Duplicates the shape.

Specified by:
duplicate in interface Shape
Returns:
A new Shape object that is an exact copy of this object. All information is copied and no memory is shared between this and the returned object.

set

public void set(double x,
                double y,
                double radius)
Sets the center position and radius of the circle.

Parameters:
x - The x-coordinate of the center position of the circle.
y - The y-coordinate of the center position of the circle.
radius - The radius of the circle.
Throws:
java.lang.IllegalArgumentException - If radius is less than 0.

radius

public void radius(double radius)
Sets the radius of the circle.

Parameters:
radius - The radius of the circle.
Throws:
java.lang.IllegalArgumentException - If radius is less than 0.

x

public double x()
Returns the x-coordinate of the center position of the circle.

Returns:
The x-coordinate of the center position of the circle.

y

public double y()
Returns the y-coordinate of the center position of the circle.

Returns:
The y-coordinate of the center position of the circle.

radius

public double radius()
Returns the radius of the circle.

Returns:
The radius of the circle.

perimeter

public double perimeter()
Returns the perimeter of the circle.

Returns:
The perimeter of the circle.

area

public double area()
Returns the area spanned by the circle.

Returns:
The area of the circle.

contains

public boolean contains(Point point)
Indicates the position of a point relative to the circle.

Specified by:
contains in interface Shape
Parameters:
point - The point whose position relative to the circle is to be tested. The point is treated as a 2D point. That is, only its x- and y-coordinate values are considered.
Returns:
The value contains(point.x,point.y).
Throws:
java.lang.NullPointerException - If point is null.

contains

public boolean contains(double x,
                        double y)
Indicates the position of a point relative to the circle.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.
Returns:
Value true if the point is on or inside the circle, or false if it is outside the circle.

contour

public java.awt.geom.GeneralPath contour()
Returns the contour of the circle.

Returns:
A new GeneralPath object containing the contour of the circle.

bitmap

public Image bitmap(boolean binary)
Description copied from interface: Shape
Computes a bitmapped version of the shape.

Specified by:
bitmap in interface Shape
Parameters:
binary - Determines whether the returned bitmap image is two-valued. If true, image elements whose center positions fall inside the shape are set to 255, and elements whose center positions fall outside the shape are set to 0. If false, additional processing is performed, by which each image element falling partly inside and partly outside the shape is set to 255 times its (approximate) inside-fraction.
Returns:
A new ByteImage object containing a bitmapped version of the shape. The origin of the integer coordinate system of the image corresponds to the position in the shape coordinate system obtained by taking the floor value of the lower bound of the shape in each dimension.

bounds

public Bounds bounds()
Description copied from interface: Shape
Computes the bounding box of the shape.

Specified by:
bounds in interface Shape
Returns:
A new Bounds object containing the bounding box of the shape.

equals

public boolean equals(Shape shape)
Description copied from interface: Shape
Indicates whether this object has the same shape as the given object.

Specified by:
equals in interface Shape
Parameters:
shape - The shape to compare this shape with.
Returns:
Value true if shape is not null, and an instance of the same class as this object, with the exact same shape, or false if this is not the case.

empty

public boolean empty()
Description copied from interface: Shape
Indicates whether the shape is empty.

Specified by:
empty in interface Shape
Returns:
Value true if the shape does not enclose any space, or false if it does.

ImageScience 3.0.0

Copyright (C) Erik Meijering. Permission to use this software and corresponding documentation for educational, research, and not-for-profit purposes, without a fee and without a signed licensing agreement, is granted, subject to the following terms and conditions.

IT IS NOT ALLOWED TO REDISTRIBUTE, SELL, OR LEASE THIS SOFTWARE, OR DERIVATIVE WORKS THEREOF, WITHOUT PERMISSION IN WRITING FROM THE COPYRIGHT HOLDER. THE COPYRIGHT HOLDER IS FREE TO MAKE VERSIONS OF THE SOFTWARE AVAILABLE FOR A FEE OR COMMERCIALLY ONLY.

IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OF ANY KIND WHATSOEVER, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND CORRESPONDING DOCUMENTATION IS PROVIDED "AS IS". THE COPYRIGHT HOLDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.