math.geom2d.conic
Class HyperbolaBranchArc2D

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

All Implemented Interfaces:

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

public class HyperbolaBranchArc2D
extends AbstractSmoothCurve2D
implements SmoothOrientedCurve2D, java.lang.Cloneable

An arc of hyperbola, defined from the parent hyperbola branch, and two positions on the parent curve.

Author:

dlegland

Field Summary

Fields inherited from interface math.geom2d.Shape2D

ACCURACY

Constructor Summary

HyperbolaBranchArc2D(HyperbolaBranch2D branch, double t0, double t1)

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 the bounding box of the shape.
CurveSet2D<? extends HyperbolaBranchArc2D>	clip(Box2D box) Clips the hyperbola branch arc by a box.
HyperbolaBranchArc2D	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 p) Checks if the shape contains the given point.
static HyperbolaBranchArc2D	create(HyperbolaBranch2D branch, double t0, double t1)
double	curvature(double t) Computes the curvature at the given position.
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.
boolean	equals(java.lang.Object obj)
java.awt.geom.GeneralPath	getGeneralPath()
HyperbolaBranch2D	getHyperbolaBranch()
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 true if the shape is bounded, that is if we can draw a finite rectangle enclosing the shape.
boolean	isClosed() Returns false.
boolean	isEmpty() Returns true if the shape does not contain any point.
boolean	isInside(Point2D pt) Returns true if the point is 'inside' the domain bounded by the curve.
Point2D	point(double t) If t0 equals minus infinity, throws an UnboundedShapeException.
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.
HyperbolaBranchArc2D	reverse() Returns the curve with same trace on the plane with parameterization in reverse order.
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 a new HyperbolaBranchArc2D, with same parent hyperbola branch, and with new parameterization bounds.
double	t0() Get value of parameter t for the first point of the curve.
double	t1() Get value of parameter t for the last point of the curve.
Vector2D	tangent(double t) Returns the tangent of the curve at the given position.
HyperbolaBranchArc2D	transform(AffineTransform2D trans) Transforms the curve by an affine transform.
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, continuousCurves, 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, continuousCurves, draw, firstPoint, isSingular, lastPoint, singularPoints, vertices

Constructor Detail

HyperbolaBranchArc2D

public HyperbolaBranchArc2D(HyperbolaBranch2D branch,
                            double t0,
                            double t1)

Method Detail

create

public static HyperbolaBranchArc2D create(HyperbolaBranch2D branch,
                                          double t0,
                                          double t1)

getHyperbolaBranch

public HyperbolaBranch2D getHyperbolaBranch()

curvature

public double curvature(double t)

Description copied from interface: ContinuousCurve2D

Computes the curvature at the given position. The curvature is finite for positions t that correspond to smooth parts, and is infinite for singular points.

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)

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 pt)

Description copied from interface: OrientedCurve2D

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

Specified by:

isInside in interface OrientedCurve2D

Parameters:

pt - a point in the plane

Returns:

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

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

isClosed

public boolean isClosed()

Returns false.

Specified by:

isClosed in interface ContinuousCurve2D

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

point

public Point2D point(double t)

If t0 equals minus infinity, throws an UnboundedShapeException.

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 HyperbolaBranchArc2D reverse()

Description copied from interface: Curve2D

Returns the curve with same trace on the plane with parameterization in reverse order.

Specified by:

reverse in interface ContinuousCurve2D

Specified by:

reverse in interface Curve2D

Specified by:

reverse in interface SmoothCurve2D

Specified by:

reverse in interface ContinuousOrientedCurve2D

Specified by:

reverse in interface OrientedCurve2D

Specified by:

reverse in interface SmoothOrientedCurve2D

subCurve

public HyperbolaBranchArc2D subCurve(double t0,
                                     double t1)

Returns a new HyperbolaBranchArc2D, with same parent hyperbola branch, and with new parameterization bounds. The new bounds are constrained to belong to the old bounds interval. If t1

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()

Description copied from interface: Curve2D

Get value of parameter t for the first point of the curve. It can be -Infinity, in this case the piece of curve is not bounded.

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()

Description copied from interface: Curve2D

Get value of parameter t for the last point of the curve. It can be +Infinity, in this case the piece of curve is not bounded.

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

boundingBox

public Box2D boundingBox()

Description copied from interface: Shape2D

Returns the bounding box of the shape.

Specified by:

boundingBox in interface Shape2D

Returns:

the bounding box of the shape.

clip

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

Clips the hyperbola branch arc by a box. The result is an instance of CurveSet2D, which contains only instances of HyperbolaBranchArc2D. If the shape is not clipped, 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()

Description copied from interface: Shape2D

Returns true if the shape is bounded, that is if we can draw a finite rectangle enclosing the shape. For example, a straight line or a parabola are not bounded.

Specified by:

isBounded in interface Shape2D

isEmpty

public boolean isEmpty()

Description copied from interface: Shape2D

Returns true if the shape does not contain any point. This is the case for example for PointSet2D without any point.

Specified by:

isEmpty in interface Shape2D

Returns:

true if the shape does not contain any point.

transform

public HyperbolaBranchArc2D transform(AffineTransform2D trans)

Description copied from interface: Curve2D

Transforms the curve by an affine transform. The result is an instance of Curve2D.

Specified by:

transform in interface ContinuousCurve2D

Specified by:

transform in interface Curve2D

Specified by:

transform in interface SmoothCurve2D

Specified by:

transform in interface ContinuousOrientedCurve2D

Specified by:

transform in interface OrientedCurve2D

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 p)

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

getGeneralPath

public java.awt.geom.GeneralPath getGeneralPath()

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 HyperbolaBranchArc2D 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