ALcd3DEditablePolypoint (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.shape.ALcdShape
- - com.luciad.shape.shape2D.ALcd2DEditableShape
  - - com.luciad.shape.shape3D.ALcd3DEditableShape
    - - com.luciad.shape.shape3D.ALcd3DEditablePolypoint

All Implemented Interfaces:

ILcdBounded, ILcdPointList, ~~ILcdPointList2~~ , ILcdPolypoint, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolypoint, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolypoint, ILcd3DEditableShape, ILcdCache, ILcdCloneable, Serializable, Cloneable

Direct Known Subclasses:

TLcdLonLatHeightPolypoint, TLcdXYZPolypoint
```
public abstract class ALcd3DEditablePolypoint
extends ALcd3DEditableShape
implements ILcd3DEditablePolypoint, ILcdPointList, 
ILcdPointList2
, ILcdCache, Cloneable
```
This abstract class provides a basis for implementing the ILcd3DEditablePolypoint interface.
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 by moving, translating, inserting or removing points.
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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ALcd3DEditablePolypoint()` Creates a new, empty polypoint.
`ALcd3DEditablePolypoint(ALcd3DEditablePolypoint a3DEditablePolypoint)` Copy constructor.
`ALcd3DEditablePolypoint(ILcd3DEditablePointList a2DEditablePointList)` Creates a new polypoint backed by the given point list.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract ILcd3DEditableBounds`	`calculateBounds()` This method should compute the bounds of the polypoint.
`protected ILcd3DEditablePoint`	`calculateFocusPoint()` Computes the focus point as the center of the bounding box.
`void`	`clearCache()` Clears the cache.
`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`contains2D(double aX, double aY)` Checks whether this `ILcdShape` contains the given point in the 2D space.
`boolean`	`contains3D(double aX, double aY, double aZ)` Provides an approximate default implementation of the 3D containment test based on the 2D containment test.
`boolean`	`equals(Object aObject)` Returns whether the given object has the same class, the same focus point, and the same coordinates.
`protected ILcd3DEditablePointList`	`get3DEditablePointList()`
`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`	`getFocusPoint()` Returns the focus point of this `ILcdShape`.
`ILcdPoint`	`getPoint(int aIndex)` Returns the `ILcdPoint` at a given index.
`int`	`getPointCount()` Returns the number of `ILcdPoint` objects in the list.
`void`	`getPointSFCT(int aIndex, ILcd3DEditablePoint aPointSFCT)` Stores the coordinates of the point at `aIndex` in the given point.
`double`	`getX(int aIndex)` Returns the X coordinate of the point at `aIndex`.
`double`	`getY(int aIndex)` Returns the Y coordinate of the point at `aIndex`.
`double`	`getZ(int aIndex)` Returns the Z coordinate of the point at `aIndex`.
`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`	`insert2DPoint(int aIndex, double aX, double aY)` Inserts a point at the given index into this `ILcd2DEditablePointList`.
`void`	`insert3DPoint(int aIndex, double aX, double aY, double aZ)` Inserts a point at the given index into this `ILcd3DEditablePointList`.
`void`	`insertIntoCache(Object aKey, Object aObject)` Inserts a cache Object corresponding to the given key Object.
`protected void`	`invalidateBounds()`
`void`	`move2D(double aX, double aY)` Translates this shape so that its focus point ends up at the specified position.
`void`	`move2DPoint(int aIndex, double aX, double aY)` Moves the specified point of this `ILcd2DEditablePointList` to the given point in the 2D space.
`void`	`move3DPoint(int aIndex, double aX, double aY, double aZ)` Moves the specified point of this `ILcd3DEditablePointList` to the given point in the 3D 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`.
`protected void`	`set3DEditablePointList(ILcd3DEditablePointList a3DEditablePointList)`
`protected void`	`set3DEditablePointList(ILcd3DEditablePointList a3DEditablePointList, boolean aDeepCopy)`
`protected void`	`setFocusPoint(ILcd3DEditablePoint aFocusPoint)`
`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`	`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.
`void`	`translate3D(double aDeltaX, double aDeltaY, double aDeltaZ)` Translates this `ILcd3DEditableShape` from its current position over the given translation vector in the 3D space.
`void`	`translate3DPoint(int aIndex, double aDeltaX, double aDeltaY, double aDeltaZ)` Translates the specified point of this `ILcd3DEditablePointList` from its current position over the given translation vector in the 3D space.

Methods inherited from class com.luciad.shape.shape3D.ALcd3DEditableShape
move3D, move3D

Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditableShape
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.shape3D.ILcd3DEditableShape
move3D, move3D

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

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

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

- Constructor Detail
  - ALcd3DEditablePolypoint
```
public ALcd3DEditablePolypoint()
```
    Creates a new, empty polypoint.
  - ALcd3DEditablePolypoint
```
public ALcd3DEditablePolypoint(ILcd3DEditablePointList a2DEditablePointList)
```
    Creates a new polypoint backed by the given point list. The given pointlist is re-used by the new pointlist, and updates will affect both objects.
    
    Parameters:
    
    a2DEditablePointList - The point list to use
  - ALcd3DEditablePolypoint
```
public ALcd3DEditablePolypoint(ALcd3DEditablePolypoint a3DEditablePolypoint)
```
    Copy constructor.
    
    Parameters:
    
    a3DEditablePolypoint - The ALcd3DEditablePolypoint to copy.
- Method Detail
  - get3DEditablePointList
```
protected final ILcd3DEditablePointList get3DEditablePointList()
```
  - set3DEditablePointList
```
protected void set3DEditablePointList(ILcd3DEditablePointList a3DEditablePointList)
```
  - set3DEditablePointList
```
protected void set3DEditablePointList(ILcd3DEditablePointList a3DEditablePointList,
                                      boolean aDeepCopy)
```
  - getPointSFCT
```
public void getPointSFCT(int aIndex,
                         ILcd3DEditablePoint aPointSFCT)
```
    Description copied from interface: ILcdPointList
    
    Stores the coordinates of the point at aIndex in the given point.
    
    Specified by:
    
    getPointSFCT in interface ILcdPointList
    
    Parameters:
    
    aIndex - the index of the point for which to retrieve the coordinates.
    
    aPointSFCT - the side-effect parameter in which to store the coordinates of the requested point.
  - getX
```
public double getX(int aIndex)
```
    Description copied from interface: ILcdPointList
    
    Returns the X coordinate of the point at aIndex.
    
    Specified by:
    
    getX in interface ILcdPointList
    
    Parameters:
    
    aIndex - the index of the point for which to return the X coordinate.
    
    Returns:
    
    the X coordinate of the point at aIndex.
  - getY
```
public double getY(int aIndex)
```
    Description copied from interface: ILcdPointList
    
    Returns the Y coordinate of the point at aIndex.
    
    Specified by:
    
    getY in interface ILcdPointList
    
    Parameters:
    
    aIndex - the index of the point for which to return the Y coordinate.
    
    Returns:
    
    the Y coordinate of the point at aIndex.
  - getZ
```
public double getZ(int aIndex)
```
    Description copied from interface: ILcdPointList
    
    Returns the Z coordinate of the point at aIndex.
    
    Specified by:
    
    getZ in interface ILcdPointList
    
    Parameters:
    
    aIndex - the index of the point for which to return the Z coordinate.
    
    Returns:
    
    the Z coordinate of the point at aIndex.
  - getPointCount
```
public final 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 final ILcdPoint getPoint(int aIndex)
```
    Description copied from interface: ILcdPointList
    
    Returns the ILcdPoint at a given index.
    
    Specified by:
    
    getPoint in interface ILcdPointList
    
    Parameters:
    
    aIndex - a valid index in the list of ILcdPoint objects.
    
    Returns:
    
    the ILcdPoint at the given index.
  - move2DPoint
```
public void move2DPoint(int aIndex,
                        double aX,
                        double aY)
```
    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:
    
    aIndex - a valid index in the list of points.
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - move3DPoint
```
public void move3DPoint(int aIndex,
                        double aX,
                        double aY,
                        double aZ)
```
    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:
    
    aIndex - a valid index in the list of points.
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
  - translate2DPoint
```
public void translate2DPoint(int aIndex,
                             double aDeltaX,
                             double aDeltaY)
```
    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
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - translate3DPoint
```
public void translate3DPoint(int aIndex,
                             double aDeltaX,
                             double aDeltaY,
                             double aDeltaZ)
```
    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:
    
    aIndex - a valid new index in the list of points.
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
    
    aDeltaZ - the z coordinate of the translation vector.
  - insert2DPoint
```
public void insert2DPoint(int aIndex,
                          double aX,
                          double aY)
```
    Description copied from interface: ILcd2DEditablePointList
    
    Inserts a point at the given index into this ILcd2DEditablePointList.
    
    Specified by:
    
    insert2DPoint in interface ILcd2DEditablePointList
    
    Parameters:
    
    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.
  - insert3DPoint
```
public void insert3DPoint(int aIndex,
                          double aX,
                          double aY,
                          double aZ)
```
    Description copied from interface: ILcd3DEditablePointList
    
    Inserts a point at the given index into this ILcd3DEditablePointList.
    
    Specified by:
    
    insert3DPoint in interface ILcd3DEditablePointList
    
    Parameters:
    
    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.
    
    aZ - the z coordinate of the new point.
  - removePointAt
```
public void removePointAt(int aIndex)
```
    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:
    
    aIndex - a valid index in the list of ILcdPoint objects.
  - invalidateBounds
```
protected void invalidateBounds()
```
  - calculateBounds
```
protected abstract ILcd3DEditableBounds calculateBounds()
```
    This method should compute the bounds of the polypoint. The resulting ILcd2DEditableBounds should be stored in fBounds.
  - 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.
  - calculateFocusPoint
```
protected ILcd3DEditablePoint calculateFocusPoint()
```
    Computes the focus point as the center of the bounding box. The resulting ILcd2DEditablePoint is stored in fFocusPoint.
  - 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.
  - setFocusPoint
```
protected void setFocusPoint(ILcd3DEditablePoint aFocusPoint)
```
  - 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.
  - contains3D
```
public boolean contains3D(double aX,
                          double aY,
                          double aZ)
```
    Description copied from class: ALcd2DEditableShape
    
    Provides an approximate default implementation of the 3D containment test based on the 2D containment test.
    
    Specified by:
    
    contains3D in interface ILcdShape
    
    Overrides:
    
    contains3D in class ALcd2DEditableShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
    
    Returns:
    
    true if the bounds of this shape contain the point in the 3D space and the shape itself contains the point in the 2D space, false otherwise.
  - 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 ILcd2DEditablePointList
    
    Specified by:
    
    translate2D in interface ILcd2DEditableShape
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - translate3D
```
public void translate3D(double aDeltaX,
                        double aDeltaY,
                        double aDeltaZ)
```
    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:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
    
    aDeltaZ - the z coordinate of the translation vector.
  - move2D
```
public void move2D(double aX,
                   double aY)
```
    Description copied from class: ALcd2DEditableShape
    
    Translates this shape so that its focus point ends up at the specified position.
    
    Specified by:
    
    move2D in interface ILcd2DEditableShape
    
    Overrides:
    
    move2D in class ALcd2DEditableShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - 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()
```
    Creates and returns a copy of this object.
    The contained editable points list is copied without being cloned.
    The cache, the bounds and the focus point are not copied or cloned at all, but recalculated when needed.
    
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class ALcdShape
    
    See Also:
    
    Object.clone()
  - equals
```
public boolean equals(Object aObject)
```
    Returns whether the given object has the same class, the same focus point, and the same coordinates.
    
    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

LuciadLightspeedClass ALcd3DEditablePolypoint

Constructor Summary

Method Summary

Methods inherited from class com.luciad.shape.shape3D.ALcd3DEditableShape

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.shape3D.ILcd3DEditableShape

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

Methods inherited from interface com.luciad.shape.ILcdShape

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

Constructor Detail

ALcd3DEditablePolypoint

ALcd3DEditablePolypoint

ALcd3DEditablePolypoint

Method Detail

get3DEditablePointList

set3DEditablePointList

set3DEditablePointList

getPointSFCT

getX

getY

getZ

getPointCount

getPoint

move2DPoint

move3DPoint

translate2DPoint

translate3DPoint

insert2DPoint

insert3DPoint

removePointAt

invalidateBounds

calculateBounds

getBounds

calculateFocusPoint

getFocusPoint

setFocusPoint

contains2D

contains3D

translate2D

translate3D

move2D

insertIntoCache

getCachedObject

removeCachedObject

clearCache

clone

equals

hashCode

toString