public class TLcdNVG20RectangularRing extends TLcdDataObject implements ILcd2DEditableShape, ILcdOrientationSettable, ILcdCache, ILcdInvalidateable, ILcdRing
ILcd2DEditableShape
that represents an NVG 2.0 Rectangular Ring.Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
A_PROPERTY
Data property that maps to the
rx attribute. |
static TLcdDataProperty |
B_PROPERTY
Data property that maps to the
ry attribute. |
static TLcdDataProperty |
ROT_ANGLE_PROPERTY
Data property that maps to the
rotation attribute. |
static TLcdDataProperty |
X_PROPERTY
Data property that maps to the
cx attribute. |
static TLcdDataProperty |
Y_PROPERTY
Data property that maps to the
cy attribute. |
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 and Description |
---|
TLcdNVG20RectangularRing() |
TLcdNVG20RectangularRing(TLcdDataType aType) |
Modifier and Type | Method and Description |
---|---|
void |
clearCache()
Clears the cache.
|
TLcdNVG20RectangularRing |
clone()
Returns a deep clone of this object.
|
TLcdNVG20RectangularRing |
clone(Map aObjectDictionary)
Returns a deep clone 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 this
ILcdShape contains the given point in
the 2D space. |
boolean |
contains2D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 2D space. |
boolean |
contains3D(double aX,
double aY,
double aZ)
Checks whether this
ILcdShape contains the given point in
the 3D space. |
boolean |
contains3D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 3D space. |
double |
getA()
Returns the value of the property that maps to the
rx attribute. |
double |
getB()
Returns the value of the property that maps to the
ry attribute. |
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.
|
ILcdEllipsoid |
getEllipsoid() |
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 . |
String |
getInterpolation()
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 |
getLineSegmentIntersectionCount(ILcdPoint aP1,
ILcdPoint aP2)
Returns the number of intersections between this curve and a line segment
defined by the two specified points.
|
double |
getOrientation()
Returns the orientation of this object in degrees.
|
double |
getRotAngle()
Returns the value of the property that maps to the
rotation attribute. |
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.
|
double |
getX()
Returns the value of the property that maps to the
cx attribute. |
double |
getY()
Returns the value of the property that maps to the
cy attribute. |
void |
insertIntoCache(Object aKey,
Object aValue)
Inserts a cache Object corresponding to the given key Object.
|
void |
invalidateObject()
Invalidates all cached values of this object.
|
void |
move2D(double aX,
double aY)
Moves this
ILcd2DEditableShape to the given point in the 2D space. |
void |
move2D(ILcdPoint aPoint)
Moves this
ILcd2DEditableShape to the given point in the 2D space. |
Object |
removeCachedObject(Object aKey)
Looks up and removes the cached Object corresponding to the given key.
|
void |
setA(double aValue)
Sets the value of the property that maps to the
rx attribute. |
void |
setB(double aValue)
Sets the value of the property that maps to the
ry attribute. |
void |
setEllipsoid(ILcdEllipsoid aEllipsoid) |
void |
setOrientation(double aOrientation)
Sets the orientation on this object.
|
void |
setRotAngle(double aValue)
Sets the value of the property that maps to the
rotation attribute. |
void |
setX(double aValue)
Sets the value of the property that maps to the
cx attribute. |
void |
setY(double aValue)
Sets the value of the property that maps to the
cy attribute. |
void |
translate2D(double aDeltaX,
double aDeltaY)
Translates this
ILcd2DEditableShape from its current position over the given translation
vector in the 2D space. |
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
public static final TLcdDataProperty X_PROPERTY
cx
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty Y_PROPERTY
cy
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty ROT_ANGLE_PROPERTY
rotation
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty A_PROPERTY
rx
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty B_PROPERTY
ry
attribute.
The possible values for this property are instances of double
.public TLcdNVG20RectangularRing()
public TLcdNVG20RectangularRing(TLcdDataType aType)
public TLcdNVG20RectangularRing clone(Map aObjectDictionary)
TLcdDataObject
ILcdDataObject
, the value is cloned by first creating a new instance via
the value.getDataType().newInstance()
method, and then cloning its properties one by one.ILcdDeepCloneable
or
ILcdCloneable
then this interface is used to clone the value.clone
in interface ILcdDeepCloneable
clone
in class TLcdDataObject
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public void setEllipsoid(ILcdEllipsoid aEllipsoid)
public ILcdEllipsoid getEllipsoid()
public TLcdNVG20RectangularRing clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdDataObject
Object.clone()
public void setOrientation(double aOrientation)
ILcdOrientationSettable
setOrientation
in interface ILcdOrientationSettable
aOrientation
- the orientation specified in degrees with 0 located at 12 o'clock and increasing clockwise.ILcdOriented.getOrientation()
public double getOrientation()
ILcdOriented
If there is no rotation known for this object, return Double.NaN
.
getOrientation
in interface ILcdOriented
NaN
if undefined.public void move2D(ILcdPoint aPoint)
ILcd2DEditableShape
ILcd2DEditableShape
to the given point in the 2D space. The focus point
is used as the handle by which the shape is moved. Only the first
two dimensions of the ILcdShape
and the ILcdPoint
are considered.
The third dimension is left unchanged.move2D
in interface ILcd2DEditableShape
aPoint
- the ILcdPoint
to move to.ILcd2DEditableShape.move2D(double, double)
public boolean contains3D(double aX, double aY, double aZ)
ILcdShape
ILcdShape
contains the given point in
the 3D space.contains3D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.aZ
- the z coordinate of the point.public boolean contains3D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 3D space.contains3D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains3D(double, double, double)
public void move2D(double aX, double aY)
ILcd2DEditableShape
ILcd2DEditableShape
to the given point in the 2D space. The focus point
is used as the handle by which the shape is moved. Only the first
two dimensions of the ILcdShape
are considered.
The third dimension is left unchanged.move2D
in interface ILcd2DEditableShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public void translate2D(double aDeltaX, double aDeltaY)
ILcd2DEditableShape
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.translate2D
in interface ILcd2DEditableShape
aDeltaX
- the x coordinate of the translation vector.aDeltaY
- the y coordinate of the translation vector.public ILcdBounds getBounds()
ILcdBounded
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
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.public Object getCachedObject(Object aKey)
ILcdCache
getCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public void clearCache()
ILcdCache
clearCache
in interface ILcdCache
public Object removeCachedObject(Object aKey)
ILcdCache
removeCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public void insertIntoCache(Object aKey, Object aValue)
ILcdCache
insertIntoCache
in interface ILcdCache
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, ...)
.aValue
- the Object to be cached.public boolean contains2D(double aX, double aY)
ILcdShape
ILcdShape
contains the given point in
the 2D space. Only the first two dimensions of the ILcdShape
are considered.contains2D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public boolean contains2D(ILcdPoint aPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 2D space.
Only the first two dimensions of the ILcdShape
and the ILcdPoint
are considered.contains2D
in interface ILcdShape
aPoint
- the ILcdPoint
to test.ILcdShape.contains2D(double, double)
public void invalidateObject()
ILcdInvalidateable
invalidateObject
in interface ILcdInvalidateable
public double getTangent2D(double aParam)
ILcdCurve
The tangent orientation is from the point at parameter aParam
towards the rest of the shape.
ILcdCurve.getStartTangent2D()
.ILcdCurve.getEndTangent2D()
.getTangent2D
in interface ILcdCurve
aParam
- a value of the closed interval [0,1]public double getStartTangent2D()
ILcdCurve
The tangent orientation is from the start point towards the rest of the shape.
This is the same as getTangent2D(0)
.
getStartTangent2D
in interface ILcdCurve
public ILcdPoint getStartPoint()
ILcdCurve
This is equivalent to computePointSFCT(0)
.
getStartPoint
in interface ILcdCurve
public int getLineSegmentIntersectionCount(ILcdPoint aP1, ILcdPoint aP2)
ILcdCurve
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.
getLineSegmentIntersectionCount
in interface ILcdCurve
aP1
- the first point of the line segmentaP2
- the second point of the line segmentpublic double getLength2D(double aParam1, double aParam2)
ILcdCurve
aParam1 == aParam2
, the length is 0.aParam1 == 0 and aParam2 == 1
, the length is the whole length of the curve.aParam1 > aParam2
, the length is (aParam1 to 1
) + (0 to aParam2
).getLength2D
in interface ILcdCurve
aParam1
- a value of the closed interval [0,1]aParam2
- a value of the closed interval [0,1]public String getInterpolation()
ILcdCurve
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.
getInterpolation
in interface ILcdCurve
public double getEndTangent2D()
ILcdCurve
The tangent orientation is from the end point, away from the curve before it.
This is the same as getTangent2D(1)
.
getEndTangent2D
in interface ILcdCurve
public ILcdPoint getEndPoint()
ILcdCurve
This is equivalent to computePointSFCT(1)
.
getEndPoint
in interface ILcdCurve
public void computePointSFCT(double aParam, ILcd3DEditablePoint aPointSFCT)
ILcdCurve
ILcdCurve.getStartPoint()
.ILcdCurve.getEndPoint()
.computePointSFCT
in interface ILcdCurve
aParam
- a value of the closed interval [0,1]aPointSFCT
- the point to store the computed curve point inpublic void setX(double aValue)
cx
attribute.
Center longitude in decimal degrees (WGS84)
aValue
- the value to set for the X_PROPERTY
property.public void setY(double aValue)
cy
attribute.
Center latitude in decimal degrees (WGS84)
aValue
- the value to set for the Y_PROPERTY
property.public void setRotAngle(double aValue)
rotation
attribute.
Rotation in the counter-clockwise direction around the center point (cx, cy). The default value is 0.0 degrees rotation.
aValue
- the value to set for the ROT_ANGLE_PROPERTY
property.public void setA(double aValue)
rx
attribute.
The half length of the rectangle from the center point along the X axis (East/West) prior to rotation, in meters. This number should be positive.
aValue
- the value to set for the A_PROPERTY
property.public void setB(double aValue)
ry
attribute.
The half length of the rectangle from the center point along the Y axis (North/South) prior to rotation, in meters. This number should be positive.
aValue
- the value to set for the B_PROPERTY
property.public double getX()
cx
attribute.
Center longitude in decimal degrees (WGS84)
X_PROPERTY
property.public double getY()
cy
attribute.
Center latitude in decimal degrees (WGS84)
Y_PROPERTY
property.public double getRotAngle()
rotation
attribute.
Rotation in the counter-clockwise direction around the center point (cx, cy). The default value is 0.0 degrees rotation.
ROT_ANGLE_PROPERTY
property.public double getA()
rx
attribute.
The half length of the rectangle from the center point along the X axis (East/West) prior to rotation, in meters. This number should be positive.
A_PROPERTY
property.public double getB()
ry
attribute.
The half length of the rectangle from the center point along the Y axis (North/South) prior to rotation, in meters. This number should be positive.
B_PROPERTY
property.