com.luciad.ais.shape

Aviation StandardsClass TLcdAISPolyline

java.lang.Object

com.luciad.ais.shape.TLcdAISPolyline

All Implemented Interfaces:

ILcdBounded, ILcdPointList, ILcdPolyline, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolyline, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolyline, ILcd3DEditableShape, ILcdCache, ILcdCloneable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

TLcdGeoborder, TLcdRefuelingTrack, TLcdRunway, TLcdVFRRoute

public class TLcdAISPolyline
extends java.lang.Object
implements ILcd3DEditablePolyline, ILcdCache

A polyline that delegates to an internal polyline. This allows varying the concrete class of the internal polyline. The typical use is to set either a TLcdLonLatHeightPolyline or a TLcdXYZPolyline as delegate. As such, any class inheriting from TLcdAISPolyline can accommodate both geodetic or cartesian polylines.

It is required that all instances used as a delegate implement ILcdCache.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdAISPolyline() The default constructor does not set the polyline to delegate to.
TLcdAISPolyline(ILcd3DEditablePolyline aPolyline) Constructs a polyline that delegates to aPolyline
TLcdAISPolyline(TLcdAISPolyline aAISPolyline) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the cache.
java.lang.Object	clone() Makes Object.clone() public.
boolean	contains2D(double v, double v1) 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 v, double v1, double v2) 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.
boolean	equals(java.lang.Object aObject)
ILcdBounds	getBounds() Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
java.lang.Object	getCachedObject(java.lang.Object o) Looks up and returns the cached Object corresponding to the given key.
ILcdPoint	getFocusPoint() Returns the focus point of this ILcdShape.
ILcdPoint	getPoint(int i) Returns the ILcdPoint at a given index.
int	getPointCount() Returns the number of ILcdPoint objects in the list.
int	hashCode()
void	insert2DPoint(int i, double v, double v1) Inserts a point at the given index into this ILcd2DEditablePointList.
void	insert3DPoint(int i, double v, double v1, double v2) Inserts a point at the given index into this ILcd3DEditablePointList.
void	insertIntoCache(java.lang.Object o, java.lang.Object o1) Inserts a cache Object corresponding to the given key Object.
void	move2D(double v, double v1) 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 i, double v, double v1) Moves the specified point of this ILcd2DEditablePointList to the given point in the 2D space.
void	move3D(double v, double v1, double v2) Moves this ILcd3DEditableShape to the given point in the 3D space.
void	move3D(ILcdPoint aPoint) Moves this ILcd3DEditableShape to the given point in the 3D space.
void	move3DPoint(int i, double v, double v1, double v2) Moves the specified point of this ILcd3DEditablePointList to the given point in the 3D space.
java.lang.Object	removeCachedObject(java.lang.Object o) Looks up and removes the cached Object corresponding to the given key.
void	removePointAt(int i) Removes the point at the given index from this ILcd2DEditablePointList.
void	set3DEditablePolyline(ILcd3DEditablePolyline aDelegatePolyline) Sets the delegate polyline.
void	translate2D(double v, double v1) Translates this ILcd2DEditableShape from its current position over the given translation vector in the 2D space.
void	translate2DPoint(int i, double v, double v1) Translates the specified point of this ILcd2DEditablePointList from its current position over the given translation vector in the 2D space.
void	translate3D(double v, double v1, double v2) Translates this ILcd3DEditableShape from its current position over the given translation vector in the 3D space.
void	translate3DPoint(int i, double v, double v1, double v2) Translates the specified point of this ILcd3DEditablePointList from its current position over the given translation vector in the 3D space.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

append2DPoint

Methods inherited from interface com.luciad.shape.ILcdPointList

getPointSFCT, getX, getY, getZ

Constructor Detail

TLcdAISPolyline

public TLcdAISPolyline()

The default constructor does not set the polyline to delegate to. It is required to call 'set3DEditablePolyline' before any of the ILcd3DEditablePolyline or ILcdCache methods are called.

TLcdAISPolyline

public TLcdAISPolyline(ILcd3DEditablePolyline aPolyline)

Constructs a polyline that delegates to aPolyline

TLcdAISPolyline

public TLcdAISPolyline(TLcdAISPolyline aAISPolyline)

Copy constructor. Takes a clone of the delegate polyline in aAISPolyline.

Parameters:

aAISPolyline -

Method Detail

set3DEditablePolyline

public void set3DEditablePolyline(ILcd3DEditablePolyline aDelegatePolyline)

Sets the delegate polyline.

Parameters:

aDelegatePolyline - must be an instance of ILcdCache

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(ILcdPoint aPoint)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.

Specified by:

contains2D in interface ILcdShape

Parameters:

aPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

ILcdShape.contains2D(double, double)

contains2D

public boolean contains2D(double v,
                          double v1)

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:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

Returns:

the boolean result of the containment test.

contains3D

public boolean contains3D(ILcdPoint aPoint)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.

Specified by:

contains3D in interface ILcdShape

Parameters:

aPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

ILcdShape.contains3D(double, double, double)

contains3D

public boolean contains3D(double v,
                          double v1,
                          double v2)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given point in the 3D space.

Specified by:

contains3D in interface ILcdShape

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z 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.

getPointCount

public int getPointCount()

Description copied from interface: ILcdPointList

Returns the number of ILcdPoint objects in the list.

Specified by:

getPointCount in interface ILcdPointList

Returns:

the number of ILcdPoint objects in the list.

getPoint

public ILcdPoint getPoint(int i)
                   throws java.lang.IndexOutOfBoundsException

Description copied from interface: ILcdPointList

Returns the ILcdPoint at a given index.

Specified by:

getPoint in interface ILcdPointList

Parameters:

i - a valid index in the list of ILcdPoint objects.

Returns:

the ILcdPoint at the given index.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is out of bounds.

move2D

public void move2D(ILcdPoint aPoint)

Description copied from interface: ILcd2DEditableShape

Moves this 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.

Specified by:

move2D in interface ILcd2DEditableShape

Parameters:

aPoint - the ILcdPoint to move to.

See Also:

ILcd2DEditableShape.move2D(double, double)

move2D

public void move2D(double v,
                   double v1)

Description copied from interface: ILcd2DEditableShape

Moves this 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.

Specified by:

move2D in interface ILcd2DEditableShape

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

translate2D

public void translate2D(double v,
                        double v1)

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 ILcd2DEditablePointList

Specified by:

translate2D in interface ILcd2DEditableShape

Parameters:

v - the x coordinate of the translation vector.

v1 - the y coordinate of the translation vector.

move2DPoint

public void move2DPoint(int i,
                        double v,
                        double v1)

Description copied from interface: ILcd2DEditablePointList

Moves the specified point of this 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.

Specified by:

move2DPoint in interface ILcd2DEditablePointList

Parameters:

i - a valid index in the list of points.

v - the x coordinate of the point.

v1 - the y coordinate of the point.

translate2DPoint

public void translate2DPoint(int i,
                             double v,
                             double v1)

Description copied from interface: ILcd2DEditablePointList

Translates the specified point of this 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.

Specified by:

translate2DPoint in interface ILcd2DEditablePointList

v - the x coordinate of the translation vector.

v1 - the y coordinate of the translation vector.

insert2DPoint

public void insert2DPoint(int i,
                          double v,
                          double v1)

Description copied from interface: ILcd2DEditablePointList

Inserts a point at the given index into this ILcd2DEditablePointList.

Specified by:

insert2DPoint in interface ILcd2DEditablePointList

Parameters:

i - a valid new index in the list of points.

v - the x coordinate of the new point.

v1 - the y coordinate of the new point.

removePointAt

public void removePointAt(int i)

Description copied from interface: ILcd2DEditablePointList

Removes the point at the given index from this ILcd2DEditablePointList.

Specified by:

removePointAt in interface ILcd2DEditablePointList

Specified by:

removePointAt in interface ILcd3DEditablePointList

Parameters:

i - a valid index in the list of ILcdPoint objects.

move3D

public void move3D(ILcdPoint aPoint)

Description copied from interface: ILcd3DEditableShape

Moves this ILcd3DEditableShape to the given point in the 3D space. The focus point is used as the handle by which the shape is moved.

Specified by:

move3D in interface ILcd3DEditableShape

Parameters:

aPoint - the ILcdPoint to move to.

See Also:

ILcd3DEditableShape.move3D(double, double, double)

move3D

public void move3D(double v,
                   double v1,
                   double v2)

Description copied from interface: ILcd3DEditableShape

Moves this ILcd3DEditableShape to the given point in the 3D space. The focus point is used as the handle by which the shape is moved.

Specified by:

move3D in interface ILcd3DEditableShape

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z coordinate of the point.

translate3D

public void translate3D(double v,
                        double v1,
                        double v2)

Description copied from interface: ILcd3DEditableShape

Translates this ILcd3DEditableShape from its current position over the given translation vector in the 3D space.

Specified by:

translate3D in interface ILcd3DEditablePointList

Specified by:

translate3D in interface ILcd3DEditableShape

Parameters:

v - the x coordinate of the translation vector.

v1 - the y coordinate of the translation vector.

v2 - the z coordinate of the translation vector.

move3DPoint

public void move3DPoint(int i,
                        double v,
                        double v1,
                        double v2)

Description copied from interface: ILcd3DEditablePointList

Moves the specified point of this ILcd3DEditablePointList to the given point in the 3D space.

Specified by:

move3DPoint in interface ILcd3DEditablePointList

Parameters:

i - a valid index in the list of points.

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z coordinate of the point.

translate3DPoint

public void translate3DPoint(int i,
                             double v,
                             double v1,
                             double v2)

Description copied from interface: ILcd3DEditablePointList

Translates the specified point of this ILcd3DEditablePointList from its current position over the given translation vector in the 3D space.

Specified by:

translate3DPoint in interface ILcd3DEditablePointList

Parameters:

i - a valid new index in the list of points.

v - the x coordinate of the translation vector.

v1 - the y coordinate of the translation vector.

v2 - the z coordinate of the translation vector.

insert3DPoint

public void insert3DPoint(int i,
                          double v,
                          double v1,
                          double v2)

Description copied from interface: ILcd3DEditablePointList

Inserts a point at the given index into this ILcd3DEditablePointList.

Specified by:

insert3DPoint in interface ILcd3DEditablePointList

Parameters:

i - a valid new index in the list of points.

v - the x coordinate of the new point.

v1 - the y coordinate of the new point.

v2 - the z coordinate of the new point.

insertIntoCache

public void insertIntoCache(java.lang.Object o,
                            java.lang.Object o1)

Description copied from interface: ILcdCache

Inserts a cache Object corresponding to the given key Object.

Specified by:

insertIntoCache in interface ILcdCache

Parameters:

o - 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, ...).

o1 - the Object to be cached.

getCachedObject

public java.lang.Object getCachedObject(java.lang.Object o)

Description copied from interface: ILcdCache

Looks up and returns the cached Object corresponding to the given key.

Specified by:

getCachedObject in interface ILcdCache

Parameters:

o - 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 java.lang.Object removeCachedObject(java.lang.Object o)

Description copied from interface: ILcdCache

Looks up and removes the cached Object corresponding to the given key.

Specified by:

removeCachedObject in interface ILcdCache

Parameters:

o - 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 java.lang.Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

equals

public boolean equals(java.lang.Object aObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object