Class TLcdXYEllipse
- All Implemented Interfaces:
ILcdBounded
,ILcdCurve
,ILcdEllipse
,ILcdRing
,ILcdShape
,ILcd2DEditableEllipse
,ILcd2DEditableShape
,ILcdCache
,ILcdCloneable
,Serializable
,Cloneable
- Direct Known Subclasses:
TLcdCGMEllipse
,TLcdDGNEllipse2D
ILcd2DEditableEllipse
in
the cartesian space.
It implements ILcdCache
, thus providing a cache
to store expensive calculations, e.g. for painters,
to store model-world transformations. The cache is cleared whenever the shape is modified.
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.
- See Also:
-
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
Fields inherited from interface com.luciad.shape.ILcdEllipse
MAJOR_RADIUS_CORNER, MAJOR_RADIUS_OPPOSITE_CORNER, MINOR_RADIUS_CORNER, MINOR_RADIUS_OPPOSITE_CORNER
-
Constructor Summary
ConstructorDescriptionCreates a newTLcdXYEllipse
with all of its parameters set to 0.TLcdXYEllipse
(double aCenterX, double aCenterY, double aA, double aB, double aRotAngle) Creates a newTLcdXYEllipse
with the specified parameters.TLcdXYEllipse
(ILcd2DEditableEllipse aEllipse) Creates a newTLcdXYEllipse
with its parameters copied from the given ellipse.TLcdXYEllipse
(ILcd2DEditablePoint aCenter, double aA, double aB, double aRotAngle) Creates a newTLcdXYEllipse
with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears the cache.clone()
Creates and returns a copy of this object.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 thisILcdShape
contains the given point in the 2D space.void
corner2DEditablePointSFCT
(int aCorner, ILcd2DEditablePoint a2DEditablePointSFCT) Computes the position of the specified corner of thisILcdEllipse
.boolean
Returns whether the given object has the same class and the same coordinates and parameters.final double
getA()
Returns the length of the semi-major axis.final double
getB()
Returns the length of the semi-minor axis.Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.getCachedObject
(Object aKey) Looks up and returns the cached Object corresponding to the given key.Returns the center of thisILcdEllipse
.Retrieves the end point of the curve.double
Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.Returns the focus point of thisILcdShape
.Returns the interpolation method used by this curve.double
getLength2D
(double aParam1, double aParam2) Returns the length between two points of the curve, defined by the given parameters.int
Returns the number of intersections between this curve and a line segment defined by the two specified points.final double
Returns the rotation angle of the major axis (in degrees).Retrieves the start point of the curve.double
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 theALcdShape.equals(Object)
method.void
insertIntoCache
(Object aKey, Object aObject) Inserts a cache Object corresponding to the given key Object.protected void
void
move2D
(double x, double y) Translates this shape so that its focus point ends up at the specified position.removeCachedObject
(Object aKey) Looks up and removes the cached Object corresponding to the given key.void
setA
(double aA) Sets the length of the semi-major axis.void
setB
(double aB) Sets the length of the semi-minor axis.void
setRotAngle
(double aRotAngle) Sets the rotation angle of the major axis (in degrees).toString()
void
translate2D
(double x, double y) Translates thisILcd2DEditableShape
from its current position over the given translation vector in the 2D space.void
updateForCornerPoint2D
(int aCorner, ILcdPoint aPoint) Updates the ellipse for the specified corner point location.Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditableShape
contains3D, 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.shape2D.ILcd2DEditableShape
move2D
Methods inherited from interface com.luciad.shape.ILcdShape
contains2D, contains3D, contains3D
-
Constructor Details
-
TLcdXYEllipse
public TLcdXYEllipse()Creates a newTLcdXYEllipse
with all of its parameters set to 0. -
TLcdXYEllipse
Creates a newTLcdXYEllipse
with its parameters copied from the given ellipse.- Parameters:
aEllipse
- the ellipse from which the parameters are copied.
-
TLcdXYEllipse
Creates a newTLcdXYEllipse
with the specified parameters.- Parameters:
aCenter
- the center of the arc.aA
- the length of the semi-major axis.aB
- the length of the semi-minor axis.aRotAngle
- the rotation angle (in degrees).- Throws:
IllegalArgumentException
- if either the length of the semi-major or semi-minor axis is negative.
-
TLcdXYEllipse
public TLcdXYEllipse(double aCenterX, double aCenterY, double aA, double aB, double aRotAngle) Creates a newTLcdXYEllipse
with the specified parameters.- Parameters:
aCenterX
- the x coordinate of the center.aCenterY
- the y coordinate of the center.aA
- the length of the semi-major axis.aB
- the length of the semi-minor axis.aRotAngle
- the rotation angle (in degrees).- Throws:
IllegalArgumentException
- if either the length of the semi-major or semi-minor axis is negative.
-
-
Method Details
-
getCenter
Description copied from interface:ILcdEllipse
Returns the center of thisILcdEllipse
.- Specified by:
getCenter
in interfaceILcdEllipse
- Returns:
- the center of this
ILcdEllipse
.
-
getA
public final double getA()Description copied from interface:ILcdEllipse
Returns the length of the semi-major axis.- Specified by:
getA
in interfaceILcdEllipse
- Returns:
- the length of the semi-major axis.
-
setA
public void setA(double aA) Sets the length of the semi-major axis. This value must not be negative.- Specified by:
setA
in interfaceILcd2DEditableEllipse
- Parameters:
aA
- the length of the semi-major axis (in meters). This value must not be negative.- Throws:
IllegalArgumentException
- if the length of the semi-major axis is negative.
-
getB
public final double getB()Description copied from interface:ILcdEllipse
Returns the length of the semi-minor axis.- Specified by:
getB
in interfaceILcdEllipse
- Returns:
- the length of the semi-minor axis.
-
setB
public void setB(double aB) Sets the length of the semi-minor axis. This value must not be negative.- Specified by:
setB
in interfaceILcd2DEditableEllipse
- Parameters:
aB
- the length of the semi-minor axis (in meters). This value must not be negative.- Throws:
IllegalArgumentException
- if the length of the semi-major axis is negative.
-
getRotAngle
public final double getRotAngle()Description copied from interface:ILcdEllipse
Returns the rotation angle of the major axis (in degrees). The angle is measured from 3 o'clock position, positive counter-clockwise.- Specified by:
getRotAngle
in interfaceILcdEllipse
- Returns:
- the rotation angle of the major axis (in degrees). The angle is measured from 3 o'clock position, positive counter-clockwise.
-
setRotAngle
public void setRotAngle(double aRotAngle) Description copied from interface:ILcd2DEditableEllipse
Sets the rotation angle of the major axis (in degrees). The angle is measured from 3 o'clock position, positive counter-clockwise.- Specified by:
setRotAngle
in interfaceILcd2DEditableEllipse
- Parameters:
aRotAngle
- the new rotation angle.
-
getFocusPoint
Description copied from interface:ILcdShape
Returns the focus point of thisILcdShape
.- Specified by:
getFocusPoint
in interfaceILcdShape
- Returns:
- the focus point of this
ILcdShape
.
-
corner2DEditablePointSFCT
Description copied from interface:ILcdEllipse
Computes the position of the specified corner of thisILcdEllipse
.- Specified by:
corner2DEditablePointSFCT
in interfaceILcdEllipse
- Parameters:
aCorner
- the corner:ILcdEllipse.MAJOR_RADIUS_CORNER
,ILcdEllipse.MINOR_RADIUS_CORNER
,ILcdEllipse.MAJOR_RADIUS_OPPOSITE_CORNER
,ILcdEllipse.MINOR_RADIUS_OPPOSITE_CORNER
.a2DEditablePointSFCT
- anILcd2DEditablePoint
into which the result is written as a side-effect.
-
updateForCornerPoint2D
Description copied from interface:ILcd2DEditableEllipse
Updates the ellipse for the specified corner point location. The end point of the axis should be at the specified location on return of this method.- Specified by:
updateForCornerPoint2D
in interfaceILcd2DEditableEllipse
- Parameters:
aCorner
- a constant indicating which corner is to be moved:ILcdEllipse.MAJOR_RADIUS_CORNER
,ILcdEllipse.MINOR_RADIUS_CORNER
,ILcdEllipse.MAJOR_RADIUS_OPPOSITE_CORNER
,ILcdEllipse.MINOR_RADIUS_OPPOSITE_CORNER
.aPoint
- the new coordinate of the point.
-
getBounds
Description copied from interface:ILcdBounded
Returns theILcdBounds
by which the geometry of thisILcdBounded
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 ofTLcdLonLatBounds
orTLcdXYBounds
.- Specified by:
getBounds
in interfaceILcdBounded
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-
invalidateBounds
protected void invalidateBounds() -
contains2D
public boolean contains2D(double aX, double aY) Description copied from interface:ILcdShape
Checks whether thisILcdShape
contains the given point in the 2D space. Only the first two dimensions of theILcdShape
are considered.- Specified by:
contains2D
in interfaceILcdShape
- Parameters:
aX
- the x coordinate of the point.aY
- the y coordinate of the point.- Returns:
- the boolean result of the containment test.
-
translate2D
public void translate2D(double x, double y) Description copied from interface:ILcd2DEditableShape
Translates thisILcd2DEditableShape
from its current position over the given translation vector in the 2D space. Only the first two dimensions of theILcdShape
are considered. The third dimension is left unchanged.- Specified by:
translate2D
in interfaceILcd2DEditableShape
- Parameters:
x
- the x coordinate of the translation vector.y
- the y coordinate of the translation vector.
-
move2D
public void move2D(double x, double y) Description copied from class:ALcd2DEditableShape
Translates this shape so that its focus point ends up at the specified position.- Specified by:
move2D
in interfaceILcd2DEditableShape
- Overrides:
move2D
in classALcd2DEditableShape
- Parameters:
x
- the x coordinate of the point.y
- the y coordinate of the point.
-
insertIntoCache
Description copied from interface:ILcdCache
Inserts a cache Object corresponding to the given key Object.- Specified by:
insertIntoCache
in interfaceILcdCache
- 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
Description copied from interface:ILcdCache
Looks up and returns the cached Object corresponding to the given key.- Specified by:
getCachedObject
in interfaceILcdCache
- 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
Description copied from interface:ILcdCache
Looks up and removes the cached Object corresponding to the given key.- Specified by:
removeCachedObject
in interfaceILcdCache
- 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 interfaceILcdCache
-
clone
Creates and returns a copy of this object.The contained center point is cloned.
The cache is not copied or cloned at all.
- Specified by:
clone
in interfaceILcdCloneable
- Overrides:
clone
in classALcdShape
- See Also:
-
equals
Returns whether the given object has the same class and the same coordinates and parameters. -
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 theALcdShape.equals(Object)
method. Extensions should refine this implementation, based on their properties. -
toString
-
getStartPoint
Description copied from interface:ILcdCurve
Retrieves the start point of the curve.This is equivalent to
computePointSFCT(0)
.- Specified by:
getStartPoint
in interfaceILcdCurve
- Returns:
- the start point of the curve
-
getEndPoint
Description copied from interface:ILcdCurve
Retrieves the end point of the curve.This is equivalent to
computePointSFCT(1)
.- Specified by:
getEndPoint
in interfaceILcdCurve
- 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 interfaceILcdCurve
- 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 interfaceILcdCurve
- 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 interfaceILcdCurve
- Parameters:
aParam
- a value of the closed interval [0,1]- Returns:
- the curve's angle in the point defined by the given parameter
- The tangent at parameter 0 is the same as
-
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 interfaceILcdCurve
- 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.
- When
-
computePointSFCT
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 interfaceILcdCurve
- Parameters:
aParam
- a value of the closed interval [0,1]aPointSFCT
- the point to store the computed curve point in
- At parameter 0, the point is the same as
-
getInterpolation
Description copied from interface:ILcdCurve
Returns the interpolation method used by this curve.A set of predefined constants are defined in this interface, which are used by the default
ILcdCurve
implementations provided by LuciadLightspeed.Custom implementations can define their own constants, and use them to interpret the interpolation of the curve.
- Specified by:
getInterpolation
in interfaceILcdCurve
- Returns:
- the interpolation method used by this curve.
-
getLineSegmentIntersectionCount
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 interfaceILcdCurve
- Parameters:
aP1
- the first point of the line segmentaP2
- the second point of the line segment- Returns:
- the number of intersections between the curve and the line segment
-