TLcdGML31Envelope (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.datamodel.TLcdFeaturedDataObject
  - - com.luciad.format.gml31.model.TLcdGML31Envelope

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdBounds, ILcdShape, ILcd2DEditableBounds, ILcd2DEditableShape, ILcd3DEditableBounds, ILcd3DEditableShape, ILcdCloneable, ILcdDeepCloneable, ~~ILcdFeatured~~ , ~~ILcdSelfDescribedFeatured~~ , Serializable, Cloneable

Direct Known Subclasses:

TLcdGML31Box, TLcdGML31EnvelopeWithTimePeriod
```
public class TLcdGML31Envelope
extends TLcdFeaturedDataObject
implements ILcd3DEditableBounds
```
Domain class for the GML envelope.

Envelope defines an extent using a pair of positions defining opposite corners in arbitrary dimensions. The first direct position is the "lower corner" (a coordinate position consisting of all the minimal ordinates for each dimension for all points within the envelope), the second one the "upper corner" (a coordinate position consisting of all the maximal ordinates for each dimension for all points within the envelope).

The use of the properties "coordinates" and "pos" has been deprecated. The explicitly named properties "lowerCorner" and "upperCorner" shall be used instead.

Since:

10.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`COORD_PROPERTY` Property that maps on the `coord` element.
`static TLcdDataProperty`	`COORDINATES_PROPERTY` Property that maps on the `coordinates` element.
`static TLcdDataProperty`	`LOWER_CORNER_PROPERTY` Property that maps on the `lowerCorner` element.
`static TLcdDataProperty`	`POS_PROPERTY` Property that maps on the `pos` element.
`static TLcdDataProperty`	`SRS_PROPERTY` Property that maps on the `SRSReferenceGroup` attributes.
`static TLcdDataProperty`	`UPPER_CORNER_PROPERTY` Property that maps on the `upperCorner` element.

Constructor Summary

Constructors
Constructor and Description
`TLcdGML31Envelope()`
`TLcdGML31Envelope(ILcdModelReference aSrs)` Constructs an envelope and initializes its model reference (srs).
`TLcdGML31Envelope(TLcdDataType aType)`
`TLcdGML31Envelope(TLcdDataType aDataType, ILcdModelReference aSrs)` Constructs an envelope and initializes its model reference (srs).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLcdGML31Envelope`	`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.
`ILcdBounds`	`getBounds()` Returns the `ILcdBounds` by which the geometry of this `ILcdBounded` object is bounded.
`List<TLcdGML31Coord>`	`getCoord()` Gets the value of the `COORD_PROPERTY` property.
`TLcdGML31Coordinates`	`getCoordinates()` Gets the value of the `COORDINATES_PROPERTY` property.
`double`	`getDepth()` Returns the depth of the bounding box.
`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).
`TLcdGML31DirectPosition`	`getLowerCorner()` Gets the value of the `LOWER_CORNER_PROPERTY` property.
`List<TLcdGML31DirectPosition>`	`getPos()` Gets the value of the `POS_PROPERTY` property.
`ILcdModelReference`	`getSrs()` Gets the value of the `SRS_PROPERTY` property.
`TLcdGML31DirectPosition`	`getUpperCorner()` Gets the value of the `UPPER_CORNER_PROPERTY` property.
`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`	`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`	`setCoordinates(TLcdGML31Coordinates aValue)` Sets the value of the `COORDINATES_PROPERTY` property.
`void`	`setDepth(double aDepth)` Sets the depth of the bounds (the extent along the z-axis).
`void`	`setHeight(double aHeight)` Sets the height of the bounds (the extent along the y-axis).
`void`	`setLowerCorner(TLcdGML31DirectPosition aValue)` Sets the value of the `LOWER_CORNER_PROPERTY` property.
`void`	`setSrs(ILcdModelReference aValue)` Sets the value of the `SRS_PROPERTY` property.
`void`	`setTo2DIntersection(double aX, double aY, double aWidth, double aHeight)` Calculates the 2D intersection of this `ILcd2DEditableBounds` object and a given rectangle.
`void`	`setTo2DIntersection(ILcdBounds aBounds)` Calculates the 2D intersection of this `ILcd2DEditableBounds` and a given `ILcdBounds`.
`void`	`setTo2DUnion(double aX, double aY, double aWidth, double aHeight)` Calculates the 2D union of this `ILcd2DEditableBounds` object and a given rectangle.
`void`	`setTo2DUnion(ILcdBounds aBounds)` Calculates the 2D union of this `ILcd2DEditableBounds` and a given `ILcdBounds`.
`void`	`setTo3DIntersection(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)` Calculates the 3D intersection of this `ILcd3DEditableBounds` and a given box.
`void`	`setTo3DIntersection(ILcdBounds aBounds)` Calculates the 3D intersection of this `ILcd3DEditableBounds` and a given `ILcdBounds`.
`void`	`setTo3DUnion(double aX, double aY, double aZ, double aWidth, double aHeight, double aDepth)` Calculates the 3D union of this `ILcd3DEditableBounds` and a given box.
`void`	`setTo3DUnion(ILcdBounds aBounds)` Calculates the 3D union of this `ILcd3DEditableBounds` and a given `ILcdBounds`.
`void`	`setToIncludePoint2D(double aX, double aY)` Calculates the 2D extension of this `ILcd2DEditableBounds` object that contains a given point.
`void`	`setToIncludePoint2D(ILcdPoint aPoint)` Calculates the 2D extension of this `ILcd2DEditableBounds` object that contains a given `ILcdPoint`.
`void`	`setToIncludePoint3D(double aX, double aY, double aZ)` Calculates the 3D extension of this `ILcd3DEditableBounds` that contains a given `ILcdPoint`.
`void`	`setToIncludePoint3D(ILcdPoint aPoint)` Calculates the 3D extension of this `ILcd3DEditableBounds` that contains a given `ILcdPoint`.
`void`	`setUpperCorner(TLcdGML31DirectPosition aValue)` Sets the value of the `UPPER_CORNER_PROPERTY` property.
`void`	`setValue(TLcdDataProperty aProperty, Object aValue)` Sets the value of the given property for this data object.
`void`	`setWidth(double aWidth)` Sets the width of the bounds (the extent along the x-axis).
`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`	`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.datamodel.TLcdFeaturedDataObject
canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeature

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

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

Methods inherited from interface com.luciad.shape.ILcdBounds
getCenter, getMaxX, getMaxY, getMaxZ, getMinX, getMinY, getMinZ

- Field Detail
  - SRS_PROPERTY
```
public static final TLcdDataProperty SRS_PROPERTY
```
    Property that maps on the SRSReferenceGroup attributes. Acceptable values for this property are instances of ILcdModelReference.
  - LOWER_CORNER_PROPERTY
```
public static final TLcdDataProperty LOWER_CORNER_PROPERTY
```
    Property that maps on the lowerCorner element. Acceptable values for this property are instances of com.luciad.format.gml31.model.TLcdGML31DirectPosition.
  - UPPER_CORNER_PROPERTY
```
public static final TLcdDataProperty UPPER_CORNER_PROPERTY
```
    Property that maps on the upperCorner element. Acceptable values for this property are instances of com.luciad.format.gml31.model.TLcdGML31DirectPosition.
  - POS_PROPERTY
```
public static final TLcdDataProperty POS_PROPERTY
```
    Property that maps on the pos element. Acceptable values for this property are instances of java.util.List<com.luciad.format.gml31.model.TLcdGML31DirectPosition>.
  - COORDINATES_PROPERTY
```
public static final TLcdDataProperty COORDINATES_PROPERTY
```
    Property that maps on the coordinates element. Acceptable values for this property are instances of com.luciad.format.gml31.model.TLcdGML31Coordinates.
  - COORD_PROPERTY
```
public static final TLcdDataProperty COORD_PROPERTY
```
    Property that maps on the coord element. Acceptable values for this property are instances of java.util.List<com.luciad.format.gml31.model.TLcdGML31Coord>.
- Constructor Detail
  - TLcdGML31Envelope
```
public TLcdGML31Envelope()
```
  - TLcdGML31Envelope
```
public TLcdGML31Envelope(TLcdDataType aType)
```
  - TLcdGML31Envelope
```
public TLcdGML31Envelope(ILcdModelReference aSrs)
```
    Constructs an envelope and initializes its model reference (srs).
    
    Parameters:
    
    aSrs - the model reference for this object
    
    See Also:
    
    setSrs(ILcdModelReference)
  - TLcdGML31Envelope
```
public TLcdGML31Envelope(TLcdDataType aDataType,
                         ILcdModelReference aSrs)
```
    Constructs an envelope and initializes its model reference (srs).
    
    Parameters:
    
    aDataType - the data type for this object
    
    aSrs - the model reference for this object
    
    See Also:
    
    setSrs(ILcdModelReference)
- Method Detail
  - getSrs
```
public ILcdModelReference getSrs()
```
    Gets the value of the SRS_PROPERTY property.
    
    Returns:
    
    the value of the SRS_PROPERTY property.
  - setSrs
```
public void setSrs(ILcdModelReference aValue)
```
    Sets the value of the SRS_PROPERTY property.
    
    Parameters:
    
    aValue - the value to set for the SRS_PROPERTY property.
  - getLowerCorner
```
public TLcdGML31DirectPosition getLowerCorner()
```
    Gets the value of the LOWER_CORNER_PROPERTY property.
    
    Returns:
    
    the value of the LOWER_CORNER_PROPERTY property.
  - setLowerCorner
```
public void setLowerCorner(TLcdGML31DirectPosition aValue)
```
    Sets the value of the LOWER_CORNER_PROPERTY property.
    
    Parameters:
    
    aValue - the value to set for the LOWER_CORNER_PROPERTY property.
  - getUpperCorner
```
public TLcdGML31DirectPosition getUpperCorner()
```
    Gets the value of the UPPER_CORNER_PROPERTY property.
    
    Returns:
    
    the value of the UPPER_CORNER_PROPERTY property.
  - setUpperCorner
```
public void setUpperCorner(TLcdGML31DirectPosition aValue)
```
    Sets the value of the UPPER_CORNER_PROPERTY property.
    
    Parameters:
    
    aValue - the value to set for the UPPER_CORNER_PROPERTY property.
  - getPos
```
public List<TLcdGML31DirectPosition> getPos()
```
    Gets the value of the POS_PROPERTY property.
    
    Returns:
    
    the value of the POS_PROPERTY property.
  - getCoordinates
```
public TLcdGML31Coordinates getCoordinates()
```
    Gets the value of the COORDINATES_PROPERTY property.
    
    Returns:
    
    the value of the COORDINATES_PROPERTY property.
  - setCoordinates
```
public void setCoordinates(TLcdGML31Coordinates aValue)
```
    Sets the value of the COORDINATES_PROPERTY property.
    
    Parameters:
    
    aValue - the value to set for the COORDINATES_PROPERTY property.
  - setValue
```
public void setValue(TLcdDataProperty aProperty,
                     Object aValue)
```
    Description copied from interface: ILcdDataObject
    
    Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.
    The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.
    
    Specified by:
    
    setValue in interface ILcdDataObject
    
    Overrides:
    
    setValue in class TLcdDataObject
    
    Parameters:
    
    aProperty - the property for which the value is to be set
    
    aValue - the value to set
    
    See Also:
    
    TLcdDataType.getProperty(String)
  - isDefined
```
public boolean isDefined()
```
    Description copied from interface: ILcdBounds
    Indicates whether this bounds object is valid.
    - If true, this bounds describes a valid geographic region.
    - If false, this bounds does not represent a geographic region, and its location, width, height and depth should not be used.
    Specified by:
    
    isDefined in interface ILcdBounds
    
    Returns:
    
    true if this object describes actual bounds, false if not
  - setWidth
```
public void setWidth(double aWidth)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Sets the width of the bounds (the extent along the x-axis).
    If this bounds was undefined, it becomes defined.
    
    Specified by:
    
    setWidth in interface ILcd2DEditableBounds
    
    Parameters:
    
    aWidth - the new width.
  - setHeight
```
public void setHeight(double aHeight)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Sets the height of the bounds (the extent along the y-axis).
    If this bounds was undefined, it becomes defined.
    
    Specified by:
    
    setHeight in interface ILcd2DEditableBounds
    
    Parameters:
    
    aHeight - the new height.
  - setDepth
```
public void setDepth(double aDepth)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Sets the depth of the bounds (the extent along the z-axis).
    If this bounds is undefined, it becomes defined.
    
    Specified by:
    
    setDepth in interface ILcd3DEditableBounds
    
    Parameters:
    
    aDepth - the new depth.
  - getWidth
```
public double getWidth()
```
    Description copied from interface: ILcdBounds
    
    Returns the width of the bounding box. The width has to be larger than or equal to 0.
    
    Specified by:
    
    getWidth in interface ILcdBounds
    
    Returns:
    
    the width of the bounding box.
  - getHeight
```
public double getHeight()
```
    Description copied from interface: ILcdBounds
    
    Returns the height of the bounding box. The height has to be larger than or equal to 0.
    
    Specified by:
    
    getHeight in interface ILcdBounds
    
    Returns:
    
    the height of the bounding box.
  - getDepth
```
public double getDepth()
```
    Description copied from interface: ILcdBounds
    
    Returns the depth of the bounding box. The depth has to be larger than or equal to 0.
    
    Specified by:
    
    getDepth in interface ILcdBounds
    
    Returns:
    
    the depth of the bounding box.
  - getLocation
```
public ILcdPoint getLocation()
```
    Description copied from interface: ILcdBounds
    
    Returns the location of the bounding box (smallest x and y coordinates).
    
    Specified by:
    
    getLocation in interface ILcdBounds
    
    Returns:
    
    the location of the bounding box.
  - clone
```
public TLcdGML31Envelope 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()
  - clone
```
public TLcdDataObject clone(Map aObjectDictionary)
```
    Description copied from class: TLcdDataObject
    Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:
    - First, a new instance is created using Java's clone() mechanism.
    - Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
      
      If the property value is an 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.
      
      If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
      
      Otherwise, the property value is copied by reference.
    Specified by:
    
    clone in interface ILcdDeepCloneable
    
    Overrides:
    
    clone in class TLcdDataObject
    
    Parameters:
    
    aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
    
    Returns:
    
    a deep clone of this object
  - move2D
```
public void move2D(ILcdPoint aPoint)
```
    Description copied from interface: ILcd2DEditableBounds
    
    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.
    If this bounds was undefined, it becomes defined after the move.
    
    Specified by:
    
    move2D in interface ILcd2DEditableBounds
    
    Specified by:
    
    move2D in interface ILcd2DEditableShape
    
    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: ILcd2DEditableBounds
    
    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.
    If this bounds was undefined, it becomes defined after the move.
    
    Specified by:
    
    move2D in interface ILcd2DEditableBounds
    
    Specified by:
    
    move2D in interface ILcd2DEditableShape
    
    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: ILcd2DEditableBounds
    
    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.
    If this bounds was undefined, it becomes defined after the translation.
    
    Specified by:
    
    translate2D in interface ILcd2DEditableBounds
    
    Specified by:
    
    translate2D in interface ILcd2DEditableShape
    
    Parameters:
    
    aDeltaX - the x coordinate of the translation vector.
    
    aDeltaY - the y coordinate of the translation vector.
  - move3D
```
public void move3D(ILcdPoint aPoint)
```
    Description copied from interface: ILcd3DEditableBounds
    
    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.
    If this bounds was undefined, it becomes defined after the move.
    
    Specified by:
    
    move3D in interface ILcd3DEditableBounds
    
    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 aX,
                   double aY,
                   double aZ)
```
    Description copied from interface: ILcd3DEditableBounds
    
    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.
    If this bounds was undefined, it becomes defined after the move.
    
    Specified by:
    
    move3D in interface ILcd3DEditableBounds
    
    Specified by:
    
    move3D in interface ILcd3DEditableShape
    
    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: ILcd3DEditableBounds
    
    Translates this ILcd3DEditableShape from its current position over the given translation vector in the 3D space.
    If this bounds is undefined, it becomes defined.
    
    Specified by:
    
    translate3D in interface ILcd3DEditableBounds
    
    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.
  - setTo3DIntersection
```
public void setTo3DIntersection(ILcdBounds aBounds)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D intersection of this ILcd3DEditableBounds and a given ILcdBounds. The result contains at least all the points that are contained in both ILcdBounds objects. This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, nothing changes. If the argument bounds is undefined, this bounds becomes undefined as well.
    
    Specified by:
    
    setTo3DIntersection in interface ILcd3DEditableBounds
    
    Parameters:
    
    aBounds - the other ILcdBounds operand for the intersection.
    
    See Also:
    
    ILcd3DEditableBounds.setTo3DIntersection(double, double, double, double, double, double)
  - setTo3DIntersection
```
public void setTo3DIntersection(double aX,
                                double aY,
                                double aZ,
                                double aWidth,
                                double aHeight,
                                double aDepth)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D intersection of this ILcd3DEditableBounds and a given box. The result contains at least all the points that are contained both in the ILcdBounds object and in the box. This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, nothing changes.
    
    Specified by:
    
    setTo3DIntersection in interface ILcd3DEditableBounds
    
    Parameters:
    
    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.
  - setTo3DUnion
```
public void setTo3DUnion(ILcdBounds aBounds)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D union of this ILcd3DEditableBounds and a given ILcdBounds. The result contains at least all the points that are contained in either or both of the ILcdBounds objects (and typically more). This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, it is set to the argument bounds. If the argument bounds is undefined, nothing happens.
    
    Specified by:
    
    setTo3DUnion in interface ILcd3DEditableBounds
    
    Parameters:
    
    aBounds - the other ILcdBounds operand for the union.
    
    See Also:
    
    ILcd3DEditableBounds.setTo3DUnion(double, double, double, double, double, double)
  - setTo3DUnion
```
public void setTo3DUnion(double aX,
                         double aY,
                         double aZ,
                         double aWidth,
                         double aHeight,
                         double aDepth)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D union of this ILcd3DEditableBounds and a given box. The result contains at least all the points that are contained in the ILcdBounds objects and in the box (and typically more). This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, it is set to the arguments.
    
    Specified by:
    
    setTo3DUnion in interface ILcd3DEditableBounds
    
    Parameters:
    
    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.
  - setToIncludePoint3D
```
public void setToIncludePoint3D(ILcdPoint aPoint)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D extension of this ILcd3DEditableBounds that contains a given ILcdPoint. The result contains at least the given point and all the points that are contained in this ILcd3DEditableBounds (and typically more). This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, it is set to the point.
    
    Specified by:
    
    setToIncludePoint3D in interface ILcd3DEditableBounds
    
    Parameters:
    
    aPoint - the ILcdPoint operand for the union.
    
    See Also:
    
    ILcd3DEditableBounds.setToIncludePoint3D(double, double, double)
  - setToIncludePoint3D
```
public void setToIncludePoint3D(double aX,
                                double aY,
                                double aZ)
```
    Description copied from interface: ILcd3DEditableBounds
    
    Calculates the 3D extension of this ILcd3DEditableBounds that contains a given ILcdPoint. The result contains at least the given point and all the points that are contained in this ILcd3DEditableBounds (and typically more). This ILcd3DEditableBounds object is updated with the result.
    If this bounds is undefined, it is set to the point.
    
    Specified by:
    
    setToIncludePoint3D in interface ILcd3DEditableBounds
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
    
    aZ - the z coordinate of the point.
  - setTo2DIntersection
```
public void setTo2DIntersection(ILcdBounds aBounds)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D intersection of this ILcd2DEditableBounds and a given ILcdBounds. The result contains at least all the points that are contained in both ILcdBounds objects. Only the first two dimensions of the ILcdBounds objects are considered. This ILcd2DEditableBounds object is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, nothing changes. If the argument bounds is undefined, this bounds becomes undefined as well.
    
    Specified by:
    
    setTo2DIntersection in interface ILcd2DEditableBounds
    
    Parameters:
    
    aBounds - the other ILcdBounds operand for the intersection.
    
    See Also:
    
    ILcd2DEditableBounds.setTo2DIntersection(double, double, double, double)
  - setTo2DIntersection
```
public void setTo2DIntersection(double aX,
                                double aY,
                                double aWidth,
                                double aHeight)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D intersection of this ILcd2DEditableBounds object and a given rectangle. The result contains at least all the points that are contained both in this ILcdBounds objects and in the rectangle. Only the first two dimensions of this ILcdBounds object are considered. It is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, nothing changes.
    
    Specified by:
    
    setTo2DIntersection in interface ILcd2DEditableBounds
    
    Parameters:
    
    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.
  - setTo2DUnion
```
public void setTo2DUnion(ILcdBounds aBounds)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D union of this ILcd2DEditableBounds and a given ILcdBounds. The result contains at least all the points that are contained in either of the ILcdBounds objects (and typically more). Only the first two dimensions of the ILcdBounds objects are considered. This ILcd2DEditableBounds object is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, it is set to the argument bounds. If the argument bounds is undefined, nothing happens.
    
    Specified by:
    
    setTo2DUnion in interface ILcd2DEditableBounds
    
    Parameters:
    
    aBounds - the other ILcdBounds operand for the union.
    
    See Also:
    
    ILcd2DEditableBounds.setTo2DUnion(double, double, double, double)
  - setTo2DUnion
```
public void setTo2DUnion(double aX,
                         double aY,
                         double aWidth,
                         double aHeight)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D union of this ILcd2DEditableBounds object and a given rectangle. The result contains at least all the points that are contained in the ILcdBounds object and in the rectangle (and typically more). Only the first two dimensions of this ILcdBounds object are considered. It is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, it is set to the arguments.
    
    Specified by:
    
    setTo2DUnion in interface ILcd2DEditableBounds
    
    Parameters:
    
    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.
  - setToIncludePoint2D
```
public void setToIncludePoint2D(ILcdPoint aPoint)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D extension of this ILcd2DEditableBounds object that contains a given ILcdPoint. The result contains at least the given point and all the points that are contained in this ILcd2DEditableBounds (and typically more). Only the first two dimensions of this ILcdBounds object and the ILcdPoint are considered. This ILcdBounds object is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, it is set to the point.
    
    Specified by:
    
    setToIncludePoint2D in interface ILcd2DEditableBounds
    
    Parameters:
    
    aPoint - the point that should be inside (or at the edge) after the extension of the bounds.
    
    See Also:
    
    ILcd2DEditableBounds.setToIncludePoint2D(double, double)
  - setToIncludePoint2D
```
public void setToIncludePoint2D(double aX,
                                double aY)
```
    Description copied from interface: ILcd2DEditableBounds
    
    Calculates the 2D extension of this ILcd2DEditableBounds object that contains a given point. The result contains at least the given point and all the points that are contained in this ILcd2DEditableBounds (and typically more). Only the first two dimensions of this ILcdBounds object are considered. It is updated with the result. Its third dimension is left unchanged.
    If this bounds is undefined, it is set to the point.
    
    Specified by:
    
    setToIncludePoint2D in interface ILcd2DEditableBounds
    
    Parameters:
    
    aX - the x coordinate of the point.
    
    aY - the y coordinate of the point.
  - cloneAs2DEditableBounds
```
public ILcd2DEditableBounds cloneAs2DEditableBounds()
```
    Description copied from interface: ILcdBounds
    
    Returns a copy of this 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.
    
    Specified by:
    
    cloneAs2DEditableBounds in interface ILcdBounds
    
    Returns:
    
    a copy of this 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.
    
    See Also:
    
    ILcd2DEditableBounds
  - cloneAs3DEditableBounds
```
public ILcd3DEditableBounds cloneAs3DEditableBounds()
```
    Description copied from interface: ILcdBounds
    
    Returns a copy of this 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.
    
    Specified by:
    
    cloneAs3DEditableBounds in interface ILcdBounds
    
    Returns:
    
    a copy of this 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.
    
    See Also:
    
    ILcd3DEditableBounds
  - contains2D
```
public boolean contains2D(ILcdBounds aBounds)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this 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.
    
    Specified by:
    
    contains2D in interface ILcdBounds
    
    Parameters:
    
    aBounds - the ILcdBounds to compare with.
    
    Returns:
    
    the boolean result of the containment test.
    
    See Also:
    
    ILcdBounds.contains2D(double, double, double, double)
  - contains2D
```
public boolean contains2D(double aX,
                          double aY,
                          double aWidth,
                          double aHeight)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this 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.
    
    Specified by:
    
    contains2D in interface ILcdBounds
    
    Parameters:
    
    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.
    
    Returns:
    
    the boolean result of the containment test.
  - contains3D
```
public boolean contains3D(ILcdBounds aBounds)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this ILcdBounds object contains the given ILcdBounds object in the 3D space.
    If either bounds is undefined, the result is false.
    
    Specified by:
    
    contains3D in interface ILcdBounds
    
    Parameters:
    
    aBounds - the ILcdBounds to compare with.
    
    Returns:
    
    the boolean result of the containment test.
    
    See Also:
    
    ILcdBounds.contains3D(double, double, double, double, double, double)
  - contains3D
```
public boolean contains3D(double aX,
                          double aY,
                          double aZ,
                          double aWidth,
                          double aHeight,
                          double aDepth)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this ILcdBounds object contains the given box in the 3D space.
    If this bounds is undefined, the result is false.
    
    Specified by:
    
    contains3D in interface ILcdBounds
    
    Parameters:
    
    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.
    
    Returns:
    
    the boolean result of the containment test.
    
    See Also:
    
    ILcdBounds.contains2D(double, double, double, double)
  - interacts2D
```
public boolean interacts2D(ILcdBounds aBounds)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this 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.
    
    Specified by:
    
    interacts2D in interface ILcdBounds
    
    Parameters:
    
    aBounds - the ILcdBounds to compare with.
    
    Returns:
    
    the boolean result of the interaction test.
    
    See Also:
    
    ILcdBounds.interacts2D(double, double, double, double)
  - interacts2D
```
public boolean interacts2D(double aX,
                           double aY,
                           double aWidth,
                           double aHeight)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this 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.
    
    Specified by:
    
    interacts2D in interface ILcdBounds
    
    Parameters:
    
    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.
    
    Returns:
    
    true if this ILcdBounds object touches or overlaps to any extent with the given rectangle, false otherwise.
  - interacts3D
```
public boolean interacts3D(ILcdBounds aBounds)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this ILcdBounds object interacts with the given ILcdBounds object.
    If either bounds is undefined, the result is false.
    
    Specified by:
    
    interacts3D in interface ILcdBounds
    
    Parameters:
    
    aBounds - the ILcdBounds to compare with.
    
    Returns:
    
    the boolean result of the interaction test.
    
    See Also:
    
    ILcdBounds.interacts3D(double, double, double, double, double, double)
  - interacts3D
```
public boolean interacts3D(double aX,
                           double aY,
                           double aZ,
                           double aWidth,
                           double aHeight,
                           double aDepth)
```
    Description copied from interface: ILcdBounds
    
    Checks whether this ILcdBounds object interacts with the given box in the 3D space.
    If this bounds is undefined, the result is false.
    
    Specified by:
    
    interacts3D in interface ILcdBounds
    
    Parameters:
    
    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.
    
    Returns:
    
    true if this ILcdBounds object touches or overlaps to any extent with the given box, false otherwise.
  - 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.
  - 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.
  - 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class TLcdDataObject
  - getCoord
```
public List<TLcdGML31Coord> getCoord()
```
    Gets the value of the COORD_PROPERTY property.
    Deprecated with GML 3.0 and included for backwards compatibility with GML 2. Use the "pos" element instead.
    
    Returns:
    
    the value of the COORD_PROPERTY property.

LuciadLightspeedClass TLcdGML31Envelope

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdBounds

Field Detail

SRS_PROPERTY

LOWER_CORNER_PROPERTY

UPPER_CORNER_PROPERTY

POS_PROPERTY

COORDINATES_PROPERTY

COORD_PROPERTY

Constructor Detail

TLcdGML31Envelope

TLcdGML31Envelope

TLcdGML31Envelope

TLcdGML31Envelope

Method Detail

getSrs

setSrs

getLowerCorner

setLowerCorner

getUpperCorner

setUpperCorner

getPos

getCoordinates

setCoordinates

setValue

isDefined

setWidth

setHeight

setDepth

getWidth

getHeight

getDepth

getLocation

clone

clone

move2D

move2D

translate2D

move3D

move3D

translate3D

setTo3DIntersection

setTo3DIntersection

setTo3DUnion

setTo3DUnion

setToIncludePoint3D

setToIncludePoint3D

setTo2DIntersection

setTo2DIntersection

setTo2DUnion

setTo2DUnion

setToIncludePoint2D

setToIncludePoint2D

cloneAs2DEditableBounds

cloneAs3DEditableBounds

contains2D

contains2D

contains3D

contains3D

interacts2D

interacts2D

interacts3D

interacts3D

contains2D

contains2D

contains3D

contains3D

getFocusPoint

getBounds

toString

getCoord