com.partnersoft.geometry.xy

Class XyCubicCurve

java.lang.Object

com.partnersoft.geometry.xy.XyCubicCurve

All Implemented Interfaces:

Immutable, XyPath<XyCubicCurve>, XyShape<XyCubicCurve>, java.lang.Iterable<XyPoint>

public class XyCubicCurve
extends java.lang.Object
implements XyPath<XyCubicCurve>

Constructor Summary

Constructors

Constructor and Description
XyCubicCurve(XyPoint startPoint, XyPoint endPoint, XyPoint controlPoint1, XyPoint controlPoint2)

Method Summary

Methods

Modifier and Type	Method and Description
XyBounds	getBounds() Returns an XyBounds object representing the rectangular extents of this shape.
XyPoint	getControlPoint1()
XyPoint	getControlPoint2()
XyPoint	getEndPoint() Returns the last point in the shape.
double	getLength() Returns the length of the path.
XyPoint	getStartPoint() Returns the first point in the shape.
java.util.Iterator<XyPoint>	iterator()
XyCubicCurve	scaledBy(double factor) Return a scaled version of the shape by multiplying all coordinates by the given factor in both dimensions.
XyPolyline	toPolyline() Same as XyPath.toPolyline(XyAngle) with a default angle granularity of 1/60 circle (6 degrees, pi/30 radians).
XyPolyline	toPolyline(XyAngle granularity) Converts this area to a polyline which approximates it in some fashion.
XyShape	transformedBy(XyTransform transform) Transform the shape using the given transform.
XyCubicCurve	translatedBy(double offsetX, double offsetY) Translate the shape by adding all coordinates to the given x and y offsets.
XyCubicCurve	withControlPoint1(XyPoint newControlPoint1) Returns a modified version of XyCubicCurve with the given first control point.
XyCubicCurve	withControlPoint2(XyPoint newControlPoint2) Returns a modified version of XyCubicCurve with the given second control point.
XyCubicCurve	withEndPoint(XyPoint newEndPoint) Returns a modified version of XyCubicCurve with the given end point.
XyCubicCurve	withStartPoint(XyPoint newStartPoint) Returns a modified version of XyCubicCurve with the given start point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XyCubicCurve

public XyCubicCurve(XyPoint startPoint,
            XyPoint endPoint,
            XyPoint controlPoint1,
            XyPoint controlPoint2)

Method Detail

withStartPoint

public XyCubicCurve withStartPoint(XyPoint newStartPoint)

Returns a modified version of XyCubicCurve with the given start point.

withEndPoint

public XyCubicCurve withEndPoint(XyPoint newEndPoint)

Returns a modified version of XyCubicCurve with the given end point.

withControlPoint1

public XyCubicCurve withControlPoint1(XyPoint newControlPoint1)

Returns a modified version of XyCubicCurve with the given first control point.

withControlPoint2

public XyCubicCurve withControlPoint2(XyPoint newControlPoint2)

Returns a modified version of XyCubicCurve with the given second control point.

getLength

public double getLength()

Description copied from interface: XyPath

Returns the length of the path.

Specified by:

getLength in interface XyPath<XyCubicCurve>

Returns:

geometric length of this shape

getStartPoint

public XyPoint getStartPoint()

Description copied from interface: XyPath

Returns the first point in the shape.

Specified by:

getStartPoint in interface XyPath<XyCubicCurve>

getEndPoint

public XyPoint getEndPoint()

Description copied from interface: XyPath

Returns the last point in the shape.

Specified by:

getEndPoint in interface XyPath<XyCubicCurve>

toPolyline

public XyPolyline toPolyline(XyAngle granularity)

Description copied from interface: XyPath

Converts this area to a polyline which approximates it in some fashion. For example, a curve can be converted to a polyline with enough segments to roughly approximate its shape. Paths consisting of linked line segments can be represented exactly.

The angle parameter allows a certain level of control of the output. Essentially it dictates the minimum angular granularity used to approximate curved paths. For example, an arc would be turned into a polyline by placing points around the arc's slice of a circle, separated by the given angle.

Specified by:

toPolyline in interface XyPath<XyCubicCurve>

toPolyline

public XyPolyline toPolyline()

Description copied from interface: XyPath

Same as XyPath.toPolyline(XyAngle) with a default angle granularity of 1/60 circle (6 degrees, pi/30 radians).

Specified by:

toPolyline in interface XyPath<XyCubicCurve>

getBounds

public XyBounds getBounds()

Description copied from interface: XyShape

Returns an XyBounds object representing the rectangular extents of this shape.

Specified by:

getBounds in interface XyShape<XyCubicCurve>

scaledBy

public XyCubicCurve scaledBy(double factor)

Description copied from interface: XyShape

Return a scaled version of the shape by multiplying all coordinates by the given factor in both dimensions. This resulting shape must be of the same class as the original.

Specified by:

scaledBy in interface XyShape<XyCubicCurve>

Parameters:

factor - scaling factor

Returns:

scaled result

transformedBy

public XyShape transformedBy(XyTransform transform)

Description copied from interface: XyShape

Transform the shape using the given transform. Due to potential distortion the result may be a different type of shape than this one.

Specified by:

transformedBy in interface XyShape<XyCubicCurve>

Parameters:

transform - affine transform to apply.

Returns:

transformed result

translatedBy

public XyCubicCurve translatedBy(double offsetX,
                        double offsetY)

Description copied from interface: XyShape

Translate the shape by adding all coordinates to the given x and y offsets. The resulting shape must be of the same class as the original.

Specified by:

translatedBy in interface XyShape<XyCubicCurve>

Parameters:

offsetX - offset for the x dimension

offsetY - offset for the y dimension

Returns:

offset result

iterator

public java.util.Iterator<XyPoint> iterator()

Specified by:

iterator in interface java.lang.Iterable<XyPoint>

getControlPoint1

public XyPoint getControlPoint1()

getControlPoint2

public XyPoint getControlPoint2()