math.geom2d.conic
Class HyperbolaBranch2D

java.lang.Object
  math.geom2d.curve.AbstractContinuousCurve2D
      math.geom2d.curve.AbstractSmoothCurve2D
          math.geom2d.conic.HyperbolaBranch2D

All Implemented Interfaces:

java.lang.Cloneable, ContinuousCurve2D, Curve2D, SmoothCurve2D, Boundary2D, ContinuousOrientedCurve2D, Contour2D, OrientedCurve2D, SmoothContour2D, SmoothOrientedCurve2D, GeometricObject2D, Shape2D

public class HyperbolaBranch2D
extends AbstractSmoothCurve2D
implements SmoothContour2D, java.lang.Cloneable

Branch of an Hyperbola2D.

Field Summary

Fields inherited from interface math.geom2d.Shape2D

ACCURACY

Constructor Summary

HyperbolaBranch2D(Hyperbola2D hyperbola, boolean b)
Generic constructor, using a parent Hyperbola, and a boolean to specifies if the branch is the right one (crossing the Ox axis on positive side, b true), or the left one (crossing the Oy axis on the negative side, b false).

Method Summary

boolean	almostEquals(GeometricObject2D obj, double eps) Checks if the two objects are similar up to a given threshold value.
java.awt.geom.GeneralPath	appendPath(java.awt.geom.GeneralPath path) Append the path of the curve to the given path.
Box2D	boundingBox() Returns a bounding box with infinite bounds in every direction
CurveSet2D<? extends HyperbolaBranchArc2D>	clip(Box2D box) Clips the curve with a box.
HyperbolaBranch2D	clone() Overrides Object declaration to ensure Curve2D implementation are cloned as Curve2D.
boolean	contains(double x, double y) Checks if the shape contains the planar point defined by (x,y).
boolean	contains(Point2D point) Checks if the shape contains the given point.
java.util.Collection<? extends HyperbolaBranch2D>	continuousCurves() Returns the collection of continuous curves which constitute this curve.
static HyperbolaBranch2D	create(Hyperbola2D hyperbola, boolean b) Generic constructor, using a parent Hyperbola, and a boolean to specifies if the branch is the right one (crossing the Ox axis on positive side, b true), or the left one (crossing the Oy axis on the negative side, b false).
double	curvature(double t) Use formula given in http://mathworld.wolfram.com/Hyperbola.html
double	distance(double x, double y) Returns the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.
double	distance(Point2D point) Returns the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
Domain2D	domain() Returns the domain delimited by this boundary.
boolean	equals(java.lang.Object obj)
void	fill(java.awt.Graphics2D g2) Throws an UnboundedShapeException
Hyperbola2D	getHyperbola() Returns the supporting hyperbola of this branch.
double	getT0() Deprecated. replaced by t0() (since 0.11.1).
double	getT1() Deprecated. replaced by t1() (since 0.11.1).
java.util.Collection<Point2D>	intersections(LinearShape2D line) Returns the intersection points of the curve with the specified line.
boolean	isBounded() Returns false, as an hyperbola branch is never bounded.
boolean	isClosed() Return false, by definition of Hyperbola branch
boolean	isEmpty() Returns false, as an hyperbola branch is never empty.
boolean	isInside(Point2D point) Returns true if the point is 'inside' the domain bounded by the curve.
boolean	isPositiveBranch() Returns true if this branch is the positive one, i.e. it contains the positive axis in the basis of the supporting hyperbola.
Point2D	point(double t) Returns the point located at the given position on the curve.
double	position(Point2D point) Computes the position of the point on the curve.
double	project(Point2D point) Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point.
HyperbolaBranch2D	reverse() Reverses the contour, and returns an instance of SmoothContour2D.
double	signedDistance(double x, double y) The same as distanceSigned(Point2D), but by passing 2 double as arguments.
double	signedDistance(Point2D point) Returns the signed distance of the curve to the given point.
HyperbolaBranchArc2D	subCurve(double t0, double t1) Returns an instance of HyprbolaBranchArc2D initialized with this.
double	t0() Returns Double.NEGATIVE_INFINITY.
double	t1() Returns Double.POSITIVE_INFINITY.
Vector2D	tangent(double t) Returns the tangent of the curve at the given position.
HyperbolaBranch2D	transform(AffineTransform2D trans) Transforms the contour, and returns an instance of SmoothContour2D.
double	windingAngle(Point2D point) Return the angle portion that the curve turn around the given point.

Methods inherited from class math.geom2d.curve.AbstractSmoothCurve2D

isSingular, leftTangent, normal, rightTangent, singularPoints, smoothPieces, vertices

Methods inherited from class math.geom2d.curve.AbstractContinuousCurve2D

asAwtShape, asPolyline, draw, firstPoint, lastPoint

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface math.geom2d.curve.SmoothCurve2D

normal

Methods inherited from interface math.geom2d.curve.ContinuousCurve2D

asPolyline, leftTangent, rightTangent, smoothPieces

Methods inherited from interface math.geom2d.curve.Curve2D

asAwtShape, draw, firstPoint, isSingular, lastPoint, singularPoints, vertices

Constructor Detail

HyperbolaBranch2D

public HyperbolaBranch2D(Hyperbola2D hyperbola,
                         boolean b)

Generic constructor, using a parent Hyperbola, and a boolean to specifies if the branch is the right one (crossing the Ox axis on positive side, b true), or the left one (crossing the Oy axis on the negative side, b false).

Method Detail

create

public static HyperbolaBranch2D create(Hyperbola2D hyperbola,
                                       boolean b)

Generic constructor, using a parent Hyperbola, and a boolean to specifies if the branch is the right one (crossing the Ox axis on positive side, b true), or the left one (crossing the Oy axis on the negative side, b false).

getHyperbola

public Hyperbola2D getHyperbola()

Returns the supporting hyperbola of this branch.

isPositiveBranch

public boolean isPositiveBranch()

Returns true if this branch is the positive one, i.e. it contains the positive axis in the basis of the supporting hyperbola.

Returns:

true if this branch contains the positive axis.

curvature

public double curvature(double t)

Use formula given in http://mathworld.wolfram.com/Hyperbola.html

Specified by:

curvature in interface ContinuousCurve2D

Parameters:

t - the position on the curve

Returns:

the curvature of the curve for position t

tangent

public Vector2D tangent(double t)

Description copied from interface: SmoothCurve2D

Returns the tangent of the curve at the given position.

Specified by:

tangent in interface SmoothCurve2D

Parameters:

t - a position on the curve

Returns:

the tangent vector computed for position t

See Also:

SmoothCurve2D.normal(double)

domain

public Domain2D domain()

Description copied from interface: Boundary2D

Returns the domain delimited by this boundary.

Specified by:

domain in interface Boundary2D

Returns:

the domain delimited by this boundary

fill

public void fill(java.awt.Graphics2D g2)

Throws an UnboundedShapeException

Specified by:

fill in interface Boundary2D

Parameters:

g2 - the Graphics to fill on

signedDistance

public double signedDistance(Point2D point)

Description copied from interface: OrientedCurve2D

Returns the signed distance of the curve to the given point. The distance is positive if the point lies outside the shape, and negative if the point lies inside the shape. In both cases, absolute value of distance is equals to the distance to the border of the shape.

Specified by:

signedDistance in interface OrientedCurve2D

Parameters:

point - a point of the plane

Returns:

the signed distance to the curve

signedDistance

public double signedDistance(double x,
                             double y)

Description copied from interface: OrientedCurve2D

The same as distanceSigned(Point2D), but by passing 2 double as arguments.

Specified by:

signedDistance in interface OrientedCurve2D

Parameters:

x - x-coord of a point

y - y-coord of a point

Returns:

the signed distance of the point (x,y) to the curve

windingAngle

public double windingAngle(Point2D point)

Description copied from interface: OrientedCurve2D

Return the angle portion that the curve turn around the given point. Result is a signed angle.

Specified by:

windingAngle in interface OrientedCurve2D

Parameters:

point - a point of the plane

Returns:

a signed angle

isInside

public boolean isInside(Point2D point)

Description copied from interface: OrientedCurve2D

Returns true if the point is 'inside' the domain bounded by the curve.

Specified by:

isInside in interface Boundary2D

Specified by:

isInside in interface OrientedCurve2D

Parameters:

point - a point in the plane

Returns:

true if the point is on the left side of the curve.

continuousCurves

public java.util.Collection<? extends HyperbolaBranch2D> continuousCurves()

Description copied from interface: Curve2D

Returns the collection of continuous curves which constitute this curve.

Specified by:

continuousCurves in interface Curve2D

Specified by:

continuousCurves in interface Boundary2D

Overrides:

continuousCurves in class AbstractContinuousCurve2D

Returns:

a collection of continuous curves.

isClosed

public boolean isClosed()

Return false, by definition of Hyperbola branch

Specified by:

isClosed in interface ContinuousCurve2D

appendPath

public java.awt.geom.GeneralPath appendPath(java.awt.geom.GeneralPath path)

Description copied from interface: ContinuousCurve2D

Append the path of the curve to the given path.

Specified by:

appendPath in interface ContinuousCurve2D

Parameters:

path - a path to modify

Returns:

the modified path

point

public Point2D point(double t)

Description copied from interface: Curve2D

Returns the point located at the given position on the curve. If the parameter lies outside the definition range, the parameter corresponding to the closest bound is used instead. This method can be used to draw an approximated outline of a curve, by selecting multiple values for t and drawing lines between them.

Specified by:

point in interface Curve2D

position

public double position(Point2D point)

Description copied from interface: Curve2D

Computes the position of the point on the curve. If the point does not belong to the curve, return Double.NaN. It is complementary to the point(double) method.

Specified by:

position in interface Curve2D

Parameters:

point - a point belonging to the curve

Returns:

the position of the point on the curve

See Also:

Curve2D.point(double)

project

public double project(Point2D point)

Description copied from interface: Curve2D

Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point. This function should always returns a valid value.

Specified by:

project in interface Curve2D

Parameters:

point - a point to project

Returns:

the position of the closest orthogonal projection

reverse

public HyperbolaBranch2D reverse()

Description copied from interface: SmoothContour2D

Reverses the contour, and returns an instance of SmoothContour2D.

Specified by:

reverse in interface ContinuousCurve2D

Specified by:

reverse in interface Curve2D

Specified by:

reverse in interface SmoothCurve2D

Specified by:

reverse in interface Boundary2D

Specified by:

reverse in interface ContinuousOrientedCurve2D

Specified by:

reverse in interface Contour2D

Specified by:

reverse in interface OrientedCurve2D

Specified by:

reverse in interface SmoothContour2D

Specified by:

reverse in interface SmoothOrientedCurve2D

subCurve

public HyperbolaBranchArc2D subCurve(double t0,
                                     double t1)

Returns an instance of HyprbolaBranchArc2D initialized with this.

Specified by:

subCurve in interface ContinuousCurve2D

Specified by:

subCurve in interface Curve2D

Specified by:

subCurve in interface SmoothCurve2D

Specified by:

subCurve in interface ContinuousOrientedCurve2D

Specified by:

subCurve in interface SmoothOrientedCurve2D

Parameters:

t0 - position of the start of the sub-curve

t1 - position of the end of the sub-curve

Returns:

the portion of original curve comprised between t0 and t1.

t0

public double t0()

Returns Double.NEGATIVE_INFINITY.

Specified by:

t0 in interface Curve2D

getT0

@Deprecated
public double getT0()

Deprecated. replaced by t0() (since 0.11.1).

Specified by:

getT0 in interface Curve2D

t1

public double t1()

Returns Double.POSITIVE_INFINITY.

Specified by:

t1 in interface Curve2D

getT1

@Deprecated
public double getT1()

Deprecated. replaced by t1() (since 0.11.1).

Specified by:

getT1 in interface Curve2D

intersections

public java.util.Collection<Point2D> intersections(LinearShape2D line)

Description copied from interface: Curve2D

Returns the intersection points of the curve with the specified line. The length of the result array is the number of intersection points.

Specified by:

intersections in interface Curve2D

boundingBox

public Box2D boundingBox()

Returns a bounding box with infinite bounds in every direction

Specified by:

boundingBox in interface Shape2D

Returns:

the bounding box of the shape.

clip

public CurveSet2D<? extends HyperbolaBranchArc2D> clip(Box2D box)

Clips the curve with a box. The result is an instance of CurveSet2D, which contains only instances of HyperbolaBranchArc2D. If the curve does not intersect the boundary of the box, the result is an instance of CurveSet2D which contains 0 curves.

Specified by:

clip in interface ContinuousCurve2D

Specified by:

clip in interface Curve2D

Specified by:

clip in interface SmoothCurve2D

Specified by:

clip in interface ContinuousOrientedCurve2D

Specified by:

clip in interface OrientedCurve2D

Specified by:

clip in interface SmoothOrientedCurve2D

Specified by:

clip in interface Shape2D

Parameters:

box - the clipping box

Returns:

the clipped shape

distance

public double distance(Point2D point)

Description copied from interface: Shape2D

Returns the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.

Specified by:

distance in interface Shape2D

distance

public double distance(double x,
                       double y)

Description copied from interface: Shape2D

Returns the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.

Specified by:

distance in interface Shape2D

isBounded

public boolean isBounded()

Returns false, as an hyperbola branch is never bounded.

Specified by:

isBounded in interface Shape2D

isEmpty

public boolean isEmpty()

Returns false, as an hyperbola branch is never empty.

Specified by:

isEmpty in interface Shape2D

Returns:

true if the shape does not contain any point.

transform

public HyperbolaBranch2D transform(AffineTransform2D trans)

Description copied from interface: SmoothContour2D

Transforms the contour, and returns an instance of SmoothContour2D.

Specified by:

transform in interface ContinuousCurve2D

Specified by:

transform in interface Curve2D

Specified by:

transform in interface SmoothCurve2D

Specified by:

transform in interface Boundary2D

Specified by:

transform in interface ContinuousOrientedCurve2D

Specified by:

transform in interface Contour2D

Specified by:

transform in interface OrientedCurve2D

Specified by:

transform in interface SmoothContour2D

Specified by:

transform in interface SmoothOrientedCurve2D

Specified by:

transform in interface Shape2D

Parameters:

trans - an affine transform

Returns:

the transformed shape

contains

public boolean contains(Point2D point)

Description copied from interface: Shape2D

Checks if the shape contains the given point.

Specified by:

contains in interface Shape2D

contains

public boolean contains(double x,
                        double y)

Description copied from interface: Shape2D

Checks if the shape contains the planar point defined by (x,y).

Specified by:

contains in interface Shape2D

almostEquals

public boolean almostEquals(GeometricObject2D obj,
                            double eps)

Description copied from interface: GeometricObject2D

Checks if the two objects are similar up to a given threshold value. This method can be used to compare the results of geometric computations, that introduce errors due to numerical computations.

Specified by:

almostEquals in interface GeometricObject2D

Parameters:

obj - the object to compare

eps - a threshold value, for example the minimal coordinate difference

Returns:

true if both object have the same value up to the threshold

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public HyperbolaBranch2D clone()

Description copied from interface: Curve2D

Overrides Object declaration to ensure Curve2D implementation are cloned as Curve2D.

Specified by:

clone in interface Curve2D

Specified by:

clone in class AbstractSmoothCurve2D

Returns:

the cloned curve