com.esri.arcgis.geometry

Class Line

java.lang.Object

com.esri.arcgis.geometry.Line

All Implemented Interfaces:

IConstructLine, ICurve, ICurve2, ICurve3, ICurve3D, IGeometry, ILine, ILine2, ILine3, IProximityOperator, IProximityOperator3D, ISegment, ISegmentID, ISegmentM, ISegmentZ, ITransform2D, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, java.io.Serializable

public class Line
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILine, ILine2, ILine3, IGeometry, ITransform2D, ICurve, ICurve2, ICurve3, ISegment, IConstructLine, IProximityOperator, ISupportErrorInfo, IClone, ISegmentM, ISegmentZ, ISegmentID, ICurve3D, IProximityOperator3D

COM Class 'Line'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description 'A 2D straight line between a pair of 2D endpoints; can optionally have height, measure and ID attributes at each endpoint.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geometry.ILine3

IID, IID80dac471_f855_4934_884c_a812cf9a99ba, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ILine2

IIDa1d604a8_7914_4435_9b26_43e1ea5baa99

Fields inherited from interface com.esri.arcgis.geometry.ILine

IIDfea4c71c_c5ae_11d0_8307_0000f8034032

Fields inherited from interface com.esri.arcgis.geometry.ICurve

IID1b077916_38c5_11d0_92d2_00805f7c28b0

Fields inherited from interface com.esri.arcgis.geometry.IGeometry

IID1b07790d_38c5_11d0_92d2_00805f7c28b0

Fields inherited from interface com.esri.arcgis.geometry.ITransform2D

IID, IID3be78ad0_886e_11d1_bc78_0000f875bcce, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ICurve3

IID, IIDea7ab50b_1a9d_11d6_9fa9_00c04f6bdf0d, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ICurve2

IID058def33_2848_11d4_9f82_00c04f6bc8e8

Fields inherited from interface com.esri.arcgis.geometry.ISegment

IID, IIDf2c4f0de_c5ae_11d0_8307_0000f8034032, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IConstructLine

IID, IID199120b6_c677_11d0_8307_0000f8034032, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IProximityOperator

IID, IID1b07790f_38c5_11d0_92d2_00805f7c28b0, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ISegmentM

IID, IID48cf4c91_e3d5_11d2_9f2e_00c04f6bdf0d, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ISegmentZ

IID, IID61b43a4b_e3d5_11d2_9f2e_00c04f6bdf0d, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ISegmentID

IID, IID703052bd_25f1_11d3_9f3f_00c04f6bdf0d, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ICurve3D

IID, IIDac4d3da2_4b76_48dd_b393_2468452ca30d, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.IProximityOperator3D

IID, IID97e08cf7_7a24_4290_ba8a_acedb753b42c, xxDummy

Constructor Summary

Constructors

Constructor and Description
Line() Constructs a Line using ArcGIS Engine.
Line(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Line theLine = (Line) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
void	constructAngleBisector(IPoint from, IPoint through, IPoint to, double length, boolean useAcuteAngle) Constructs a line segment being the bisector through the angle defined by the three input points.
void	constructExtended(ILine inLine, int extendHow) Extends a line segment until one or both of its endpoints reaches the boundary of the domain of the line's associated spatial reference.
void	densify(int cInSlots, double maxDeviation, int[] pcOutSegments, ILine[] segments) Densify segment into the specified number of smaller segments.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	geographicShift(double splitLongitude) Shift longitudes to the right of splitLongitude.
void	geoNormalize() Shifts longitudes, if need be, into a continuous range of 360 degrees.
void	geoNormalizeFromLongitude(double longitude) Normalizes longitudes into a continuous range containing the longitude.
double	getAngle() The angle between this line and the positive x-axis.
static java.lang.String	getClsid() getClsid.
int	getDimension() The topological dimension of this geometry.
IEnvelope	getEnvelope() Creates a copy of this geometry's envelope and returns it.
IPoint	getFromPoint() The 'from' point of the curve.
int	getGeometryType() The type of this geometry.
void	getIDs(int[] fromID, int[] toID) Get the IDs on the segment's endpoints.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
double	getLength() The length of the curve.
double	getLength3D() The length of the curve.
void	getMs(double[] fromM, double[] toM) Get the Ms on the segment's endpoints.
ISpatialReference	getSpatialReference() The spatial reference associated with this geometry.
void	getSubcurve(double fromDistance, double toDistance, boolean asRatio, ICurve[] outSubcurve) Extracts a portion of this curve into a new curve.
void	getSubcurve3D(double fromDistance, double toDistance, boolean bAsRatio, ICurve3D[] ppOutSubCurve) Extracts a portion of this curve into a new curve.
IPoint	getToPoint() The 'to' point of the curve.
void	getZs(double[] fromZ, double[] toZ) Get the Zs on the segment's endpoints.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isClosed() Indicates if 'from' and 'to' points (of each part) are identical.
boolean	isClosed3D() Indicates if 'from' and 'to' points (of each part) are identical.
boolean	isEmpty() Indicates whether this geometry contains any points.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	move(double dx, double dy) Moves dx units horizontally and dy units vertically.
void	moveVector(ILine v) Moves a direction and distance v.
void	project(ISpatialReference newReferenceSystem) Projects this geometry into a new spatial reference.
void	putCoords(IPoint from, IPoint to) Sets this line's endpoints to be 'from' and 'to'.
void	putCoordsEx(IPoint from, IPoint to) Sets this segment's endpoints to 'from' and 'to'.
void	putWKSCoords(_WKSPoint from, _WKSPoint to) From and To become the new endpoints of this line.
void	queryCoords(IPoint from, IPoint to) Copies the endpoints of this line to 'from' and 'to'.
void	queryCurvature(double distanceAlongCurve, boolean asRatio, double[] curvature, ILine unitVector) Finds curvature and unit vector starting at point on segment and directed to embedded circle center.
void	queryEnvelope(IEnvelope outEnvelope) Copies this geometry's envelope properties into the specified envelope.
void	queryFromPoint(IPoint from) Copies this curve's 'from' point to the input point.
void	queryNearestPoint(IPoint p, int extension, IPoint nearest) Copies into 'nearest' a point on this geometry nearest to the input point.
void	queryNearestPoint3D(IPoint pInP, int extension, IPoint pNearest) Copies into 'nearest' a point on this geometry nearest to the input point.
void	queryNormal(int extension, double distanceAlongCurve, boolean asRatio, double length, ILine normal) Constructs a line normal to a curve from a point at a specified distance along the curve.
void	queryPoint(int extension, double distanceAlongCurve, boolean asRatio, IPoint outPoint) Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.
void	queryPoint3D(int extension, double distanceAlongCurve, boolean bAsRatio, IPoint pOutPoint) Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.
void	queryPointAndDistance(int extension, IPoint inPoint, boolean asRatio, IPoint outPoint, double[] distanceAlongCurve, double[] distanceFromCurve, boolean[] bRightSide) Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.
void	queryPointAndDistance3D(int extension, IPoint pInPoint, boolean bAsRatio, IPoint pOutPoint, double[] pDistanceAlongCurve, double[] pDistanceFromCurve) Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.
void	queryPointsAndDistances(int extension, double searchRadius, IPoint inPoint, boolean asRatio, double[] distanceFromCurve, IEnumPointAndDistance[] pointsAndDistances) Given an input point, calculates the minimum distance to the geometry and provides an enumerator over all closest points on the geometry, along with additional information.
void	queryTangent(int extension, double distanceAlongCurve, boolean asRatio, double length, ILine tangent) Constructs a line tangent to a curve from a point at a specified distance along the curve.
void	queryToPoint(IPoint to) Copies the curve's 'to' point into the input point.
void	queryWKSCoords(_WKSPoint[] from, _WKSPoint[] to) Returns the (x,y) coordinates of this line's endpoints.
void	release() Release this COM object reference
double	returnDistance(IGeometry other) Returns the minimum distance between two geometries.
double	returnDistance3D(IGeometry pOther) Returns the minimal distance between two geometries.
IPoint	returnNearestPoint(IPoint p, int extension) Creates and returns a point on this geometry nearest to the input point.
IPoint	returnNearestPoint3D(IPoint pInP, int extension) Creates and returns a point on this geometry nearest to the input point.
int	returnTurnDirection(ISegment otherSegment) Finds turn direction between two connected segments.
void	reverseOrientation() Reverses the parameterization of the curve ('from' point becomes 'to' point, first segment becomes last segment, etc).
void	rotate(IPoint origin, double rotationAngle) Rotates about the specified origin point.
void	scale(IPoint origin, double sx, double sy) Scales about the specified origin using seperate horizonal and vertical scales.
void	setEmpty() Removes all points from this geometry.
void	setFromPoint(IPoint from) The 'from' point of the curve.
void	setIDs(int fromID, int toID) Set the IDs on the segment's endpoints.
void	setMs(double fromM, double toM) Set the Ms on the segment's endpoints.
void	setSpatialReferenceByRef(ISpatialReference spatialRef) The spatial reference associated with this geometry.
void	setToPoint(IPoint to) The 'to' point of the curve.
void	setZs(double fromZ, double toZ) Set the Zs on the segment's endpoints.
void	snapToSpatialReference() Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.
void	splitAtDistance(double distances, boolean asRatio, ISegment[] fromSegment, ISegment[] toSegment) Split segment at specified distance.
void	splitAtDistance3D(double distances, boolean asRatio, ISegment[] fromSegment, ISegment[] toSegment) Split segment at specified distance.
void	splitDivideLength(double offset, double length, boolean asRatio, int[] numSplitSegments, ISegment splitSegments) Divide segment into smaller segments of the specified length.
void	transform(int direction, ITransformation transformation) Applies an arbitrary transformation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Line

public Line()
     throws java.io.IOException,
            java.net.UnknownHostException

Constructs a Line using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Line

public Line(java.lang.Object obj)
     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Line theLine = (Line) obj;

Construct a Line using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Line.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

putCoords

public void putCoords(IPoint from,
                      IPoint to)
               throws java.io.IOException,
                      AutomationException

Sets this line's endpoints to be 'from' and 'to'.

Specified by:

putCoords in interface ILine

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCoords

public void queryCoords(IPoint from,
                        IPoint to)
                 throws java.io.IOException,
                        AutomationException

Copies the endpoints of this line to 'from' and 'to'.

Specified by:

queryCoords in interface ILine

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException

The angle between this line and the positive x-axis.

Specified by:

getAngle in interface ILine

Returns:

The outAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

public double getLength()
                 throws java.io.IOException,
                        AutomationException

The length of the curve.

Specified by:

getLength in interface ICurve

Returns:

The length

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromPoint

public IPoint getFromPoint()
                    throws java.io.IOException,
                           AutomationException

The 'from' point of the curve.

Specified by:

getFromPoint in interface ICurve

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromPoint

public void setFromPoint(IPoint from)
                  throws java.io.IOException,
                         AutomationException

The 'from' point of the curve.

Specified by:

setFromPoint in interface ICurve

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryFromPoint

public void queryFromPoint(IPoint from)
                    throws java.io.IOException,
                           AutomationException

Copies this curve's 'from' point to the input point.

Specified by:

queryFromPoint in interface ICurve

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToPoint

public IPoint getToPoint()
                  throws java.io.IOException,
                         AutomationException

The 'to' point of the curve.

Specified by:

getToPoint in interface ICurve

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToPoint

public void setToPoint(IPoint to)
                throws java.io.IOException,
                       AutomationException

The 'to' point of the curve.

Specified by:

setToPoint in interface ICurve

Parameters:

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryToPoint

public void queryToPoint(IPoint to)
                  throws java.io.IOException,
                         AutomationException

Copies the curve's 'to' point into the input point.

Specified by:

queryToPoint in interface ICurve

Parameters:

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPoint

public void queryPoint(int extension,
                       double distanceAlongCurve,
                       boolean asRatio,
                       IPoint outPoint)
                throws java.io.IOException,
                       AutomationException

Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.

Specified by:

queryPoint in interface ICurve

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

distanceAlongCurve - The distanceAlongCurve (in)

asRatio - The asRatio (in)

outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPointAndDistance

public void queryPointAndDistance(int extension,
                                  IPoint inPoint,
                                  boolean asRatio,
                                  IPoint outPoint,
                                  double[] distanceAlongCurve,
                                  double[] distanceFromCurve,
                                  boolean[] bRightSide)
                           throws java.io.IOException,
                                  AutomationException

Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.

Specified by:

queryPointAndDistance in interface ICurve

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

inPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

asRatio - The asRatio (in)

outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

distanceAlongCurve - The distanceAlongCurve (in/out: use single element array)

distanceFromCurve - The distanceFromCurve (in/out: use single element array)

bRightSide - The bRightSide (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTangent

public void queryTangent(int extension,
                         double distanceAlongCurve,
                         boolean asRatio,
                         double length,
                         ILine tangent)
                  throws java.io.IOException,
                         AutomationException

Constructs a line tangent to a curve from a point at a specified distance along the curve.

Specified by:

queryTangent in interface ICurve

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

distanceAlongCurve - The distanceAlongCurve (in)

asRatio - The asRatio (in)

length - The length (in)

tangent - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryNormal

public void queryNormal(int extension,
                        double distanceAlongCurve,
                        boolean asRatio,
                        double length,
                        ILine normal)
                 throws java.io.IOException,
                        AutomationException

Constructs a line normal to a curve from a point at a specified distance along the curve.

Specified by:

queryNormal in interface ICurve

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

distanceAlongCurve - The distanceAlongCurve (in)

asRatio - The asRatio (in)

length - The length (in)

normal - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubcurve

public void getSubcurve(double fromDistance,
                        double toDistance,
                        boolean asRatio,
                        ICurve[] outSubcurve)
                 throws java.io.IOException,
                        AutomationException

Extracts a portion of this curve into a new curve.

Specified by:

getSubcurve in interface ICurve

Parameters:

fromDistance - The fromDistance (in)

toDistance - The toDistance (in)

asRatio - The asRatio (in)

outSubcurve - A reference to a com.esri.arcgis.geometry.ICurve (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reverseOrientation

public void reverseOrientation()
                        throws java.io.IOException,
                               AutomationException

Reverses the parameterization of the curve ('from' point becomes 'to' point, first segment becomes last segment, etc).

Specified by:

reverseOrientation in interface ICurve

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClosed

public boolean isClosed()
                 throws java.io.IOException,
                        AutomationException

Indicates if 'from' and 'to' points (of each part) are identical.

Specified by:

isClosed in interface ICurve

Returns:

The isClosed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws java.io.IOException,
                           AutomationException

The type of this geometry.

Specified by:

getGeometryType in interface IGeometry

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimension

public int getDimension()
                 throws java.io.IOException,
                        AutomationException

The topological dimension of this geometry.

Specified by:

getDimension in interface IGeometry

Returns:

A com.esri.arcgis.geometry.esriGeometryDimension constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference associated with this geometry.

Specified by:

getSpatialReference in interface IGeometry

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference associated with this geometry.

Specified by:

setSpatialReferenceByRef in interface IGeometry

Parameters:

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates whether this geometry contains any points.

Specified by:

isEmpty in interface IGeometry

Returns:

The isEmpty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

public void setEmpty()
              throws java.io.IOException,
                     AutomationException

Removes all points from this geometry.

Specified by:

setEmpty in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryEnvelope

public void queryEnvelope(IEnvelope outEnvelope)
                   throws java.io.IOException,
                          AutomationException

Copies this geometry's envelope properties into the specified envelope.

Specified by:

queryEnvelope in interface IGeometry

Parameters:

outEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvelope

public IEnvelope getEnvelope()
                      throws java.io.IOException,
                             AutomationException

Creates a copy of this geometry's envelope and returns it.

Specified by:

getEnvelope in interface IGeometry

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

project

public void project(ISpatialReference newReferenceSystem)
             throws java.io.IOException,
                    AutomationException

Projects this geometry into a new spatial reference.

Specified by:

project in interface IGeometry

Parameters:

newReferenceSystem - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snapToSpatialReference

public void snapToSpatialReference()
                            throws java.io.IOException,
                                   AutomationException

Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.

Specified by:

snapToSpatialReference in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geoNormalize

public void geoNormalize()
                  throws java.io.IOException,
                         AutomationException

Shifts longitudes, if need be, into a continuous range of 360 degrees.

Specified by:

geoNormalize in interface IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geoNormalizeFromLongitude

public void geoNormalizeFromLongitude(double longitude)
                               throws java.io.IOException,
                                      AutomationException

Normalizes longitudes into a continuous range containing the longitude. This method is obsolete.

Specified by:

geoNormalizeFromLongitude in interface IGeometry

Parameters:

longitude - The longitude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putWKSCoords

public void putWKSCoords(_WKSPoint from,
                         _WKSPoint to)
                  throws java.io.IOException,
                         AutomationException

From and To become the new endpoints of this line. Any existing attributes are deleted.

Specified by:

putWKSCoords in interface ILine2

Parameters:

from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryWKSCoords

public void queryWKSCoords(_WKSPoint[] from,
                           _WKSPoint[] to)
                    throws java.io.IOException,
                           AutomationException

Returns the (x,y) coordinates of this line's endpoints.

Specified by:

queryWKSCoords in interface ILine2

Parameters:

from - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

to - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

splitAtDistance3D

public void splitAtDistance3D(double distances,
                              boolean asRatio,
                              ISegment[] fromSegment,
                              ISegment[] toSegment)
                       throws java.io.IOException,
                              AutomationException

Split segment at specified distance.

Specified by:

splitAtDistance3D in interface ILine3

Parameters:

distances - The distances (in)

asRatio - The asRatio (in)

fromSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)

toSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public void move(double dx,
                 double dy)
          throws java.io.IOException,
                 AutomationException

Moves dx units horizontally and dy units vertically.

Specified by:

move in interface ITransform2D

Parameters:

dx - The dx (in)

dy - The dy (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveVector

public void moveVector(ILine v)
                throws java.io.IOException,
                       AutomationException

Moves a direction and distance v. v can be in a different spatial reference than the geometry being moved.

Specified by:

moveVector in interface ITransform2D

Parameters:

v - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scale

public void scale(IPoint origin,
                  double sx,
                  double sy)
           throws java.io.IOException,
                  AutomationException

Scales about the specified origin using seperate horizonal and vertical scales. The origin point can be in a different spatial reference than the geometry being scaled.

Specified by:

scale in interface ITransform2D

Parameters:

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

sx - The sx (in)

sy - The sy (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint origin,
                   double rotationAngle)
            throws java.io.IOException,
                   AutomationException

Rotates about the specified origin point. The angle is in radians. The origin can be in a different spatial reference than the geometry being rotated.

Specified by:

rotate in interface ITransform2D

Parameters:

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

rotationAngle - The rotationAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      ITransformation transformation)
               throws java.io.IOException,
                      AutomationException

Applies an arbitrary transformation. In particular, the transformation parameter can be either an affine transformation or a geographic transformation (datum shift).

Specified by:

transform in interface ITransform2D

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsEx

public void putCoordsEx(IPoint from,
                        IPoint to)
                 throws java.io.IOException,
                        AutomationException

Sets this segment's endpoints to 'from' and 'to'.

Specified by:

putCoordsEx in interface ICurve2

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPointsAndDistances

public void queryPointsAndDistances(int extension,
                                    double searchRadius,
                                    IPoint inPoint,
                                    boolean asRatio,
                                    double[] distanceFromCurve,
                                    IEnumPointAndDistance[] pointsAndDistances)
                             throws java.io.IOException,
                                    AutomationException

Given an input point, calculates the minimum distance to the geometry and provides an enumerator over all closest points on the geometry, along with additional information.

Specified by:

queryPointsAndDistances in interface ICurve3

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

searchRadius - The searchRadius (in)

inPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

asRatio - The asRatio (in)

distanceFromCurve - The distanceFromCurve (in/out: use single element array)

pointsAndDistances - A reference to a com.esri.arcgis.geometry.IEnumPointAndDistance (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCurvature

public void queryCurvature(double distanceAlongCurve,
                           boolean asRatio,
                           double[] curvature,
                           ILine unitVector)
                    throws java.io.IOException,
                           AutomationException

Finds curvature and unit vector starting at point on segment and directed to embedded circle center.

Specified by:

queryCurvature in interface ISegment

Parameters:

distanceAlongCurve - The distanceAlongCurve (in)

asRatio - The asRatio (in)

curvature - The curvature (out: use single element array)

unitVector - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnTurnDirection

public int returnTurnDirection(ISegment otherSegment)
                        throws java.io.IOException,
                               AutomationException

Finds turn direction between two connected segments.

Specified by:

returnTurnDirection in interface ISegment

Parameters:

otherSegment - A reference to a com.esri.arcgis.geometry.ISegment (in)

Returns:

The turnDirection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

splitAtDistance

public void splitAtDistance(double distances,
                            boolean asRatio,
                            ISegment[] fromSegment,
                            ISegment[] toSegment)
                     throws java.io.IOException,
                            AutomationException

Split segment at specified distance.

Specified by:

splitAtDistance in interface ISegment

Parameters:

distances - The distances (in)

asRatio - The asRatio (in)

fromSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)

toSegment - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

splitDivideLength

public void splitDivideLength(double offset,
                              double length,
                              boolean asRatio,
                              int[] numSplitSegments,
                              ISegment splitSegments)
                       throws java.io.IOException,
                              AutomationException

Divide segment into smaller segments of the specified length.

Specified by:

splitDivideLength in interface ISegment

Parameters:

offset - The offset (in)

length - The length (in)

asRatio - The asRatio (in)

numSplitSegments - The numSplitSegments (in)

splitSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

densify

public void densify(int cInSlots,
                    double maxDeviation,
                    int[] pcOutSegments,
                    ILine[] segments)
             throws java.io.IOException,
                    AutomationException

Densify segment into the specified number of smaller segments. This method is intended for internal use only.

Specified by:

densify in interface ISegment

Parameters:

cInSlots - The cInSlots (in)

maxDeviation - The maxDeviation (in)

pcOutSegments - The pcOutSegments (out: use single element array)

segments - A reference to a com.esri.arcgis.geometry.ILine (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geographicShift

public void geographicShift(double splitLongitude)
                     throws java.io.IOException,
                            AutomationException

Shift longitudes to the right of splitLongitude. This method is obsolete.

Specified by:

geographicShift in interface ISegment

Parameters:

splitLongitude - The splitLongitude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructAngleBisector

public void constructAngleBisector(IPoint from,
                                   IPoint through,
                                   IPoint to,
                                   double length,
                                   boolean useAcuteAngle)
                            throws java.io.IOException,
                                   AutomationException

Constructs a line segment being the bisector through the angle defined by the three input points.

Specified by:

constructAngleBisector in interface IConstructLine

Parameters:

from - A reference to a com.esri.arcgis.geometry.IPoint (in)

through - A reference to a com.esri.arcgis.geometry.IPoint (in)

to - A reference to a com.esri.arcgis.geometry.IPoint (in)

length - The length (in)

useAcuteAngle - The useAcuteAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructExtended

public void constructExtended(ILine inLine,
                              int extendHow)
                       throws java.io.IOException,
                              AutomationException

Extends a line segment until one or both of its endpoints reaches the boundary of the domain of the line's associated spatial reference.

Specified by:

constructExtended in interface IConstructLine

Parameters:

inLine - A reference to a com.esri.arcgis.geometry.ILine (in)

extendHow - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryNearestPoint

public void queryNearestPoint(IPoint p,
                              int extension,
                              IPoint nearest)
                       throws java.io.IOException,
                              AutomationException

Copies into 'nearest' a point on this geometry nearest to the input point.

Specified by:

queryNearestPoint in interface IProximityOperator

Parameters:

p - A reference to a com.esri.arcgis.geometry.IPoint (in)

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

nearest - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnNearestPoint

public IPoint returnNearestPoint(IPoint p,
                                 int extension)
                          throws java.io.IOException,
                                 AutomationException

Creates and returns a point on this geometry nearest to the input point.

Specified by:

returnNearestPoint in interface IProximityOperator

Parameters:

p - A reference to a com.esri.arcgis.geometry.IPoint (in)

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnDistance

public double returnDistance(IGeometry other)
                      throws java.io.IOException,
                             AutomationException

Returns the minimum distance between two geometries.

Specified by:

returnDistance in interface IProximityOperator

Parameters:

other - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMs

public void getMs(double[] fromM,
                  double[] toM)
           throws java.io.IOException,
                  AutomationException

Get the Ms on the segment's endpoints.

Specified by:

getMs in interface ISegmentM

Parameters:

fromM - The fromM (out: use single element array)

toM - The toM (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMs

public void setMs(double fromM,
                  double toM)
           throws java.io.IOException,
                  AutomationException

Set the Ms on the segment's endpoints.

Specified by:

setMs in interface ISegmentM

Parameters:

fromM - The fromM (in)

toM - The toM (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZs

public void getZs(double[] fromZ,
                  double[] toZ)
           throws java.io.IOException,
                  AutomationException

Get the Zs on the segment's endpoints.

Specified by:

getZs in interface ISegmentZ

Parameters:

fromZ - The fromZ (out: use single element array)

toZ - The toZ (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZs

public void setZs(double fromZ,
                  double toZ)
           throws java.io.IOException,
                  AutomationException

Set the Zs on the segment's endpoints.

Specified by:

setZs in interface ISegmentZ

Parameters:

fromZ - The fromZ (in)

toZ - The toZ (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDs

public void getIDs(int[] fromID,
                   int[] toID)
            throws java.io.IOException,
                   AutomationException

Get the IDs on the segment's endpoints.

Specified by:

getIDs in interface ISegmentID

Parameters:

fromID - The fromID (out: use single element array)

toID - The toID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIDs

public void setIDs(int fromID,
                   int toID)
            throws java.io.IOException,
                   AutomationException

Set the IDs on the segment's endpoints.

Specified by:

setIDs in interface ISegmentID

Parameters:

fromID - The fromID (in)

toID - The toID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength3D

public double getLength3D()
                   throws java.io.IOException,
                          AutomationException

The length of the curve.

Specified by:

getLength3D in interface ICurve3D

Returns:

The pLength

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPoint3D

public void queryPoint3D(int extension,
                         double distanceAlongCurve,
                         boolean bAsRatio,
                         IPoint pOutPoint)
                  throws java.io.IOException,
                         AutomationException

Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.

Specified by:

queryPoint3D in interface ICurve3D

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

distanceAlongCurve - The distanceAlongCurve (in)

bAsRatio - The bAsRatio (in)

pOutPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubcurve3D

public void getSubcurve3D(double fromDistance,
                          double toDistance,
                          boolean bAsRatio,
                          ICurve3D[] ppOutSubCurve)
                   throws java.io.IOException,
                          AutomationException

Extracts a portion of this curve into a new curve.

Specified by:

getSubcurve3D in interface ICurve3D

Parameters:

fromDistance - The fromDistance (in)

toDistance - The toDistance (in)

bAsRatio - The bAsRatio (in)

ppOutSubCurve - A reference to a com.esri.arcgis.geometry.ICurve3D (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPointAndDistance3D

public void queryPointAndDistance3D(int extension,
                                    IPoint pInPoint,
                                    boolean bAsRatio,
                                    IPoint pOutPoint,
                                    double[] pDistanceAlongCurve,
                                    double[] pDistanceFromCurve)
                             throws java.io.IOException,
                                    AutomationException

Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.

Specified by:

queryPointAndDistance3D in interface ICurve3D

Parameters:

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

pInPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

bAsRatio - The bAsRatio (in)

pOutPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

pDistanceAlongCurve - The pDistanceAlongCurve (in/out: use single element array)

pDistanceFromCurve - The pDistanceFromCurve (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClosed3D

public boolean isClosed3D()
                   throws java.io.IOException,
                          AutomationException

Indicates if 'from' and 'to' points (of each part) are identical.

Specified by:

isClosed3D in interface ICurve3D

Returns:

The isClosed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryNearestPoint3D

public void queryNearestPoint3D(IPoint pInP,
                                int extension,
                                IPoint pNearest)
                         throws java.io.IOException,
                                AutomationException

Copies into 'nearest' a point on this geometry nearest to the input point.

Specified by:

queryNearestPoint3D in interface IProximityOperator3D

Parameters:

pInP - A reference to a com.esri.arcgis.geometry.IPoint (in)

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

pNearest - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnNearestPoint3D

public IPoint returnNearestPoint3D(IPoint pInP,
                                   int extension)
                            throws java.io.IOException,
                                   AutomationException

Creates and returns a point on this geometry nearest to the input point.

Specified by:

returnNearestPoint3D in interface IProximityOperator3D

Parameters:

pInP - A reference to a com.esri.arcgis.geometry.IPoint (in)

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnDistance3D

public double returnDistance3D(IGeometry pOther)
                        throws java.io.IOException,
                               AutomationException

Returns the minimal distance between two geometries.

Specified by:

returnDistance3D in interface IProximityOperator3D

Parameters:

pOther - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The pDistance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.