TLcdKML22Point (LuciadFusion API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.kml22.model.TLcdKML22AbstractObject
  - - com.luciad.format.kml22.model.geometry.TLcdKML22AbstractGeometry
    - - com.luciad.format.kml22.model.geometry.TLcdKML22Point

All Implemented Interfaces:: ILcdDataObject, ILcdBounded, ILcdPoint, ILcdShape, ILcd2DEditablePoint, ILcd2DEditableShape, ILcd3DEditablePoint, ILcd3DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Serializable, Cloneable

public class TLcdKML22Point
extends TLcdKML22AbstractGeometry
implements ILcd3DEditableShape, ILcd3DEditablePoint

Domain class modeling the KML PointType type.

OGC KML Specification description:

 This element can be used wherever the following element is referenced:

  -kml:AbstractGeometryGroup

 A geographic location defined by a single geodetic longitude, geodetic latitude, and
 (optional) altitude coordinate tuple.

Since:: 10.0
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`ABSTRACT_GEOMETRY_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `AbstractGeometryObjectExtensionGroup` element.
`static TLcdDataProperty`	`ABSTRACT_GEOMETRY_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `AbstractGeometrySimpleExtensionGroup` element.
`static TLcdDataProperty`	`ALTITUDE_MODE_PROPERTY` Data property that maps to the `altitudeModeGroup` element.
`static TLcdDataProperty`	`COORDINATES_PROPERTY` Data property that maps to the `coordinates` element.
`static TLcdDataProperty`	`EXTRUDE_PROPERTY` Data property that maps to the `extrude` element.
`static TLcdDataProperty`	`POINT_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `PointObjectExtensionGroup` element.
`static TLcdDataProperty`	`POINT_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `PointSimpleExtensionGroup` element.

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY

Constructor Summary

Constructors
Constructor and Description

TLcdKML22Point(TLcdDataType aType)
Creates a new TLcdKML22Point with a custom TLcdDataType.

Constructors
Constructor and Description
`TLcdKML22Point(TLcdDataType aType)` Creates a new `TLcdKML22Point` with a custom `TLcdDataType`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLcdKML22Point`	`clone()` Returns a deep clone of this object.
`ILcd2DEditablePoint`	`cloneAs2DEditablePoint()` Returns a copy of this `ILcdPoint` that is also an `ILcd2DEditablePoint`.
`ILcd3DEditablePoint`	`cloneAs3DEditablePoint()` Returns a copy of this `ILcdPoint` that is also an `ILcd3DEditablePoint`.
`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.
`ELcdKML22AltitudeMode`	`getAltitudeMode()` Gets the altitude mode of this geometry.
`ILcdBounds`	`getBounds()` Returns the `ILcdBounds` by which the geometry of this `ILcdBounded` object is bounded.
`TLcdKML22Coordinates`	`getCoordinates()` Returns the value of the property that maps to the `coordinates` element.
`double`	`getCosX()` Returns cos( `getX()` * DEG2RAD ).
`double`	`getCosY()` Returns cos( `getY()` * DEG2RAD ).
`Boolean`	`getExtrude()` Returns whether or not this shape should be extruded.
`ILcdPoint`	`getFocusPoint()` Returns the focus point of this `ILcdShape`.
`double`	`getSinX()` Returns sin( `getX()` * DEG2RAD ).
`double`	`getSinY()` Returns sin( `getY()` * DEG2RAD ).
`double`	`getTanX()` Returns tan( `getX()` * DEG2RAD ).
`double`	`getTanY()` Returns tan( `getY()` * DEG2RAD ).
`double`	`getX()` Returns the x coordinate of this `ILcdPoint`.
`double`	`getY()` Returns the y coordinate of this `ILcdPoint`.
`double`	`getZ()` Returns the z coordinate of this `ILcdPoint`.
`boolean`	`isExtruded()`
`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`	`move3D(double aX, double aY, double aZ)` 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`	`setAltitudeMode(ELcdKML22AltitudeMode aValue)` Sets the value of the property that maps to the `altitudeModeGroup` element.
`void`	`setCoordinates(TLcdKML22Coordinates aValue)` Sets the value of the property that maps to the `coordinates` element.
`void`	`setExtrude(Boolean aValue)` Sets the value of the property that maps to the `extrude` element.
`void`	`translate2D(double aDeltaX, double aDeltaY)` Translates this `ILcd2DEditableShape` 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.

Methods inherited from class com.luciad.format.kml22.model.geometry.TLcdKML22AbstractGeometry
clearCache, clone, getCachedObject, insertIntoCache, removeCachedObject

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
getId, getTargetId, setId, setTargetId

Methods inherited from class com.luciad.datamodel.TLcdDataObject
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

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

Methods inherited from interface com.luciad.shape.ILcdPoint
equals

- Field Detail
  - EXTRUDE_PROPERTY
```
public static final TLcdDataProperty EXTRUDE_PROPERTY
```
    Data property that maps to the extrude element. The possible values for this property are instances of Boolean.
  - ALTITUDE_MODE_PROPERTY
```
public static final TLcdDataProperty ALTITUDE_MODE_PROPERTY
```
    Data property that maps to the altitudeModeGroup element. The possible values for this property are instances of ELcdKML22AltitudeMode.
  - COORDINATES_PROPERTY
```
public static final TLcdDataProperty COORDINATES_PROPERTY
```
    Data property that maps to the coordinates element. The possible values for this property are instances of TLcdKML22Coordinates.
  - POINT_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty POINT_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the PointSimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - POINT_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty POINT_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the PointObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
  - ABSTRACT_GEOMETRY_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty ABSTRACT_GEOMETRY_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the AbstractGeometrySimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - ABSTRACT_GEOMETRY_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty ABSTRACT_GEOMETRY_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the AbstractGeometryObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
- Constructor Detail
  - TLcdKML22Point
```
public TLcdKML22Point(TLcdDataType aType)
```
    Creates a new TLcdKML22Point with a custom TLcdDataType.
    
    Parameters:
    
    aType - a custom TLcdDataType
- Method Detail
  - getExtrude
```
public Boolean getExtrude()
```
    Returns whether or not this shape should be extruded. Returns false if it was undefined.
    
    Returns:
    
    true if this shape should be extruded; false otherwise.
  - getAltitudeMode
```
public ELcdKML22AltitudeMode getAltitudeMode()
```
    Gets the altitude mode of this geometry. Returns ELcdKML22AltitudeMode.CLAMP_TO_GROUND if it was undefined. * @return true if this shape should be tessellated; false otherwise.
    
    Returns:
    
    An ELcdKML22AltitudeMode
  - isExtruded
```
public boolean isExtruded()
```
  - getX
```
public double getX()
```
    Description copied from interface: ILcdPoint
    
    Returns the x coordinate of this ILcdPoint.
    
    Specified by:
    
    getX in interface ILcdPoint
    
    Returns:
    
    the x coordinate of this ILcdPoint.
  - getY
```
public double getY()
```
    Description copied from interface: ILcdPoint
    
    Returns the y coordinate of this ILcdPoint.
    
    Specified by:
    
    getY in interface ILcdPoint
    
    Returns:
    
    the y coordinate of this ILcdPoint.
  - getZ
```
public double getZ()
```
    Description copied from interface: ILcdPoint
    
    Returns the z coordinate of this ILcdPoint.
    
    Specified by:
    
    getZ in interface ILcdPoint
    
    Returns:
    
    the z coordinate of this ILcdPoint.
  - getCosX
```
public double getCosX()
```
    Description copied from interface: ILcdPoint
    
    Returns cos( getX() * DEG2RAD ).
    
    Specified by:
    
    getCosX in interface ILcdPoint
    
    Returns:
    
    cos( getX() * DEG2RAD ).
  - getCosY
```
public double getCosY()
```
    Description copied from interface: ILcdPoint
    
    Returns cos( getY() * DEG2RAD ).
    
    Specified by:
    
    getCosY in interface ILcdPoint
    
    Returns:
    
    cos( getY() * DEG2RAD ).
  - getSinX
```
public double getSinX()
```
    Description copied from interface: ILcdPoint
    
    Returns sin( getX() * DEG2RAD ).
    
    Specified by:
    
    getSinX in interface ILcdPoint
    
    Returns:
    
    sin( getX() * DEG2RAD ).
  - getSinY
```
public double getSinY()
```
    Description copied from interface: ILcdPoint
    
    Returns sin( getY() * DEG2RAD ).
    
    Specified by:
    
    getSinY in interface ILcdPoint
    
    Returns:
    
    sin( getY() * DEG2RAD ).
  - getTanX
```
public double getTanX()
```
    Description copied from interface: ILcdPoint
    
    Returns tan( getX() * DEG2RAD ).
    
    Specified by:
    
    getTanX in interface ILcdPoint
    
    Returns:
    
    tan( getX() * DEG2RAD ).
  - getTanY
```
public double getTanY()
```
    Description copied from interface: ILcdPoint
    
    Returns tan( getY() * DEG2RAD ).
    
    Specified by:
    
    getTanY in interface ILcdPoint
    
    Returns:
    
    tan( getY() * DEG2RAD ).
  - cloneAs2DEditablePoint
```
public ILcd2DEditablePoint cloneAs2DEditablePoint()
```
    Description copied from interface: ILcdPoint
    
    Returns a copy of this ILcdPoint that is also an ILcd2DEditablePoint. This makes sure that the first two dimensions of the copy are writable,
    
    Specified by:
    
    cloneAs2DEditablePoint in interface ILcdPoint
    
    Returns:
    
    a copy of this ILcdPoint that is also an ILcd2DEditablePoint. This makes sure that the first two dimensions of the copy are writable, even if the original ILcdPoint object may be read-only.
    
    See Also:
    
    ILcd2DEditablePoint
  - cloneAs3DEditablePoint
```
public ILcd3DEditablePoint cloneAs3DEditablePoint()
```
    Description copied from interface: ILcdPoint
    
    Returns a copy of this ILcdPoint that is also an ILcd3DEditablePoint. This makes sure that all three dimensions of the copy are writable,
    
    Specified by:
    
    cloneAs3DEditablePoint in interface ILcdPoint
    
    Returns:
    
    a copy of this ILcdPoint that is also an ILcd3DEditablePoint. This makes sure that all three dimensions of the copy are writable, even if the original ILcdPoint object may be read-only.
    
    See Also:
    
    ILcd3DEditablePoint
  - 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
    
    Overrides:
    
    move3D in class TLcdKML22AbstractGeometry
    
    Parameters:
    
    aPoint - the ILcdPoint to move to.
    
    See Also:
    
    ILcd3DEditableShape.move3D(double, double, double)
  - move3D
```
public void move3D(double aX,
                   double aY,
                   double aZ)
```
    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
    
    Overrides:
    
    move3D in class TLcdKML22AbstractGeometry
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
  - 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 ILcd3DEditableShape
    
    Overrides:
    
    translate3D in class TLcdKML22AbstractGeometry
    
    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(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
    
    Overrides:
    
    move2D in class TLcdKML22AbstractGeometry
    
    Parameters:
    
    aPoint - the ILcdPoint to move to.
    
    See Also:
    
    ILcd2DEditableShape.move2D(double, double)
  - move2D
```
public void move2D(double aX,
                   double aY)
```
    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
    
    Overrides:
    
    move2D in class TLcdKML22AbstractGeometry
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - 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 ILcd2DEditableShape
    
    Overrides:
    
    translate2D in class TLcdKML22AbstractGeometry
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - getFocusPoint
```
public ILcdPoint getFocusPoint()
```
    Description copied from interface: ILcdShape
    
    Returns the focus point of this ILcdShape.
    
    Specified by:
    
    getFocusPoint in interface ILcdShape
    
    Overrides:
    
    getFocusPoint in class TLcdKML22AbstractGeometry
    
    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
    
    Overrides:
    
    contains2D in class TLcdKML22AbstractGeometry
    
    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
    
    Overrides:
    
    contains2D in class TLcdKML22AbstractGeometry
    
    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
    
    Overrides:
    
    contains3D in class TLcdKML22AbstractGeometry
    
    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
    
    Overrides:
    
    contains3D in class TLcdKML22AbstractGeometry
    
    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.
  - clone
```
public TLcdKML22Point clone()
```
    Description copied from class: TLcdDataObject
    
    Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).
    
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class TLcdDataObject
    
    Returns:
    
    a deep clone of this object
    
    See Also:
    
    Object.clone()
  - 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
    
    Overrides:
    
    getBounds in class TLcdKML22AbstractGeometry
    
    Returns:
    
    the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
  - setExtrude
```
public void setExtrude(Boolean aValue)
```
    Sets the value of the property that maps to the extrude element.
    
    Parameters:
    
    aValue - the value to set for the EXTRUDE_PROPERTY property.
  - setAltitudeMode
```
public void setAltitudeMode(ELcdKML22AltitudeMode aValue)
```
    Sets the value of the property that maps to the altitudeModeGroup element.
    
    Parameters:
    
    aValue - the value to set for the ALTITUDE_MODE_PROPERTY property.
  - getCoordinates
```
public TLcdKML22Coordinates getCoordinates()
```
    Returns the value of the property that maps to the coordinates element.
    
    Returns:
    
    the value of the COORDINATES_PROPERTY property.
  - setCoordinates
```
public void setCoordinates(TLcdKML22Coordinates aValue)
```
    Sets the value of the property that maps to the coordinates element.
    
    Parameters:
    
    aValue - the value to set for the COORDINATES_PROPERTY property.

LuciadFusionClass TLcdKML22Point

Field Summary

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

Constructor Summary

Method Summary

Methods inherited from class com.luciad.format.kml22.model.geometry.TLcdKML22AbstractGeometry

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdPoint

Field Detail

EXTRUDE_PROPERTY

ALTITUDE_MODE_PROPERTY

COORDINATES_PROPERTY

POINT_SIMPLE_EXTENSION_GROUP_PROPERTY

POINT_OBJECT_EXTENSION_GROUP_PROPERTY

ABSTRACT_GEOMETRY_SIMPLE_EXTENSION_GROUP_PROPERTY

ABSTRACT_GEOMETRY_OBJECT_EXTENSION_GROUP_PROPERTY

Constructor Detail

TLcdKML22Point

Method Detail

getExtrude

getAltitudeMode

isExtruded

getX

getY

getZ

getCosX

getCosY

getSinX

getSinY

getTanX

getTanY

cloneAs2DEditablePoint

cloneAs3DEditablePoint

move3D

move3D

translate3D

move2D

move2D

translate2D

getFocusPoint

contains2D

contains2D

contains3D

contains3D

clone

getBounds

setExtrude

setAltitudeMode

getCoordinates

setCoordinates