public class TLcdNVG15Polyline extends TLcdNVG15MapObject implements ILcd2DEditablePolyline, ILcdCurve, ILcdCache, ILcdInvalidateable
ILcd2DEditablePolyline
that represents an NVG 1.5 Polyline.Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
LABEL_PROPERTY
Data property that maps to the
label attribute. |
static TLcdDataProperty |
LEG_TYPE_PROPERTY
Data property that maps to the
leg-type attribute. |
static TLcdDataProperty |
MODIFIERS_PROPERTY
Data property that maps to the
modifiers attribute. |
static TLcdDataProperty |
POINTS_PROPERTY
Data property that maps to the
points attribute. |
static TLcdDataProperty |
STYLE_PROPERTY
Data property that maps to the
style attribute. |
static TLcdDataProperty |
SYMBOL_PROPERTY
Data property that maps to the
symbol attribute. |
static TLcdDataProperty |
URI_PROPERTY
Data property that maps to the
uri attribute. |
EXTENDED_DATA_PROPERTY, METADATA_PROPERTY
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 |
---|
TLcdNVG15Polyline() |
TLcdNVG15Polyline(TLcdDataType aDataType)
Constructs a new instance of TLcdNVG15Polyline with the given data type.
|
Modifier and Type | Method and Description |
---|---|
void |
clearCache()
Clears the cache.
|
TLcdNVG15Polyline |
clone()
Returns a deep clone of this object.
|
TLcdNVG15Polyline |
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. |
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 |
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.
|
String |
getLabel()
Returns the value of the property that maps to the
label attribute. |
String |
getLegType()
Returns the value of the property that maps to the
leg-type attribute. |
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.
|
TLcdNVGModifiers |
getModifiers()
Returns the value of the property that maps to the
modifiers attribute. |
ILcdPoint |
getPoint(int aIndex)
Returns the
ILcdPoint at a given index. |
int |
getPointCount()
Returns the number of
ILcdPoint objects in the list. |
ILcd2DEditablePointList |
getPoints()
Returns the value of the property that maps to the
points 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.
|
TLcdNVGStyle |
getStyle()
Returns the value of the property that maps to the
style attribute. |
TLcdNVGSymbol |
getSymbol()
Returns the value of the property that maps to the
symbol attribute. |
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.
|
URI |
getUri()
Returns the value of the property that maps to the
uri attribute. |
void |
insert2DPoint(int aIndex,
double aX,
double aY)
Inserts a point at the given index into this
ILcd2DEditablePointList . |
void |
insertIntoCache(Object aKey,
Object aObject)
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. |
void |
move2DPoint(int aIndex,
double aX,
double aY)
Moves the specified point of this
ILcd2DEditablePointList 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 |
removePointAt(int aIndex)
Removes the point at the given index from this
ILcd2DEditablePointList . |
void |
setLabel(String aValue)
Sets the value of the property that maps to the
label attribute. |
void |
setLegType(String aLegType)
Set the interpolation for the polyline.
|
void |
setModifiers(TLcdNVGModifiers aValue)
Sets the value of the property that maps to the
modifiers attribute. |
void |
setPoints(ILcd2DEditablePointList aValue)
Sets the value of the property that maps to the
points attribute. |
void |
setStyle(TLcdNVGStyle aValue)
Sets the value of the property that maps to the
style attribute. |
void |
setSymbol(TLcdNVGSymbol aValue)
Sets the value of the property that maps to the
symbol attribute. |
void |
setUri(URI aValue)
Sets the value of the property that maps to the
uri attribute. |
void |
setValue(TLcdDataProperty aProperty,
Object aValue)
Sets the value of the given property for this data object.
|
void |
translate2D(double aDeltaX,
double aDeltaY)
Translates this
ILcd2DEditableShape from its current position over the given translation
vector in the 2D space. |
void |
translate2DPoint(int aIndex,
double aDeltaX,
double aDeltaY)
Translates the specified point of this
ILcd2DEditablePointList from its current position
over the given translation vector in the 2D space. |
getAPP6CodedFromMapObject, getMS2525CodedFromMapObject, setSymbolFromAPP6, setSymbolFromMS2525
getExtendedData, getMetadata, setExtendedData, setMetadata
getParent, setParent
getDataType, getValue, getValue, hasValue, hasValue, setValue, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
append2DPoint
getPointSFCT, getX, getY, getZ
public static final TLcdDataProperty LEG_TYPE_PROPERTY
leg-type
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty POINTS_PROPERTY
points
attribute.
The possible values for this property are instances of ILcd2DEditablePointList
.public static final TLcdDataProperty MODIFIERS_PROPERTY
modifiers
attribute.
The possible values for this property are instances of TLcdNVGModifiers
.public static final TLcdDataProperty SYMBOL_PROPERTY
symbol
attribute.
The possible values for this property are instances of TLcdNVGSymbol
.public static final TLcdDataProperty LABEL_PROPERTY
label
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty STYLE_PROPERTY
style
attribute.
The possible values for this property are instances of TLcdNVGStyle
.public static final TLcdDataProperty URI_PROPERTY
uri
attribute.
The possible values for this property are instances of URI
.public TLcdNVG15Polyline()
public TLcdNVG15Polyline(TLcdDataType aDataType)
aDataType
- The data type of the polygonpublic TLcdNVG15Polyline clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdDataObject
Object.clone()
public TLcdNVG15Polyline 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 setValue(TLcdDataProperty aProperty, Object aValue)
Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.
The given property must be declared in thedata object's type
or in one of its super types. In
other words, getDataType().getProperties().contains( aProperty ) should always be true.
Otherwise, the implementation should throw an IllegalArgumentException
.setValue
in interface ILcdDataObject
setValue
in class TLcdDataObject
aProperty
- the property for which the value is to be setaValue
- the value to setTLcdDataType.getProperty(String)
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 Object getCachedObject(Object aKey)
ILcdCache
getCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public void insertIntoCache(Object aKey, Object aObject)
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, ...)
.aObject
- the Object to be cached.public void invalidateObject()
ILcdInvalidateable
invalidateObject
in interface ILcdInvalidateable
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 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 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 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 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 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 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 getEndPoint()
ILcdCurve
This is equivalent to computePointSFCT(1)
.
getEndPoint
in interface ILcdCurve
public ILcdPoint getStartPoint()
ILcdCurve
This is equivalent to computePointSFCT(0)
.
getStartPoint
in interface ILcdCurve
public void removePointAt(int aIndex)
ILcd2DEditablePointList
ILcd2DEditablePointList
.removePointAt
in interface ILcd2DEditablePointList
aIndex
- a valid index in the list of ILcdPoint
objects.public void insert2DPoint(int aIndex, double aX, double aY)
ILcd2DEditablePointList
ILcd2DEditablePointList
.insert2DPoint
in interface ILcd2DEditablePointList
aIndex
- a valid new index in the list of points.aX
- the x coordinate of the new point.aY
- the y coordinate of the new point.public void translate2DPoint(int aIndex, double aDeltaX, double aDeltaY)
ILcd2DEditablePointList
ILcd2DEditablePointList
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.translate2DPoint
in interface ILcd2DEditablePointList
aDeltaX
- the x coordinate of the translation vector.aDeltaY
- the y coordinate of the translation vector.public void setLegType(String aLegType)
ILcdCurve.INTERPOLATION_RHUMB
and
ILcdCurve.INTERPOLATION_GEODESIC
. Other values will be considered equal to geodesic;aLegType
- the interpolationpublic void setPoints(ILcd2DEditablePointList aValue)
points
attribute.
Point list in decimal degrees, coordinate pairs, separated by spaces: lon1,lat1 lon2,lat2 ... lonn,latn
aValue
- the value to set for the POINTS_PROPERTY
property.public void move2DPoint(int aIndex, double aX, double aY)
ILcd2DEditablePointList
ILcd2DEditablePointList
to the given point in the 2D space. Only the first
two dimensions of the ILcdShape
are considered.
The third dimension is left unchanged.move2DPoint
in interface ILcd2DEditablePointList
aIndex
- a valid index in the list of points.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 ILcd2DEditablePointList
translate2D
in interface ILcd2DEditableShape
aDeltaX
- the x coordinate of the translation vector.aDeltaY
- the y coordinate of the translation vector.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 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 ILcdPoint getPoint(int aIndex) throws IndexOutOfBoundsException
ILcdPointList
ILcdPoint
at a given index.getPoint
in interface ILcdPointList
aIndex
- a valid index in the list of ILcdPoint
objects.ILcdPoint
at the given index.IndexOutOfBoundsException
- if the given index is out of bounds.public int getPointCount()
ILcdPointList
ILcdPoint
objects in the list.getPointCount
in interface ILcdPointList
ILcdPoint
objects in the list.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 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 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 ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.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 String getLegType()
leg-type
attribute.LEG_TYPE_PROPERTY
property.public ILcd2DEditablePointList getPoints()
points
attribute.
Point list in decimal degrees, coordinate pairs, separated by spaces: lon1,lat1 lon2,lat2 ... lonn,latn
POINTS_PROPERTY
property.public TLcdNVGModifiers getModifiers()
modifiers
attribute.
Modifiers to the specified symbology, possibly including rendering hints.
MODIFIERS_PROPERTY
property.public void setModifiers(TLcdNVGModifiers aValue)
modifiers
attribute.
Modifiers to the specified symbology, possibly including rendering hints.
aValue
- the value to set for the MODIFIERS_PROPERTY
property.public TLcdNVGSymbol getSymbol()
symbol
attribute.
The symbol attribute is used to associate symbology with a given shape. Its format is the name of a standard followed by a colon and the text representation of the element in that standard. That standard can be used to derive the graphical representation of the element.
SYMBOL_PROPERTY
property.public void setSymbol(TLcdNVGSymbol aValue)
symbol
attribute.
The symbol attribute is used to associate symbology with a given shape. Its format is the name of a standard followed by a colon and the text representation of the element in that standard. That standard can be used to derive the graphical representation of the element.
aValue
- the value to set for the SYMBOL_PROPERTY
property.public String getLabel()
label
attribute.
A textual representation of this element.
LABEL_PROPERTY
property.public void setLabel(String aValue)
label
attribute.
A textual representation of this element.
aValue
- the value to set for the LABEL_PROPERTY
property.public TLcdNVGStyle getStyle()
style
attribute.
CSS based style description which indicates how this element should be rendered graphically.
STYLE_PROPERTY
property.public void setStyle(TLcdNVGStyle aValue)
style
attribute.
CSS based style description which indicates how this element should be rendered graphically.
aValue
- the value to set for the STYLE_PROPERTY
property.public URI getUri()
uri
attribute.
URI schema that uniquely identifies the object. See the URI Scheme for more details.
URI_PROPERTY
property.public void setUri(URI aValue)
uri
attribute.
URI schema that uniquely identifies the object. See the URI Scheme for more details.
aValue
- the value to set for the URI_PROPERTY
property.