Package com.luciad.format.gml31.model

Class TLcdGML31OrientableSurface

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.datamodel.TLcdFeaturedDataObject

com.luciad.format.gml31.model.TLcdGML31AbstractGML

com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

com.luciad.format.gml31.model.TLcdGML31AbstractGeometricPrimitive

com.luciad.format.gml31.model.TLcdGML31AbstractSurface

com.luciad.format.gml31.model.TLcdGML31OrientableSurface

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdShape, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable

public class TLcdGML31OrientableSurface
extends TLcdGML31AbstractSurface
implements ILcdShape

OrientableSurface consists of a surface and an orientation. If the orientation is "+", then the OrientableSurface is identical to the baseSurface. If the orientation is "-", then the OrientableSurface is a reference to a gml:AbstractSurface with an up-normal that reverses the direction for this OrientableSurface, the sense of "the top of the surface".

Since:

10.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	BASE_SURFACE_PROPERTY	Data property that maps to the baseSurface element.
static final TLcdDataProperty	GID_PROPERTY	Property that maps on the gid attribute.
static final TLcdDataProperty	ORIENTATION_PROPERTY	Data property that maps to the orientation attribute.

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

SRS_PROPERTY

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

DESCRIPTION_PROPERTY, ID_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdGML31OrientableSurface()
TLcdGML31OrientableSurface(TLcdDataType aType)
TLcdGML31OrientableSurface(TLcdDataType aDataType, ILcdModelReference aSrs)	Constructs an orientable surface and initializes its model reference (srs).
TLcdGML31OrientableSurface(ILcdModelReference aSrs)	Constructs an orientable surface and initializes its model reference (srs).

Method Summary

Modifier and Type	Method	Description
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.
TLcdGML31AbstractSurface	getBaseSurface()	Returns the value of the property that maps to the baseSurface element.
ILcdBounds	getBounds()	Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
ILcdPoint	getFocusPoint()	Returns the focus point of this ILcdShape.
String	getGid()	Gets the value of the GID_PROPERTY property.
ELcdGML31Sign	getOrientation()	Returns the value of the property that maps to the orientation attribute.
void	setBaseSurface(TLcdGML31AbstractSurface aValue)	Sets the value of the property that maps to the baseSurface element.
void	setGid(String aValue)	Sets the value of the GID_PROPERTY property.
void	setOrientation(ELcdGML31Sign aValue)	Sets the value of the property that maps to the orientation attribute.

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

getSrs, setSrs, toString

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

getDescription, getId, getMetaDataProperty, getName, setDescription, setId

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject

canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeature

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.util.ILcdCloneable

clone

Field Details

ORIENTATION_PROPERTY

public static final TLcdDataProperty ORIENTATION_PROPERTY

Data property that maps to the orientation attribute. The possible values for this property are instances of ELcdGML31Sign.

BASE_SURFACE_PROPERTY

public static final TLcdDataProperty BASE_SURFACE_PROPERTY

Data property that maps to the baseSurface element. The possible values for this property are instances of TLcdGML31SurfaceProperty.

GID_PROPERTY

public static final TLcdDataProperty GID_PROPERTY

Property that maps on the gid attribute. Acceptable values for this property are instances of java.lang.String.

Constructor Details

TLcdGML31OrientableSurface

public TLcdGML31OrientableSurface()

TLcdGML31OrientableSurface

public TLcdGML31OrientableSurface(TLcdDataType aType)

TLcdGML31OrientableSurface

public TLcdGML31OrientableSurface(ILcdModelReference aSrs)

Constructs an orientable surface and initializes its model reference (srs).

Parameters:

aSrs - the model reference for this object

See Also:

• TLcdGML31AbstractGeometry.setSrs(ILcdModelReference)

TLcdGML31OrientableSurface

public TLcdGML31OrientableSurface(TLcdDataType aDataType,
 ILcdModelReference aSrs)

Constructs an orientable surface and initializes its model reference (srs).

Parameters:

aSrs - the model reference for this object

See Also:

• TLcdGML31AbstractGeometry.setSrs(ILcdModelReference)

Method Details

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 TLcdGML31AbstractGeometry

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 TLcdGML31AbstractGeometry

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 TLcdGML31AbstractGeometry

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 TLcdGML31AbstractGeometry

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 TLcdGML31AbstractGeometry

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 TLcdGML31AbstractGeometry

Returns:

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

getOrientation

public ELcdGML31Sign getOrientation()

Returns the value of the property that maps to the orientation attribute.

If the orientation is "+", then the OrientableSurface is identical to the baseSurface. If the orientation is "-", then the OrientableSurface is a reference to a Surface with an up-normal that reverses the direction for this OrientableSurface, the sense of "the top of the surface". "+" is the default value.

Returns:

the value of the ORIENTATION_PROPERTY property.

setOrientation

public void setOrientation(ELcdGML31Sign aValue)

Sets the value of the property that maps to the orientation attribute.

If the orientation is "+", then the OrientableSurface is identical to the baseSurface. If the orientation is "-", then the OrientableSurface is a reference to a Surface with an up-normal that reverses the direction for this OrientableSurface, the sense of "the top of the surface". "+" is the default value.

Parameters:

aValue - the value to set for the ORIENTATION_PROPERTY property.

getBaseSurface

public TLcdGML31AbstractSurface getBaseSurface()

Returns the value of the property that maps to the baseSurface element.

This property element either references a surface via the XLink-attributes or contains the surface element. A surface element is any element which is substitutable for "_Surface".

Returns:

the value of the BASE_SURFACE_PROPERTY property.

See Also:

• TLcdGML31SurfaceProperty

setBaseSurface

public void setBaseSurface(TLcdGML31AbstractSurface aValue)

Sets the value of the property that maps to the baseSurface element.

This property element either references a surface via the XLink-attributes or contains the surface element. A surface element is any element which is substitutable for "_Surface".

Parameters:

aValue - the value to set for the BASE_SURFACE_PROPERTY property.

getGid

public String getGid()

Gets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Returns:

the value of the GID_PROPERTY property.

setGid

public void setGid(String aValue)

Sets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Parameters:

aValue - the value to set for the GID_PROPERTY property.