TLcdXYCircularArcBy3Points (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.shape.ALcdShape
- - com.luciad.shape.shape2D.ALcd2DEditableShape
  - - com.luciad.shape.shape2D.TLcdXYCircularArcBy3Points

All Implemented Interfaces:

ILcdBounded, ILcdCircularArc, ILcdCircularArcBy3Points, ILcdCurve, ILcdShape, ILcd2DEditableCircularArcBy3Points, ILcd2DEditableShape, ILcdCache, ILcdCloneable, Serializable, Cloneable
```
public class TLcdXYCircularArcBy3Points
extends ALcd2DEditableShape
implements ILcd2DEditableCircularArcBy3Points, ILcdCache
```
This class provides an implementation of ILcd2DEditableCircularArcBy3Points in the cartesian space.
This class is thread-safe for concurrent read-only access of its contents. For read-write access, external locking must be used. Such locking is typically done at the model level.

Since:

9.0

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.luciad.shape.ILcdCurve
  INTERPOLATION_CIRCLE_BY_3POINTS, INTERPOLATION_CIRCLE_BY_CENTERPOINT, INTERPOLATION_CIRCULARARC_BY_3POINTS, INTERPOLATION_CIRCULARARC_BY_BULGE, INTERPOLATION_CIRCULARARC_BY_CENTERPOINT, INTERPOLATION_ELLIPTICAL, INTERPOLATION_GEODESIC, INTERPOLATION_LINEAR, INTERPOLATION_MIXED, INTERPOLATION_RHUMB

Constructor Summary

Constructors
Constructor and Description
`TLcdXYCircularArcBy3Points()` Default constructor, initializing all three points at (0,0).
`TLcdXYCircularArcBy3Points(double aStartX, double aStartY, double aIntermediateX, double aIntermediateY, double aEndX, double aEndY)` Creates a new circular arc using the given point coordinates.
`TLcdXYCircularArcBy3Points(ILcdPoint aStartPoint, ILcdPoint aIntermediatePoint, ILcdPoint aEndPoint)` Creates a new circular arc using the given points.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clears the cache.
`Object`	`clone()` Creates and returns a copy of this object, by delegating to `Object.clone()`.
`void`	`computePointSFCT(double aParam, ILcd3DEditablePoint aPointSFCT)` Computes a point of the curve, defined by the given parameter.
`boolean`	`contains2D(double aX, double aY)` Checks whether this `ILcdShape` contains the given point in the 2D space.
`boolean`	`equals(Object o)` An object is considered equal to this shape if it has the same class.
`double`	`getArcAngle()` Returns the angle over which this `ILcdCircularArc` extends (in degrees).
`ILcdBounds`	`getBounds()` Returns the `ILcdBounds` by which the geometry of this `ILcdBounded` object is bounded.
`Object`	`getCachedObject(Object aKey)` Looks up and returns the cached Object corresponding to the given key.
`ILcdPoint`	`getCenter()` Returns the center of this `ILcdCircularArc`.
`ILcdPoint`	`getEndPoint()` Retrieves the end point of the curve.
`double`	`getEndTangent2D()` Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.
`ILcdPoint`	`getFocusPoint()` Returns the focus point of this `ILcdShape`.
`ILcdPoint`	`getIntermediatePoint()` Returns an intermediate point of this arc.
`String`	`getInterpolation()` Returns the interpolation method used by this curve, which is `ILcdCurve.INTERPOLATION_CIRCULARARC_BY_3POINTS`.
`double`	`getLength2D(double aParam1, double aParam2)` Returns the length between two points of the curve, defined by the given parameters.
`int`	`getLineSegmentIntersectionCount(ILcdPoint aP1, ILcdPoint aP2)` Returns the number of intersections between this curve and a line segment defined by the two specified points.
`double`	`getRadius()` Returns the radius of this `ILcdCircularArc`.
`double`	`getStartAngle()` Returns the start angle of this `ILcdCircularArc` (in degrees).
`ILcdPoint`	`getStartPoint()` Retrieves the start point of the curve.
`double`	`getStartTangent2D()` Returns the angle of the curve's tangent at the start point, in degrees counterclockwise from the direction at 3 o'clock.
`double`	`getTangent2D(double aParam)` Returns the angle of the curve's tangent in the point defined by the given parameter, in degrees counterclockwise from the direction at 3 o'clock.
`int`	`hashCode()` The hash code of this shape is the hash code of its class, in order to be consistent with the `ALcdShape.equals(Object)` method.
`void`	`insertIntoCache(Object aKey, Object aObject)` Inserts a cache Object corresponding to the given key Object.
`void`	`moveEndPoint2D(double aX, double aY)` Moves the end point to the given point in the 2D space.
`void`	`moveIntermediatePoint2D(double aX, double aY)` Moves the intermediate point to the given point in the 2D space.
`void`	`moveStartPoint2D(double aX, double aY)` Moves the start point to the given point in the 2D space.
`Object`	`removeCachedObject(Object aKey)` Looks up and removes the cached Object corresponding to the given key.
`String`	`toString()`
`void`	`translate2D(double aDeltaX, double aDeltaY)` Translates this `ILcd2DEditableShape` from its current position over the given translation vector in the 2D space.
`void`	`translateEndPoint2D(double aDeltaX, double aDeltaY)` Translates the end point from its current position over the given translation vector in the 2D space.
`void`	`translateIntermediatePoint2D(double aDeltaX, double aDeltaY)` Translates the intermediate point from its current position over the given translation vector in the 2D space.
`void`	`translateStartPoint2D(double aDeltaX, double aDeltaY)` Translates the start point from its current position over the given translation vector in the 2D space.

Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditableShape
contains3D, move2D, move2D

Methods inherited from class com.luciad.shape.ALcdShape
contains2D, contains3D, fromDomainObject

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.shape.ILcdShape
contains2D, contains3D, contains3D

Methods inherited from interface com.luciad.shape.shape2D.ILcd2DEditableShape
move2D, move2D

- Constructor Detail
  - TLcdXYCircularArcBy3Points
```
public TLcdXYCircularArcBy3Points()
```
    Default constructor, initializing all three points at (0,0).
  - TLcdXYCircularArcBy3Points
```
public TLcdXYCircularArcBy3Points(ILcdPoint aStartPoint,
                                  ILcdPoint aIntermediatePoint,
                                  ILcdPoint aEndPoint)
```
    Creates a new circular arc using the given points.
    
    Parameters:
    
    aStartPoint - the start point of the arc
    
    aIntermediatePoint - a point on the arc that is not the start nor the end point
    
    aEndPoint - the end point of the arc
  - TLcdXYCircularArcBy3Points
```
public TLcdXYCircularArcBy3Points(double aStartX,
                                  double aStartY,
                                  double aIntermediateX,
                                  double aIntermediateY,
                                  double aEndX,
                                  double aEndY)
```
    Creates a new circular arc using the given point coordinates.
    
    Parameters:
    
    aStartX - X-coordinate of the arc's start point
    
    aStartY - Y-coordinate of the arc's start point
    
    aIntermediateX - X-coordinate of a point on the arc that is not the start nor the end point
    
    aIntermediateY - Y-coordinate of a point on the arc that is not the start nor the end point
    
    aEndX - X-coordinate of the arc's end point
    
    aEndY - Y-coordinate of the arc's end point
- Method Detail
  - getCenter
```
public ILcdPoint getCenter()
```
    Description copied from interface: ILcdCircularArc
    
    Returns the center of this ILcdCircularArc.
    
    Specified by:
    
    getCenter in interface ILcdCircularArc
    
    Returns:
    
    the center of this ILcdCircularArc.
  - getRadius
```
public double getRadius()
```
    Description copied from interface: ILcdCircularArc
    
    Returns the radius of this ILcdCircularArc.
    
    Specified by:
    
    getRadius in interface ILcdCircularArc
    
    Returns:
    
    the radius of this ILcdCircularArc.
  - getStartAngle
```
public double getStartAngle()
```
    Description copied from interface: ILcdCircularArc
    
    Returns the start angle of this ILcdCircularArc (in degrees). The angle is measured from 3 o'clock position, positive counter-clockwise.
    
    Specified by:
    
    getStartAngle in interface ILcdCircularArc
    
    Returns:
    
    the start angle of the arc (in degrees). The angle is measured from 3 o'clock position, positive counter-clockwise.
  - getArcAngle
```
public double getArcAngle()
```
    Description copied from interface: ILcdCircularArc
    
    Returns the angle over which this ILcdCircularArc extends (in degrees). The angle is positive counter-clockwise.
    
    Specified by:
    
    getArcAngle in interface ILcdCircularArc
    
    Returns:
    
    the angle over which the arc extends (in degrees). The angle is positive counter-clockwise.
  - getFocusPoint
```
public ILcdPoint getFocusPoint()
```
    Description copied from interface: ILcdShape
    
    Returns the focus point of this ILcdShape.
    
    Specified by:
    
    getFocusPoint in interface ILcdShape
    
    Returns:
    
    the focus point of this ILcdShape.
  - contains2D
```
public boolean contains2D(double aX,
                          double aY)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
    
    Specified by:
    
    contains2D in interface ILcdShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    Returns:
    
    the boolean result of the containment test.
  - getBounds
```
public ILcdBounds getBounds()
```
    Description copied from interface: ILcdBounded
    
    Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
    If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.
    
    Specified by:
    
    getBounds in interface ILcdBounded
    
    Returns:
    
    the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
  - translate2D
```
public void translate2D(double aDeltaX,
                        double aDeltaY)
```
    Description copied from interface: ILcd2DEditableShape
    
    Translates this ILcd2DEditableShape from its current position over the given translation vector in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
    
    Specified by:
    
    translate2D in interface ILcd2DEditableShape
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - moveStartPoint2D
```
public void moveStartPoint2D(double aX,
                             double aY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Moves the start point to the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
    
    Specified by:
    
    moveStartPoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - moveEndPoint2D
```
public void moveEndPoint2D(double aX,
                           double aY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Moves the end point to the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
    
    Specified by:
    
    moveEndPoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - moveIntermediatePoint2D
```
public void moveIntermediatePoint2D(double aX,
                                    double aY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Moves the intermediate point to the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
    
    Specified by:
    
    moveIntermediatePoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - translateStartPoint2D
```
public void translateStartPoint2D(double aDeltaX,
                                  double aDeltaY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Translates the start point from its current position over the given translation vector in the 2D space. Only the first two dimensions of the points are considered. The third dimension is left unchanged.
    
    Specified by:
    
    translateStartPoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - translateEndPoint2D
```
public void translateEndPoint2D(double aDeltaX,
                                double aDeltaY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Translates the end point from its current position over the given translation vector in the 2D space. Only the first two dimensions of the points are considered. The third dimension is left unchanged.
    
    Specified by:
    
    translateEndPoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - translateIntermediatePoint2D
```
public void translateIntermediatePoint2D(double aDeltaX,
                                         double aDeltaY)
```
    Description copied from interface: ILcd2DEditableCircularArcBy3Points
    
    Translates the intermediate point from its current position over the given translation vector in the 2D space. Only the first two dimensions of the points are considered. The third dimension is left unchanged.
    
    Specified by:
    
    translateIntermediatePoint2D in interface ILcd2DEditableCircularArcBy3Points
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - getIntermediatePoint
```
public ILcdPoint getIntermediatePoint()
```
    Description copied from interface: ILcdCircularArcBy3Points
    
    Returns an intermediate point of this arc.
    
    Specified by:
    
    getIntermediatePoint in interface ILcdCircularArcBy3Points
    
    Returns:
    
    an intermediate point of this arc.
  - getStartPoint
```
public ILcdPoint getStartPoint()
```
    Description copied from interface: ILcdCurve
    
    Retrieves the start point of the curve.
    This is equivalent to computePointSFCT(0).
    
    Specified by:
    
    getStartPoint in interface ILcdCurve
    
    Returns:
    
    the start point of the curve
  - getEndPoint
```
public ILcdPoint getEndPoint()
```
    Description copied from interface: ILcdCurve
    
    Retrieves the end point of the curve.
    This is equivalent to computePointSFCT(1).
    
    Specified by:
    
    getEndPoint in interface ILcdCurve
    
    Returns:
    
    the end point of the curve
  - getStartTangent2D
```
public double getStartTangent2D()
```
    Description copied from interface: ILcdCurve
    
    Returns the angle of the curve's tangent at the start point, in degrees counterclockwise from the direction at 3 o'clock.
    The tangent orientation is from the start point towards the rest of the shape.
    This is the same as getTangent2D(0).
    
    Specified by:
    
    getStartTangent2D in interface ILcdCurve
    
    Returns:
    
    the curve's angle in the start point
  - getEndTangent2D
```
public double getEndTangent2D()
```
    Description copied from interface: ILcdCurve
    
    Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.
    The tangent orientation is from the end point, away from the curve before it.
    This is the same as getTangent2D(1).
    
    Specified by:
    
    getEndTangent2D in interface ILcdCurve
    
    Returns:
    
    the curve's angle in the end point
  - getTangent2D
```
public double getTangent2D(double aParam)
```
    Description copied from interface: ILcdCurve
    Returns the angle of the curve's tangent in the point defined by the given parameter, in degrees counterclockwise from the direction at 3 o'clock.
    The tangent orientation is from the point at parameter aParam towards the rest of the shape.
    - The tangent at parameter 0 is the same as ILcdCurve.getStartTangent2D().
    - The tangent at parameter 1 is the same as ILcdCurve.getEndTangent2D().
    Specified by:
    
    getTangent2D in interface ILcdCurve
    
    Parameters:
    
    aParam - a value of the closed interval [0,1]
    
    Returns:
    
    the curve's angle in the point defined by the given parameter
  - getLength2D
```
public double getLength2D(double aParam1,
                          double aParam2)
```
    Description copied from interface: ILcdCurve
    Returns the length between two points of the curve, defined by the given parameters.
    - When aParam1 == aParam2, the length is 0.
    - When aParam1 == 0 and aParam2 == 1, the length is the whole length of the curve.
    - When aParam1 > aParam2, the length is (aParam1 to 1) + (0 to aParam2).
    Specified by:
    
    getLength2D in interface ILcdCurve
    
    Parameters:
    
    aParam1 - a value of the closed interval [0,1]
    
    aParam2 - a value of the closed interval [0,1]
    
    Returns:
    
    the length of the curve.
  - getInterpolation
```
public String getInterpolation()
```
    Returns the interpolation method used by this curve, which is ILcdCurve.INTERPOLATION_CIRCULARARC_BY_3POINTS.
    
    Specified by:
    
    getInterpolation in interface ILcdCircularArc
    
    Specified by:
    
    getInterpolation in interface ILcdCircularArcBy3Points
    
    Specified by:
    
    getInterpolation in interface ILcdCurve
    
    Returns:
    
    the interpolation method used by this curve, which is INTERPOLATION_CIRCULARARC_BY_3POINTS.
  - computePointSFCT
```
public void computePointSFCT(double aParam,
                             ILcd3DEditablePoint aPointSFCT)
```
    Description copied from interface: ILcdCurve
    Computes a point of the curve, defined by the given parameter.
    - At parameter 0, the point is the same as ILcdCurve.getStartPoint().
    - At parameter 1, the point is the same as ILcdCurve.getEndPoint().
    Specified by:
    
    computePointSFCT in interface ILcdCurve
    
    Parameters:
    
    aParam - a value of the closed interval [0,1]
    
    aPointSFCT - the point to store the computed curve point in
  - insertIntoCache
```
public void insertIntoCache(Object aKey,
                            Object aObject)
```
    Description copied from interface: ILcdCache
    
    Inserts a cache Object corresponding to the given key Object.
    
    Specified by:
    
    insertIntoCache in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that will be used to identify the Object. The key must therefore be a unique identifier, typically the caller itself: insertIntoCache(this, ...).
    
    aObject - the Object to be cached.
  - getCachedObject
```
public Object getCachedObject(Object aKey)
```
    Description copied from interface: ILcdCache
    
    Looks up and returns the cached Object corresponding to the given key.
    
    Specified by:
    
    getCachedObject in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that was used for storing the cache Object.
    
    Returns:
    
    the cached Object, or null if there is no Object corresponding to the given key.
  - removeCachedObject
```
public Object removeCachedObject(Object aKey)
```
    Description copied from interface: ILcdCache
    
    Looks up and removes the cached Object corresponding to the given key.
    
    Specified by:
    
    removeCachedObject in interface ILcdCache
    
    Parameters:
    
    aKey - the key Object that was used for storing the cache Object.
    
    Returns:
    
    the cached Object, or null if there was no Object corresponding to the given key.
  - clearCache
```
public void clearCache()
```
    Description copied from interface: ILcdCache
    
    Clears the cache.
    
    Specified by:
    
    clearCache in interface ILcdCache
  - clone
```
public Object clone()
```
    Description copied from class: ALcdShape
    
    Creates and returns a copy of this object, by delegating to Object.clone(). Extensions should delegate to this implementation with super.clone(), in order to create an object instance of the right type, with all fields copied. They then should explicitly clone any non-primitive fields for which a deeper clone is required.
    
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class ALcdShape
    
    See Also:
    
    Object.clone()
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: ALcdShape
    
    An object is considered equal to this shape if it has the same class. Extensions should refine this comparison, based on their properties.
    
    Overrides:
    
    equals in class ALcdShape
  - hashCode
```
public int hashCode()
```
    Description copied from class: ALcdShape
    
    The hash code of this shape is the hash code of its class, in order to be consistent with the ALcdShape.equals(Object) method. Extensions should refine this implementation, based on their properties.
    
    Overrides:
    
    hashCode in class ALcdShape
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLineSegmentIntersectionCount
```
public int getLineSegmentIntersectionCount(ILcdPoint aP1,
                                           ILcdPoint aP2)
```
    Description copied from interface: ILcdCurve
    
    Returns the number of intersections between this curve and a line segment defined by the two specified points.
    This information can be used to perform containment calculations, if this curve is closed or if this curve is part of a composite closed curve. By determining the number of intersections between this curve and a line segment starting from a given point in a fixed direction, one can determine whether a point is located within the closed curve by using the even-odd rule.
    
    Specified by:
    
    getLineSegmentIntersectionCount in interface ILcdCurve
    
    Parameters:
    
    aP1 - the first point of the line segment
    
    aP2 - the second point of the line segment
    
    Returns:
    
    the number of intersections between the curve and the line segment

LuciadLightspeedClass TLcdXYCircularArcBy3Points

Field Summary

Fields inherited from interface com.luciad.shape.ILcdCurve

Constructor Summary

Method Summary

Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditableShape

Methods inherited from class com.luciad.shape.ALcdShape

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdShape

Methods inherited from interface com.luciad.shape.shape2D.ILcd2DEditableShape

Constructor Detail

TLcdXYCircularArcBy3Points

TLcdXYCircularArcBy3Points

TLcdXYCircularArcBy3Points

Method Detail

getCenter

getRadius

getStartAngle

getArcAngle

getFocusPoint

contains2D

getBounds

translate2D

moveStartPoint2D

moveEndPoint2D

moveIntermediatePoint2D

translateStartPoint2D

translateEndPoint2D

translateIntermediatePoint2D

getIntermediatePoint

getStartPoint

getEndPoint

getStartTangent2D

getEndTangent2D

getTangent2D

getLength2D

getInterpolation

computePointSFCT

insertIntoCache

getCachedObject

removeCachedObject

clearCache

clone

equals

hashCode

toString

getLineSegmentIntersectionCount