com.esri.arcgis.geometry
Class IPointProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geometry.IGeometryProxy
          com.esri.arcgis.geometry.IPointProxy

All Implemented Interfaces:

java.io.Externalizable, IGeometry, IPoint, java.io.Serializable

public class IPointProxy

extends IGeometryProxy

implements IPoint, java.io.Serializable

Provides access to members that define two dimensional points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IPointProxy() For internal use only
	IPointProxy(java.lang.Object obj)
protected	IPointProxy(java.lang.Object obj, java.lang.String iid)
	IPointProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IPointProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
int	compare(IPoint otherPoint) Compares X, Y, M, Z, ID of this point (in that order) with that of the other point.
void	constrainAngle(double constraintAngle, IPoint anchor, boolean allowOpposite) Projects this point to the point on the infinite line defined by anchor and angle (in radians).
void	constrainDistance(double constraintRadius, IPoint anchor) Projects this point to the perimeter of the circle defined by radius and anchor.
int	getID() The Point ID attribute.
double	getM() The measure attribute.
double	getX() The X coordinate.
double	getY() The Y coordinate.
double	getZ() The Z attribute.
void	putCoords(double x, double y) Sets the X and Y coordinates.
void	queryCoords(double[] x, double[] y) Returns the X and Y coordinates.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setID(int pointID) The Point ID attribute.
void	setM(double m) The measure attribute.
void	setX(double x) The X coordinate.
void	setY(double y) The Y coordinate.
void	setZ(double z) The Z attribute.

Methods inherited from class com.esri.arcgis.geometry.IGeometryProxy

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

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

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IPointProxy

public IPointProxy(java.lang.String CLSID,
                   java.lang.String host,
                   AuthInfo authInfo)
            throws java.net.UnknownHostException,
                   java.io.IOException

IPointProxy

public IPointProxy()

For internal use only

IPointProxy

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

IPointProxy

protected IPointProxy(java.lang.Object obj,
                      java.lang.String iid)
               throws java.io.IOException

IPointProxy

protected IPointProxy(java.lang.String CLSID,
                      java.lang.String iid,
                      java.lang.String host,
                      AuthInfo authInfo)
               throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class IGeometryProxy

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class IGeometryProxy

Throws:

java.io.IOException

queryCoords

public void queryCoords(double[] x,
                        double[] y)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IPoint

Returns the X and Y coordinates.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryCoords in interface IPoint

Parameters:

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

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

putCoords

public void putCoords(double x,
                      double y)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IPoint

Sets the X and Y coordinates.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the IPoint::PutCoords method to set the X,Y coordinates for a Point. The coordinates can also be set by updating the X and Y properties for the point.

Specified by:

putCoords in interface IPoint

Parameters:

x - The x (in)

y - The y (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getX

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

Description copied from interface: IPoint

The X coordinate.

Supported Platforms

Windows, Solaris, Linux

Description

Returns and Sets the X coordinate of the Point. The X coordinate is the horizontal position of the point.

Specified by:

getX in interface IPoint

Returns:

The x

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setX

public void setX(double x)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPoint

The X coordinate.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setX in interface IPoint

Parameters:

x - The x (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getY

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

Description copied from interface: IPoint

The Y coordinate.

Supported Platforms

Windows, Solaris, Linux

Description

Returns and Sets the Y coordinate of the Point. The Y coordinate is the vertical position of the point.

Remarks

Specified by:

getY in interface IPoint

Returns:

The y

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setY

public void setY(double y)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPoint

The Y coordinate.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setY in interface IPoint

Parameters:

y - The y (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getZ

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

Description copied from interface: IPoint

The Z attribute.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or Sets the Z attribute on the Point. Although the Z attribute refers to the 3-Dimensional depth of the point, the point still spatially exists in only 2-Dimensions with a Z attribute. Further, the point must be ZAware to make use of the Z attribute.

Specified by:

getZ in interface IPoint

Returns:

The z

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IZ

setZ

public void setZ(double z)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPoint

The Z attribute.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZ in interface IPoint

Parameters:

z - The z (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getM

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

Description copied from interface: IPoint

The measure attribute.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or Sets the M attribute on the Point. The M attribute refers to the Point's measure (similar to an address). The point must be MAware to make use of the M attribute.

Remarks

Specified by:

getM in interface IPoint

Returns:

The m

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setM

public void setM(double m)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPoint

The measure attribute.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setM in interface IPoint

Parameters:

m - The m (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getID

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

Description copied from interface: IPoint

The Point ID attribute.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or Sets the ID attribute of the Point. The ID attribute is a numeric label, but does not serve any computational purposes. The Point must be PointIDAware to make use of the ID attribute.

Remarks

To set the ID value for a point you need to define it to be ID aware.

Specified by:

getID in interface IPoint

Returns:

The pointID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int pointID)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IPoint

The Point ID attribute.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface IPoint

Parameters:

pointID - The pointID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

constrainDistance

public void constrainDistance(double constraintRadius,
                              IPoint anchor)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IPoint

Projects this point to the perimeter of the circle defined by radius and anchor.

Supported Platforms

Windows, Solaris, Linux

Description

Sets the base Point to a location a specified distance from the input anchor Point along the line between the two points. ConstrainDistance is used by the editor to fix the distance between an anchor point and an input Point. Thus, the input to be created must lie on the circumference defined by the anchor point and the fixed distance radius with the angle determined by the user.

Remarks

ConstrainDistance

Specified by:

constrainDistance in interface IPoint

Parameters:

constraintRadius - The constraintRadius (in)

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

constrainAngle

public void constrainAngle(double constraintAngle,
                           IPoint anchor,
                           boolean allowOpposite)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IPoint

Projects this point to the point on the infinite line defined by anchor and angle (in radians). If allowOpposite is true, then the point can also snap to angle + pi radians.

Supported Platforms

Windows, Solaris, Linux

Description

Projects the base Point to to the nearest point on the line defined by an input anchor point and input angle. ConstrainAngle is used by the editor to force a newly created Point to be on the line between a fixed point and a specified angle.

Remarks

ContrainAngle

Specified by:

constrainAngle in interface IPoint

Parameters:

constraintAngle - The constraintAngle (in)

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

allowOpposite - The allowOpposite (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

compare

public int compare(IPoint otherPoint)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IPoint

Compares X, Y, M, Z, ID of this point (in that order) with that of the other point. Returns -1 if this point's value is less, 1 if greater, and 0 otherwise. Useful for sorting a group of points.

Supported Platforms

Windows, Solaris, Linux

Description

Compares the location and attributes of the base point with those of the input point to determine a relative ordering of the two points. Compares point properties in the following order: X, Y, M, Z, and ID. Returns 1 if the base point possesses the first greater property, and returns -1 if the input point possesses the first greater property. This method takes the resolution of the spatial reference into account.

Remarks

The method should not be used in order to determine equality of two points. Use IRelationalOperator::Equals or IClone::IsEqual. At 9.2, this method uses the resolution property of the point's spatial reference in order to determine (x,y) coordinate ordering. At 9.1, an untoleranced (exact) comparison was performed.

Specified by:

compare in interface IPoint

Parameters:

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

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.