com.esri.arcgis.editor
Class DigitizerExtension

java.lang.Object
  com.esri.arcgis.editor.DigitizerExtension

All Implemented Interfaces:

IDigitizerButtons, IDigitizerSetup, com.esri.arcgis.interop.RemoteObjRef, IExtension, Serializable

public class DigitizerExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtension, IDigitizerSetup, IDigitizerButtons

Extension for working with the digitizer.

Remarks

The DigitizerExtension connects a digitizing board and puck with ArcMap. This object is primarily responsible for the transformation between digitizing space and map space. After a transformation has been established, the location of the puck directly correlates to a location on the focus map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Field Summary

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

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Constructor Summary

DigitizerExtension(Object obj)
Construct a DigitizerExtension using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addControlPoint(double xDigitizer, double yDigitizer, double xMap, double yMap) Adds a control point to the transformation.
void	clearControlPoints() Removes all control points.
boolean	equals(Object o) Compare this object with another
IUID	getButton(int button) Button to map on the digitizer puck.
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.
String	getName() The name of the extension.
ITransformation	getTransformation() The transformation used by the digitizer.
int	hashCode() the hashcode for this object
void	setButton(int button, IUID cmdID) Button to map on the digitizer puck.
void	setTransformationByRef(ITransformation transform) The transformation used by the digitizer.
void	shutdown() Shuts down the extension.
void	startup(Object initializationData) Starts up the extension with the given initialization data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DigitizerExtension

public DigitizerExtension(Object obj)
                   throws IOException

Construct a DigitizerExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DigitizerExtension.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DigitizerExtension o = (DigitizerExtension)obj; // will not work

DigitizerExtension o = new DigitizerExtension(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems DigitizerExtension theDigitizerExtension = (DigitizerExtension) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(Object initializationData)
             throws IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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

setButton

public void setButton(int button,
                      IUID cmdID)
               throws IOException,
                      AutomationException

Button to map on the digitizer puck.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setButton in interface IDigitizerButtons

Parameters:

button - The button (in)

cmdID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getButton

public IUID getButton(int button)
               throws IOException,
                      AutomationException

Button to map on the digitizer puck.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getButton in interface IDigitizerButtons

Parameters:

button - The button (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.