Package com.luciad.format.gml2.model

Class TLcdGML2Point

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.datamodel.TLcdFeaturedDataObject

com.luciad.format.gml2.model.TLcdGML2AbstractGeometry

com.luciad.format.gml2.model.TLcdGML2Point

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdPoint, ILcdShape, ILcd2DEditablePoint, ILcd2DEditableShape, ILcd3DEditablePoint, ILcd3DEditableShape, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable

public class TLcdGML2Point
extends TLcdGML2AbstractGeometry
implements ILcd3DEditablePoint

A Point is defined by a single coordinate tuple.

Since:

10.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	COORD_OR_COORDINATES_PROPERTY	Data property that maps to the choice between the coord and coordinates elements.

Fields inherited from class com.luciad.format.gml2.model.TLcdGML2AbstractGeometry

GID_PROPERTY, SRS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdGML2Point()
TLcdGML2Point(TLcdDataType aType)
TLcdGML2Point(TLcdDataType aDataType, ILcdModelReference aSrs)	Constructs a point and initializes its model reference (srs).
TLcdGML2Point(ILcdModelReference aSrs)	Constructs a point and initializes its model reference (srs).

Method Summary

Modifier and Type	Method	Description
TLcdGML2Point	clone()	Returns a deep clone of this object.
TLcdDataObject	clone(Map aObjectDictionary)	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 v, double v1)	Checks whether this ILcdShape contains the given point in the 2D space.
boolean	contains2D(ILcdPoint aILcdPoint)	Checks whether this ILcdShape contains the given ILcdPoint in the 2D space.
boolean	contains3D(double v, double v1, double v2)	Checks whether this ILcdShape contains the given point in the 3D space.
boolean	contains3D(ILcdPoint aILcdPoint)	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.
ILcdDataObject	getCoordOrCoordinates()	Returns the value of the property that maps to the choice between the coord and coordinates elements.
double	getCosX()	Returns cos( getX() * DEG2RAD ).
double	getCosY()	Returns cos( getY() * DEG2RAD ).
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.
void	move2D(double v, double v1)	Moves this ILcd2DEditableShape to the given point in the 2D space.
void	move2D(ILcdPoint aILcdPoint)	Moves this ILcd2DEditableShape to the given point in the 2D space.
void	move3D(double v, double v1, double v2)	Moves this ILcd3DEditableShape to the given point in the 3D space.
void	move3D(ILcdPoint aILcdPoint)	Moves this ILcd3DEditableShape to the given point in the 3D space.
void	setCoordOrCoordinates(ILcdDataObject aValue)	Sets the value of the property that maps to the choice between the coord and coordinates elements.
void	setValue(TLcdDataProperty aProperty, Object aFeature)	Sets the value of the given property for this data object.
String	toString()
void	translate2D(double v, double v1)	Translates this ILcd2DEditableShape from its current position over the given translation vector in the 2D space.
void	translate3D(double v, double v1, double v2)	Translates this ILcd3DEditableShape from its current position over the given translation vector in the 3D space.

Methods inherited from class com.luciad.format.gml2.model.TLcdGML2AbstractGeometry

getGid, getSrs, setGid, setSrs

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.ILcdPoint

equals

Field Details

COORD_OR_COORDINATES_PROPERTY

public static final TLcdDataProperty COORD_OR_COORDINATES_PROPERTY

Data property that maps to the choice between the coord and coordinates elements. The possible values for this property are instances of

• TLcdGML2Coord
• TLcdGML2Coordinates

Constructor Details

TLcdGML2Point

public TLcdGML2Point()

TLcdGML2Point

public TLcdGML2Point(TLcdDataType aType)

TLcdGML2Point

public TLcdGML2Point(ILcdModelReference aSrs)

Constructs a point and initializes its model reference (srs).

Parameters:

aSrs - the model reference for this object

See Also:

• TLcdGML2AbstractGeometry.setSrs(ILcdModelReference)

TLcdGML2Point

public TLcdGML2Point(TLcdDataType aDataType,
 ILcdModelReference aSrs)

Constructs a point and initializes its model reference (srs).

Parameters:

aDataType - the data type for this object

aSrs - the model reference for this object

See Also:

• TLcdGML2AbstractGeometry.setSrs(ILcdModelReference)

Method Details

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 ).

clone

public TLcdGML2Point 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

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 aILcdPoint)

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

Parameters:

aILcdPoint - the ILcdPoint to move to.

See Also:

• ILcd3DEditableShape.move3D(double, double, double)

move3D

public void move3D(double v,
 double v1,
 double v2)

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

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z coordinate of the point.

translate3D

public void translate3D(double v,
 double v1,
 double v2)

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

Parameters:

v - the x coordinate of the translation vector.

v1 - the y coordinate of the translation vector.

v2 - the z coordinate of the translation vector.

move2D

public void move2D(ILcdPoint aILcdPoint)

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

Parameters:

aILcdPoint - the ILcdPoint to move to.

See Also:

• ILcd2DEditableShape.move2D(double, double)

move2D

public void move2D(double v,
 double v1)

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

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

translate2D

public void translate2D(double v,
 double v1)

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

Parameters:

v - the x coordinate of the translation vector.

v1 - 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 TLcdGML2AbstractGeometry

Returns:

the focus point of this ILcdShape.

contains2D

public boolean contains2D(ILcdPoint aILcdPoint)

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 TLcdGML2AbstractGeometry

Parameters:

aILcdPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

• ILcdShape.contains2D(double, double)

contains2D

public boolean contains2D(double v,
 double v1)

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 TLcdGML2AbstractGeometry

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

Returns:

the boolean result of the containment test.

contains3D

public boolean contains3D(ILcdPoint aILcdPoint)

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 TLcdGML2AbstractGeometry

Parameters:

aILcdPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

• ILcdShape.contains3D(double, double, double)

contains3D

public boolean contains3D(double v,
 double v1,
 double v2)

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 TLcdGML2AbstractGeometry

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z coordinate of the point.

Returns:

the boolean result of the containment test.

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 TLcdGML2AbstractGeometry

Returns:

the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

setValue

public void setValue(TLcdDataProperty aProperty,
 Object aFeature)

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

aFeature - the value to set

See Also:

• TLcdDataType.getProperty(String)

toString

public String toString()

Overrides:

toString in class TLcdDataObject

getCoordOrCoordinates

public ILcdDataObject getCoordOrCoordinates()

Returns the value of the property that maps to the choice between the coord and coordinates elements.

The possible values for this property are instances of

• TLcdGML2Coord
• TLcdGML2Coordinates

Returns:

the value of the COORD_OR_COORDINATES_PROPERTY property.

setCoordOrCoordinates

public void setCoordOrCoordinates(ILcdDataObject aValue)

Sets the value of the property that maps to the choice between the coord and coordinates elements.

The possible values for this property are instances of

• TLcdGML2Coord
• TLcdGML2Coordinates

Parameters:

aValue - the value to set for the COORD_OR_COORDINATES_PROPERTY property.