com.esri.arcgis.editor
Class IDigitizerSetupProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.editor.IDigitizerSetupProxy
All Implemented Interfaces:
IDigitizerSetup, Externalizable, Serializable

public class IDigitizerSetupProxy
extends com.esri.arcgis.interop.Dispatch
implements IDigitizerSetup, Serializable

Provides access to members that define the transformation used by the digitizer.

Remarks

The IDigitizerSetup uses an affine transformation to transform digitizer coordinates to map units. The transformation is based on control points.

The affine transformation can differentially scale, skew, rotate and translate your data. Using the Transformation method located on the IDigitizerSetup interface you can control the parameters used to perform these affine functions.

When To Use

The IDigitizerSetup object can be used to modify the transformation properties used when transforming digitizer coordinates to map units using control points defined using the Editor.


Product Availability

Available with ArcGIS Desktop.

See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties, Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IDigitizerSetupProxy()
           
  IDigitizerSetupProxy(Object obj)
           
protected IDigitizerSetupProxy(Object obj, String iid)
           
 
Method Summary
 void addControlPoint(double xDigitizer, double yDigitizer, double xMap, double yMap)
          Adds a control point to the transformation.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clearControlPoints()
          Removes all control points.
 void getControlPoint(int index, double[] xDigitizer, double[] yDigitizer, double[] xMap, double[] yMap)
          A control point's X,Y coordinates in Digitizer and Map units.
 int getControlPointCount()
          The number of control points used for digitizing.
 ITransformation getTransformation()
          The transformation used by the digitizer.
 void removeListener(String iidStr, Object theListener)
           
 void setTransformationByRef(ITransformation transform)
          The transformation used by the digitizer.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

IDigitizerSetupProxy

public IDigitizerSetupProxy()

IDigitizerSetupProxy

public IDigitizerSetupProxy(Object obj)
                     throws IOException
Throws:
IOException

IDigitizerSetupProxy

protected IDigitizerSetupProxy(Object obj,
                               String iid)
                        throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setTransformationByRef

public void setTransformationByRef(ITransformation transform)
                            throws IOException,
                                   AutomationException
The transformation used by the digitizer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setTransformationByRef in interface IDigitizerSetup
Parameters:
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransformation

public ITransformation getTransformation()
                                  throws IOException,
                                         AutomationException
The transformation used by the digitizer.

Remarks

Use the Transformation property to customize the transformation of your data from digitizer units to map units.

Transformation uses the AffineTransformation2D CoClass to move, rotate, scale and transform coordinates.

Refer to the IAffineTransformation2D interface documentation for more information about the affine transformation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getTransformation in interface IDigitizerSetup
Returns:
A reference to a com.esri.arcgis.geometry.ITransformation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties

getControlPointCount

public int getControlPointCount()
                         throws IOException,
                                AutomationException
The number of control points used for digitizing.

Remarks

Use the ControlPointCount property to find out how many transformation points have been added.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getControlPointCount in interface IDigitizerSetup
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties

clearControlPoints

public void clearControlPoints()
                        throws IOException,
                               AutomationException
Removes all control points.

Remarks

Use the ClearControlPoints property to clear all stored control points added. You can find out how many control points exist using the ControlPointCount property. You can also get existing control points using the GetControlPoint property or add new ones using the AddControlPoint method.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
clearControlPoints in interface IDigitizerSetup
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties

getControlPoint

public void getControlPoint(int index,
                            double[] xDigitizer,
                            double[] yDigitizer,
                            double[] xMap,
                            double[] yMap)
                     throws IOException,
                            AutomationException
A control point's X,Y coordinates in Digitizer and Map units.

Remarks

Use the GetControlPoint property to retrieve the transformation point using an x and y value.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getControlPoint in interface IDigitizerSetup
Parameters:
index - The index (in)
xDigitizer - The xDigitizer (out: use single element array)
yDigitizer - The yDigitizer (out: use single element array)
xMap - The xMap (out: use single element array)
yMap - The yMap (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties

addControlPoint

public void addControlPoint(double xDigitizer,
                            double yDigitizer,
                            double xMap,
                            double yMap)
                     throws IOException,
                            AutomationException
Adds a control point to the transformation.

Remarks

Use the AddControlPoint method to create a transformation point using digitizer x and y values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
addControlPoint in interface IDigitizerSetup
Parameters:
xDigitizer - The xDigitizer (in)
yDigitizer - The yDigitizer (in)
xMap - The xMap (in)
yMap - The yMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IDigitizerButtons, ITransformation, IEditAttributeProperties