TLcdSHPPolygonZ (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.format.shp.TLcdSHPPolygonZ

All Implemented Interfaces:

ILcdBounded, ILcdCurve, ILcdPointList, ILcdPolygon, ILcdRing, ILcdShape, ILcdCache, ILcdCloneable, Serializable, Cloneable
```
public class TLcdSHPPolygonZ
extends Object
implements ILcdPolygon, ILcdCache, ILcdRing
```
A TLcdSHPPolygonZ is a ILcdPolygon with a measure value at each of the defining points.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.luciad.shape.ILcdPolygon
  CLOCKWISE, COUNTERCLOCKWISE, INVALID_ORIENTATION
- 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

Constructor Summary

Constructors
Constructor and Description
`TLcdSHPPolygonZ(ILcdPolygon aPolygon)` Constructs a `TLcdSHPPolygonZ` from the given polygon having measure values `0`.
`TLcdSHPPolygonZ(ILcdPolygon aPolygon, double[] aMValues)` Constructs a `TLcdSHPPolygonZ` from the given polygon and the measure values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clears the cache.
`Object`	`clone()` Makes `Object.clone()` public.
`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.
`boolean`	`equals(Object o)`
`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.
`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`	`getM(int aIndex)` Returns the measure value at an index.
`int`	`getOrientation()` Returns the orientation of this `ILcdPolygon`: `ILcdPolygon.CLOCKWISE` or `ILcdPolygon.COUNTERCLOCKWISE`.
`ILcdPoint`	`getPoint(int aIndex)` Returns the `ILcdPoint` at a given index.
`int`	`getPointCount()` Returns the number of `ILcdPoint` objects in the list.
`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.
`Object`	`getValue(TLcdDataProperty aProperty)`
`int`	`hashCode()`
`void`	`insertIntoCache(Object aKey, Object aObject)` Inserts a cache Object corresponding to the given key Object.
`Object`	`removeCachedObject(Object aKey)` Looks up and removes the cached Object corresponding to the given key.
`void`	`setM(int aIndex, double aMValue)` Sets the measure value for one of the defining polygon points.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.shape.ILcdPointList
getPointSFCT, getX, getY, getZ

- Constructor Detail
  - TLcdSHPPolygonZ
```
public TLcdSHPPolygonZ(ILcdPolygon aPolygon)
```
    Constructs a TLcdSHPPolygonZ from the given polygon having measure values 0.
    
    Parameters:
    
    aPolygon - the polygon.
  - TLcdSHPPolygonZ
```
public TLcdSHPPolygonZ(ILcdPolygon aPolygon,
                       double[] aMValues)
```
    Constructs a TLcdSHPPolygonZ from the given polygon and the measure values.
    
    Parameters:
    
    aPolygon - the polygon.
    
    aMValues - the measure value. The length of the array should be the same as the number of defining polygon points.
- Method Detail
  - getM
```
public double getM(int aIndex)
```
    Description copied from interface: ILcdSHPMeasureList
    
    Returns the measure value at an index.
    
    Parameters:
    
    aIndex - the index of the measure value.
    
    Returns:
    
    the measure value at an index.
  - setM
```
public void setM(int aIndex,
                 double aMValue)
```
    Sets the measure value for one of the defining polygon points.
    
    Parameters:
    
    aIndex - the index of the point/measure value.
    
    aMValue - the measure value.
    
    See Also:
    
    getM(int)
  - clone
```
public 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 Object
    
    See Also:
    
    Object.clone()
  - 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 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(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 aX,
                          double aY,
                          double aZ)
```
    Description copied from interface: ILcdShape
    
    Checks whether this ILcdShape contains the given point in the 3D space.
    
    Specified by:
    
    contains3D in interface ILcdShape
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
    
    Returns:
    
    the boolean result of the containment test.
  - 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 aIndex)
                   throws IndexOutOfBoundsException
```
    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.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
  - 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.
  - getOrientation
```
public int getOrientation()
```
    Description copied from interface: ILcdPolygon
    
    Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.
    
    Specified by:
    
    getOrientation in interface ILcdPolygon
    
    Returns:
    
    the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE. This method should not return INVALID_ORIENTATION, which is only to be used for resetting the orientation so that it can be recalculated.
  - 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
  - getValue
```
public Object getValue(TLcdDataProperty aProperty)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getStartPoint
```
public ILcdPoint getStartPoint()
```
    Description copied from interface: ILcdCurve
    
    Retrieves the start point of the curve.
    This is equivalent to computePointSFCT(0).
    
    Specified by:
    
    getStartPoint in interface ILcdCurve
    
    Returns:
    
    the start point of the curve
  - getEndPoint
```
public ILcdPoint getEndPoint()
```
    Description copied from interface: ILcdCurve
    
    Retrieves the end point of the curve.
    This is equivalent to computePointSFCT(1).
    
    Specified by:
    
    getEndPoint in interface ILcdCurve
    
    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 interface ILcdCurve
    
    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 interface ILcdCurve
    
    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 interface ILcdCurve
    
    Parameters:
    
    aParam - a value of the closed interval [0,1]
    
    Returns:
    
    the curve's angle in the point defined by the given parameter
  - 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 interface ILcdCurve
    
    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.
  - computePointSFCT
```
public void computePointSFCT(double aParam,
                             ILcd3DEditablePoint aPointSFCT)
```
    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 interface ILcdCurve
    
    Parameters:
    
    aParam - a value of the closed interval [0,1]
    
    aPointSFCT - the point to store the computed curve point in
  - getInterpolation
```
public String 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 interface ILcdCurve
    
    Returns:
    
    the interpolation method used by this curve.
  - getLineSegmentIntersectionCount
```
public int getLineSegmentIntersectionCount(ILcdPoint aP1,
                                           ILcdPoint aP2)
```
    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 interface ILcdCurve
    
    Parameters:
    
    aP1 - the first point of the line segment
    
    aP2 - the second point of the line segment
    
    Returns:
    
    the number of intersections between the curve and the line segment

LuciadLightspeedClass TLcdSHPPolygonZ

Field Summary

Fields inherited from interface com.luciad.shape.ILcdPolygon

Fields inherited from interface com.luciad.shape.ILcdCurve

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdPointList

Constructor Detail

TLcdSHPPolygonZ

TLcdSHPPolygonZ

Method Detail

getM

setM

clone

getFocusPoint

contains2D

contains2D

contains3D

contains3D

getPointCount

getPoint

getBounds

getOrientation

insertIntoCache

getCachedObject

removeCachedObject

clearCache

getValue

equals

hashCode

getStartPoint

getEndPoint

getStartTangent2D

getEndTangent2D

getTangent2D

getLength2D

computePointSFCT

getInterpolation

getLineSegmentIntersectionCount