public class TLcdKML22LatLonAltBox extends TLcdKML22AbstractLatLonBox implements ILcdBounds, ILcdExtrudedShape
OGC KML Specification description:
This element can be used wherever the following element is referenced: -kml:AbstractObjectGroup NOTE: The schema type for kml:LatLonAltBox derives by extension from the schema type for kml:AbstractLatLonAltBoxGroup, even though it does not substitute for it. Specifies the extent of a 3D bounding box, such that: - kml:north is greater than kml:south; - kml:east is greater than kml:west; - kml:minAltitude is less than or equal to kml:maxAltitude; - if kml:minAltitude and kml:maxAltitude are both present, kml:altitudeMode shall not have a value of clampToGround.
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
ABSTRACT_LAT_LON_BOX_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractLatLonBoxObjectExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_LAT_LON_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractLatLonBoxSimpleExtensionGroup element. |
static TLcdDataProperty |
ALTITUDE_MODE_PROPERTY
Data property that maps to the
altitudeModeGroup element. |
static TLcdDataProperty |
EAST_PROPERTY
Data property that maps to the
east element. |
static TLcdDataProperty |
LAT_LON_ALT_BOX_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
LatLonAltBoxObjectExtensionGroup element. |
static TLcdDataProperty |
LAT_LON_ALT_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
LatLonAltBoxSimpleExtensionGroup element. |
static TLcdDataProperty |
MAX_ALTITUDE_PROPERTY
Data property that maps to the
maxAltitude element. |
static TLcdDataProperty |
MIN_ALTITUDE_PROPERTY
Data property that maps to the
minAltitude element. |
static TLcdDataProperty |
NORTH_PROPERTY
Data property that maps to the
north element. |
static TLcdDataProperty |
SOUTH_PROPERTY
Data property that maps to the
south element. |
static TLcdDataProperty |
WEST_PROPERTY
Data property that maps to the
west element. |
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY
Constructor and Description |
---|
TLcdKML22LatLonAltBox(TLcdDataType aType)
Creates a new
TLcdKML22LatLonAltBox with a custom TLcdDataType . |
Modifier and Type | Method and Description |
---|---|
TLcdKML22LatLonAltBox |
clone()
Returns a deep clone of this object.
|
TLcdDataObject |
clone(Map aObjectDictionary)
Returns a deep clone of this object.
|
ILcd2DEditableBounds |
cloneAs2DEditableBounds()
Returns a copy of this
ILcdBounds object that is also an ILcd2DEditableBounds . |
ILcd3DEditableBounds |
cloneAs3DEditableBounds()
Returns a copy of this
ILcdBounds object that is also an ILcd3DEditableBounds . |
boolean |
contains2D(double aX,
double aY)
Checks whether this
ILcdShape contains the given point in
the 2D space. |
boolean |
contains2D(double aX,
double aY,
double aWidth,
double aHeight)
Checks whether this
ILcdBounds object contains the given rectangle in
the 2D space. |
boolean |
contains2D(ILcdBounds aBounds)
Checks whether this
ILcdBounds object contains the given ILcdBounds
object 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(double aX,
double aY,
double aZ,
double aWidth,
double aHeight,
double aDepth)
Checks whether this
ILcdBounds object contains the given box in the 3D
space. |
boolean |
contains3D(ILcdBounds aBounds)
Checks whether this
ILcdBounds object contains the given ILcdBounds
object in the 3D space. |
boolean |
contains3D(ILcdPoint aPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 3D space. |
ELcdKML22AltitudeMode |
getAltitudeMode()
Returns the value of the property that maps to the
altitudeModeGroup element. |
ILcdShape |
getBaseShape()
Returns the shape that is used as a base for extrusion.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
double |
getDepth()
Returns the depth of the bounding box.
|
Double |
getEast()
Returns the value of the property that maps to the
east element. |
ILcdPoint |
getFocusPoint()
Returns the focus point of this
ILcdShape . |
double |
getHeight()
Returns the height of the bounding box.
|
ILcdPoint |
getLocation()
Returns the location of the bounding box (smallest x and y coordinates).
|
Double |
getMaxAltitude()
Returns the value of the property that maps to the
maxAltitude element. |
double |
getMaximumZ()
Returns the maximum Z value for extrusion.
|
Double |
getMinAltitude()
Returns the value of the property that maps to the
minAltitude element. |
double |
getMinimumZ()
Returns the minimum Z value for extrusion.
|
Double |
getNorth()
Returns the value of the property that maps to the
north element. |
Double |
getSouth()
Returns the value of the property that maps to the
south element. |
Double |
getWest()
Returns the value of the property that maps to the
west element. |
double |
getWidth()
Returns the width of the bounding box.
|
boolean |
interacts2D(double aX,
double aY,
double aWidth,
double aHeight)
Checks whether this
ILcdBounds object interacts with the given rectangle in
the 2D space. |
boolean |
interacts2D(ILcdBounds aBounds)
Checks whether this
ILcdBounds object interacts with the given ILcdBounds
object in the 2D space. |
boolean |
interacts3D(double aX,
double aY,
double aZ,
double aWidth,
double aHeight,
double aDepth)
Checks whether this
ILcdBounds object interacts with the given box in
the 3D space. |
boolean |
interacts3D(ILcdBounds aBounds)
Checks whether this
ILcdBounds object interacts with the given ILcdBounds
object. |
boolean |
isDefined()
Indicates whether this bounds object is valid.
|
void |
setAltitudeMode(ELcdKML22AltitudeMode aValue)
Sets the value of the property that maps to the
altitudeModeGroup element. |
void |
setEast(Double aValue)
Sets the value of the property that maps to the
east element. |
void |
setMaxAltitude(Double aValue)
Sets the value of the property that maps to the
maxAltitude element. |
void |
setMinAltitude(Double aValue)
Sets the value of the property that maps to the
minAltitude element. |
void |
setNorth(Double aValue)
Sets the value of the property that maps to the
north element. |
void |
setSouth(Double aValue)
Sets the value of the property that maps to the
south element. |
void |
setWest(Double aValue)
Sets the value of the property that maps to the
west element. |
getId, getTargetId, setId, setTargetId
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
public static final TLcdDataProperty MIN_ALTITUDE_PROPERTY
minAltitude
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty MAX_ALTITUDE_PROPERTY
maxAltitude
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty ALTITUDE_MODE_PROPERTY
altitudeModeGroup
element.
The possible values for this property are instances of ELcdKML22AltitudeMode
.public static final TLcdDataProperty LAT_LON_ALT_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY
LatLonAltBoxSimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty LAT_LON_ALT_BOX_OBJECT_EXTENSION_GROUP_PROPERTY
LatLonAltBoxObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public static final TLcdDataProperty NORTH_PROPERTY
north
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty SOUTH_PROPERTY
south
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty EAST_PROPERTY
east
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty WEST_PROPERTY
west
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty ABSTRACT_LAT_LON_BOX_SIMPLE_EXTENSION_GROUP_PROPERTY
AbstractLatLonBoxSimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty ABSTRACT_LAT_LON_BOX_OBJECT_EXTENSION_GROUP_PROPERTY
AbstractLatLonBoxObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public TLcdKML22LatLonAltBox(TLcdDataType aType)
TLcdKML22LatLonAltBox
with a custom TLcdDataType
.aType
- a custom TLcdDataType
public ILcdShape getBaseShape()
ILcdExtrudedShape
getBaseShape
in interface ILcdExtrudedShape
public double getMinimumZ()
ILcdExtrudedShape
getMinimumZ
in interface ILcdExtrudedShape
public double getMaximumZ()
ILcdExtrudedShape
getMaximumZ
in interface ILcdExtrudedShape
public TLcdKML22LatLonAltBox clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdDataObject
Object.clone()
public TLcdDataObject 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 ILcd2DEditableBounds cloneAs2DEditableBounds()
ILcdBounds
ILcdBounds
object that is also an ILcd2DEditableBounds
.
This makes sure that the first two dimensions of the copy are writable,
even if the original ILcdBounds
object may be read-only.cloneAs2DEditableBounds
in interface ILcdBounds
ILcdBounds
object that is also an ILcd2DEditableBounds
.
This makes sure that the first two dimensions of the copy are writable,
even if the original ILcdBounds
object may be read-only.ILcd2DEditableBounds
public ILcd3DEditableBounds cloneAs3DEditableBounds()
ILcdBounds
ILcdBounds
object that is also an ILcd3DEditableBounds
.
This makes sure that all three dimensions of the copy are writable,
even if the original ILcdBounds
object may be read-only.cloneAs3DEditableBounds
in interface ILcdBounds
ILcdBounds
object that is also an ILcd3DEditableBounds
.
This makes sure that all three dimensions of the copy are writable,
even if the original ILcdBounds
object may be read-only.ILcd3DEditableBounds
public boolean contains2D(ILcdBounds aBounds)
ILcdBounds
ILcdBounds
object contains the given ILcdBounds
object in the 2D space. Only the first two dimensions of the ILcdBounds
objects
are considered.
If either bounds is undefined
, the result is false.
contains2D
in interface ILcdBounds
aBounds
- the ILcdBounds
to compare with.ILcdBounds.contains2D(double, double, double, double)
public boolean isDefined()
ILcdBounds
true
, this bounds describes a valid geographic region.false
, this bounds does not represent a geographic region, and its
location, width, height and depth should not be used.isDefined
in interface ILcdBounds
true
if this object describes actual bounds, false
if notpublic 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 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 boolean contains2D(double aX, double aY, double aWidth, double aHeight)
ILcdBounds
ILcdBounds
object contains the given rectangle in
the 2D space. Only the first two dimensions of the ILcdBounds
object
are considered.
If this bounds is undefined
, the result is false.
contains2D
in interface ILcdBounds
aX
- the x coordinate of the rectangle.aY
- the y coordinate of the rectangle.aWidth
- the width of the rectangle.aHeight
- the height of the rectangle.public boolean contains3D(ILcdBounds aBounds)
ILcdBounds
ILcdBounds
object contains the given ILcdBounds
object in the 3D space.
If either bounds is undefined
, the result is false.
contains3D
in interface ILcdBounds
aBounds
- the ILcdBounds
to compare with.ILcdBounds.contains3D(double, double, double, double, double, double)
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 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(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
ILcdBounds
ILcdBounds
object contains the given box in the 3D
space.
If this bounds is undefined
, the result is false.
contains3D
in interface ILcdBounds
aX
- the x coordinate of the point.aY
- the y coordinate of the point.aZ
- the z coordinate of the point.aWidth
- the width of the box.aHeight
- the height of the box.aDepth
- the depth of the box.ILcdBounds.contains2D(double, double, double, double)
public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.public double getHeight()
ILcdBounds
getHeight
in interface ILcdBounds
public ILcdPoint getLocation()
ILcdBounds
getLocation
in interface ILcdBounds
public double getWidth()
ILcdBounds
getWidth
in interface ILcdBounds
public boolean interacts2D(ILcdBounds aBounds)
ILcdBounds
ILcdBounds
object interacts with the given ILcdBounds
object in the 2D space. Only the first two dimensions of the ILcdBounds
objects
are considered.
If either bounds is undefined
, the result is false.
interacts2D
in interface ILcdBounds
aBounds
- the ILcdBounds
to compare with.ILcdBounds.interacts2D(double, double, double, double)
public boolean interacts2D(double aX, double aY, double aWidth, double aHeight)
ILcdBounds
ILcdBounds
object interacts with the given rectangle in
the 2D space. Only the first two dimensions of the ILcdBounds
object
are considered.
If this bounds is undefined
, the result is false.
interacts2D
in interface ILcdBounds
aX
- the x coordinate of the rectangle.aY
- the y coordinate of the rectangle.aWidth
- the width of the rectangle.aHeight
- the height of the rectangle.true
if this ILcdBounds
object touches or overlaps to
any extent with the given rectangle, false
otherwise.public boolean interacts3D(ILcdBounds aBounds)
ILcdBounds
ILcdBounds
object interacts with the given ILcdBounds
object.
If either bounds is undefined
, the result is false.
interacts3D
in interface ILcdBounds
aBounds
- the ILcdBounds
to compare with.ILcdBounds.interacts3D(double, double, double, double, double, double)
public boolean interacts3D(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)
ILcdBounds
ILcdBounds
object interacts with the given box in
the 3D space.
If this bounds is undefined
, the result is false.
interacts3D
in interface ILcdBounds
aX
- the x coordinate of the box.aY
- the y coordinate of the box.aZ
- the z coordinate of the box.aWidth
- the width of the box.aHeight
- the height of the box.aDepth
- the depth of the box.true
if this ILcdBounds
object touches or overlaps to
any extent with the given box, false
otherwise.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 double getDepth()
ILcdBounds
getDepth
in interface ILcdBounds
public Double getMinAltitude()
minAltitude
element.MIN_ALTITUDE_PROPERTY
property.public void setMinAltitude(Double aValue)
minAltitude
element.aValue
- the value to set for the MIN_ALTITUDE_PROPERTY
property.public Double getMaxAltitude()
maxAltitude
element.MAX_ALTITUDE_PROPERTY
property.public void setMaxAltitude(Double aValue)
maxAltitude
element.aValue
- the value to set for the MAX_ALTITUDE_PROPERTY
property.public ELcdKML22AltitudeMode getAltitudeMode()
altitudeModeGroup
element.ALTITUDE_MODE_PROPERTY
property.public void setAltitudeMode(ELcdKML22AltitudeMode aValue)
altitudeModeGroup
element.aValue
- the value to set for the ALTITUDE_MODE_PROPERTY
property.public Double getNorth()
north
element.NORTH_PROPERTY
property.public void setNorth(Double aValue)
north
element.aValue
- the value to set for the NORTH_PROPERTY
property.public Double getSouth()
south
element.SOUTH_PROPERTY
property.public void setSouth(Double aValue)
south
element.aValue
- the value to set for the SOUTH_PROPERTY
property.public Double getEast()
east
element.EAST_PROPERTY
property.public void setEast(Double aValue)
east
element.aValue
- the value to set for the EAST_PROPERTY
property.public Double getWest()
west
element.WEST_PROPERTY
property.public void setWest(Double aValue)
west
element.aValue
- the value to set for the WEST_PROPERTY
property.