math.geom2d.domain
Interface OrientedCurve2D

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

public interface OrientedCurve2D
extends Curve2D

An OrientedCurve2D defines an 'inside' and an 'outside'. It is typically a part of the boundary of a domain. Several OrientedCurve2D form a ContinuousBoundary2D, and one or several ContinousBoundary2D form a Boundary2D.

Author:
dlegland

Field Summary
 
Fields inherited from interface math.geom2d.Shape2D
ACCURACY
 
Method Summary
 CurveSet2D clip(Box2D box)
          When a curve is clipped, the result is a set of curves.
 Curve2D getReverseCurve()
          Returns the curve with same trace on the plane with parametrization in reverse order.
 double getSignedDistance(double x, double y)
          The same as getSignedDistance(Point2D), but by passing 2 double as arguments.
 double getSignedDistance(Point2D point)
          Get the signed distance of the curve to the given point: this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape.
 double getWindingAngle(Point2D point)
          Return the angle portion that the curve turn around the given point.
 boolean isInside(Point2D pt)
          Returns true if the point is 'inside' the domain bounded by the curve.
 Curve2D transform(AffineTransform2D trans)
          Transforms the curve by an affine transform.
 
Methods inherited from interface math.geom2d.curve.Curve2D
clone, draw, getAsAWTShape, getContinuousCurves, getFirstPoint, getIntersections, getLastPoint, getPoint, getPosition, getSingularPoints, getSubCurve, getT0, getT1, isSingular, project
 
Methods inherited from interface math.geom2d.Shape2D
contains, contains, getBoundingBox, getDistance, getDistance, isBounded, isEmpty
 

Method Detail

getWindingAngle

double getWindingAngle(Point2D point)
Return the angle portion that the curve turn around the given point. Result is a signed angle.

Parameters:
point - a point of the plane
Returns:
a signed angle

getSignedDistance

double getSignedDistance(Point2D point)
Get the signed distance of the curve to the given point: this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape. In this case, absolute value of distance is equals to the distance to the border of the shape.

Parameters:
point - a point of the plane
Returns:
the signed distance to the curve

getSignedDistance

double getSignedDistance(double x,
                         double y)
The same as getSignedDistance(Point2D), but by passing 2 double as arguments.

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

isInside

boolean isInside(Point2D pt)
Returns true if the point is 'inside' the domain bounded by the curve.

Parameters:
pt - a point in the plane
Returns:
true if the point is on the left side of the curve.

getReverseCurve

Curve2D getReverseCurve()
Description copied from interface: Curve2D
Returns the curve with same trace on the plane with parametrization in reverse order.

Specified by:
getReverseCurve in interface Curve2D

clip

CurveSet2D clip(Box2D box)
Description copied from interface: Curve2D
When a curve is clipped, the result is a set of curves.

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

transform

Curve2D 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 Curve2D
Specified by:
transform in interface Shape2D
Parameters:
trans - an affine transform
Returns:
the transformed shape


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