math.geom2d.curve
Interface Curve2D

Package class diagram package Curve2D
All Superinterfaces:
Cloneable, Serializable, Shape2D
All Known Subinterfaces:
Boundary2D, CircleLine2D, CircularShape2D, CirculinearBoundary2D, CirculinearContinuousCurve2D, CirculinearContour2D, CirculinearCurve2D, CirculinearElement2D, CirculinearRing2D, Conic2D, ContinuousBoundary2D, ContinuousCirculinearCurve2D, ContinuousCurve2D, ContinuousOrientedCurve2D, LinearShape2D, OrientedCurve2D, SmoothBoundary2D, SmoothCurve2D, SmoothOrientedCurve2D
All Known Implementing Classes:
AbstractContinuousCurve2D, AbstractLine2D, AbstractSmoothCurve2D, BezierCurve2D, BoundaryPolyCirculinearCurve2D, BoundaryPolyCurve2D, BoundarySet2D, Circle2D, CircleArc2D, CirculinearBoundarySet2D, CirculinearCurveSet2D, ClosedPolyline2D, CubicBezierCurve2D, CurveArray2D, CurveSet2D, Ellipse2D, EllipseArc2D, GenericCirculinearRing2D, Hyperbola2D, HyperbolaBranch2D, HyperbolaBranchArc2D, InvertedRay2D, Line2D, LineArc2D, LinearRing2D, LineObject2D, LineSegment2D, Parabola2D, ParabolaArc2D, PolyBezierCurve2D, PolyCirculinearCurve2D, PolyCubicBezierCurve2D, PolyCurve2D, Polyline2D, Polyline2D, PolyOrientedCurve2D, QuadBezier2D, QuadBezierCurve2D, Ray2D, Ring2D, StraightLine2D

public interface Curve2D
extends Shape2D, Cloneable

Interface for piecewise smooth curves, like polylines, conics, straight lines, line segments...

Several interfaces exist to use more explicit type of curves: ContinuousCurve2D for finite or infinite continuous curves, SmoothCurve2D for curves that admit a derivative (and hence a tangent, a curvature...) at each point, OrientedCurve2D that are used to define the boundary of a domain...

Points on curves are identified using curve parameterization. This parameterization is left to the implementation.


Field Summary
 
Fields inherited from interface math.geom2d.Shape2D
ACCURACY
 
Method Summary
 CurveSet2D<? extends Curve2D> clip(Box2D box)
          When a curve is clipped, the result is a set of curves.
 Curve2D clone()
          Overrides Object declaration to ensure Curve2D implementation are cloned as Curve2D.
 void draw(Graphics2D g2)
          Draws the curve on the given Graphics2D object.
 Shape getAsAWTShape()
           
 Collection<? extends ContinuousCurve2D> getContinuousCurves()
          Returns the collection of continuous curves which constitute this curve.
 Point2D getFirstPoint()
          Get the first point of the curve.
 Collection<Point2D> getIntersections(LinearShape2D line)
          Returns the intersection points of the curve with the specified line.
 Point2D getLastPoint()
          Get the last point of the curve.
 Point2D getPoint(double t)
          Gets the point from a parametric representation of the curve.
 double getPosition(Point2D point)
          Get position of the point on the curve.
 Curve2D getReverseCurve()
          Returns the curve with same trace on the plane with parametrization in reverse order.
 Collection<Point2D> getSingularPoints()
          Returns a set of singular points, i. e. which do not locally admit derivative.
 Curve2D getSubCurve(double t0, double t1)
          Returns a portion of the original curve, delimited by two positions on the curve.
 double getT0()
          Get value of parameter t for the first point of the curve.
 double getT1()
          Get value of parameter t for the last point of the curve.
 boolean isSingular(double pos)
          Checks if a point is singular.
 double project(Point2D point)
          Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point.
 Curve2D transform(AffineTransform2D trans)
          Transforms the curve by an affine transform.
 
Methods inherited from interface math.geom2d.Shape2D
contains, contains, getBoundingBox, getDistance, getDistance, isBounded, isEmpty
 

Method Detail

getT0

double getT0()
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.


getT1

double getT1()
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.


getPoint

Point2D getPoint(double t)
Gets the point from a parametric representation of 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.


getFirstPoint

Point2D getFirstPoint()
Get the first point of the curve. It must returns the same result as getPoint(getT0()).

Returns:
the first point of the curve

getLastPoint

Point2D getLastPoint()
Get the last point of the curve. It must returns the same result as getPoint(getT1()).

Returns:
the last point of the curve.

getSingularPoints

Collection<Point2D> getSingularPoints()
Returns a set of singular points, i. e. which do not locally admit derivative.

Returns:
a collection of Point2D.

isSingular

boolean isSingular(double pos)
Checks if a point is singular.

Parameters:
pos - the position of the point on the curve
Returns:
true if the point at this location is singular

getPosition

double getPosition(Point2D point)
Get position of the point on the curve. If the point does not belong to the curve, return Double.NaN.

Parameters:
point - a point belonging to the curve
Returns:
the position of the point on the curve

project

double project(Point2D point)
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.

Parameters:
point - a point to project
Returns:
the position of the closest orthogonal projection

getIntersections

Collection<Point2D> getIntersections(LinearShape2D line)
Returns the intersection points of the curve with the specified line. The length of the result array is the number of intersection points.


getReverseCurve

Curve2D getReverseCurve()
Returns the curve with same trace on the plane with parametrization in reverse order.


getContinuousCurves

Collection<? extends ContinuousCurve2D> getContinuousCurves()
Returns the collection of continuous curves which constitute this curve.

Returns:
a collection of continuous curves.

getSubCurve

Curve2D getSubCurve(double t0,
                    double t1)
Returns a portion of the original curve, delimited by two positions on the curve.

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.

transform

Curve2D transform(AffineTransform2D trans)
Transforms the curve by an affine transform. The result is an instance of Curve2D.

Specified by:
transform in interface Shape2D
Parameters:
trans - an affine transform
Returns:
the transformed shape

clip

CurveSet2D<? extends Curve2D> clip(Box2D box)
When a curve is clipped, the result is a set of curves.

Specified by:
clip in interface Shape2D
Parameters:
box - the clipping box
Returns:
the clipped shape

getAsAWTShape

Shape getAsAWTShape()
Returns:
the shape corresponding to this curve
Since:
0.7.1

draw

void draw(Graphics2D g2)
Draws the curve on the given Graphics2D object.

Specified by:
draw in interface Shape2D
Parameters:
g2 - the graphics to draw the curve
Since:
0.6.3

clone

Curve2D clone()
Overrides Object declaration to ensure Curve2D implementation are cloned as Curve2D.

Returns:
the cloned curve


Copyright © 2015 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.