com.esri.arcgis.editor
Interface IDimensionConstructor

All Superinterfaces:

Serializable

All Known Implementing Classes:

AlignedConstructor, FreeAlignedConstructor, FreeLinearConstructor, IDimensionConstructorProxy, LinearConstructor, RotatedLinearConstructor, SimpleAlignedConstructor

public interface IDimensionConstructor
extends Serializable

Provides access to members that control the dimension feature edit sketch constructor.

Remarks

Dimension Constructors provide specialized behavior for creating new dimension features. All dimension constructors implement the IDimensionConstructor interface and are registered in the ESRI Dimension Constructors component category.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addFeedbackPoint(IPoint point) Adds a point to the display feedback.
void	constructDimension(IDimensionFeature feature, IGeometry geometry, IDimensionStyle style) Creates the dimension shape for a dimension feature given the geometry constructed in the dimension constructor.
IDisplayFeedback	createFeedback() The display feedback for the constructor.
int	getDimensionType() The type of dimension created with the dimension constructor.
String	getName() Name of the dimension constructor.
int	getSketchGeometryType() The type of geometry used for the edit sketch constructor.
boolean	isCanFinish(IGeometry sketchGeometry) Indicates if the dimension feature can be constructed given the number of points in the edit sketch.
boolean	isHasFeedback() Indicates if the constructor will use a custom feedback.
void	shutdown() The constructor start event.
void	startFeedback(IPoint point, IDimensionStyle style) Starts the display feedback for the dimension constructor.
void	startFeedbackFromShape(IGeometry shape, IDimensionStyle style) Starts the display feedback for the dimension constructor from an existing geometry.
void	startup(IDimensionEditExtension extension) The dimension editor extension.
void	stopFeedback() Stops the display feedback.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the dimension constructor.

Remarks

Returns the name of the dimension constructor. This is the name listed in the Dimension Constructors control on the Dimensioning toolbar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

int getSketchGeometryType()
                          throws IOException,
                                 AutomationException

The type of geometry used for the edit sketch constructor.

Remarks

Returns the geometry type of the dimension constructor used for the sketch geometry. Most of the standard dimension constructors use esriGeometryMultipoint.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionType

int getDimensionType()
                     throws IOException,
                            AutomationException

The type of dimension created with the dimension constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.carto.esriDimensionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanFinish

boolean isCanFinish(IGeometry sketchGeometry)
                    throws IOException,
                           AutomationException

Indicates if the dimension feature can be constructed given the number of points in the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

Returns:

The canFinish

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructDimension

void constructDimension(IDimensionFeature feature,
                        IGeometry geometry,
                        IDimensionStyle style)
                        throws IOException,
                               AutomationException

Creates the dimension shape for a dimension feature given the geometry constructed in the dimension constructor.

Remarks

When IDimensionConstructor::CanFinish returns True ConstructDimension is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

feature - A reference to a com.esri.arcgis.carto.IDimensionFeature (in)

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

style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

void startup(IDimensionEditExtension extension)
             throws IOException,
                    AutomationException

The dimension editor extension.

Remarks

Startup is called when the constructor is instantiated by the DimensionEditExtension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

extension - A reference to a com.esri.arcgis.editor.IDimensionEditExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

void shutdown()
              throws IOException,
                     AutomationException

The constructor start event.

Remarks

Shutdown is called when the DimensionEditExtension's destructor is called, typically when ArcMap is shut down.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeedback

IDisplayFeedback createFeedback()
                                throws IOException,
                                       AutomationException

The display feedback for the constructor.

Remarks

When implementing IDimensionConstructor CreateFeedback is where the chosen feedback object should be instantiated and the necessary properties of the feedback object are set. For example, you should set the DimensionType and ReferenceScale, and ReferenceUnits values on the feedback object at this time.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.IDisplayFeedback

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startFeedback

void startFeedback(IPoint point,
                   IDimensionStyle style)
                   throws IOException,
                          AutomationException

Starts the display feedback for the dimension constructor.

Remarks

StartFeedback will start the display of the feedback object when the first point is added to the edit sketch. All properties required by the feedback object should be specified at this point and the feedback should be started.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFeedbackPoint

void addFeedbackPoint(IPoint point)
                      throws IOException,
                             AutomationException

Adds a point to the display feedback.

Remarks

When the first point is added StartFeedbackFromShape is called. For all subsequent points that are added AddFeedbackPoint is called. The point can be used to update the feedback if desired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopFeedback

void stopFeedback()
                  throws IOException,
                         AutomationException

Stops the display feedback.

Remarks

StopFeedback will stop the display feedback. StopFeedback is automatically called when IDimensionConstructor::CanFinish returns True. At this time you should stop the DimensionFeedback object and dereference it. If desired you can use the IDimensionShape returned from INewDimensionFeedback::Stop as the basis for constructing the dimension feature. ConstructDimension is called immediately follwing StopFeedback.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasFeedback

boolean isHasFeedback()
                      throws IOException,
                             AutomationException

Indicates if the constructor will use a custom feedback.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hasFeedback

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startFeedbackFromShape

void startFeedbackFromShape(IGeometry shape,
                            IDimensionStyle style)
                            throws IOException,
                                   AutomationException

Starts the display feedback for the dimension constructor from an existing geometry.

Remarks

StartFeedbackFromShape is called when the first point is added to the edit sketch. The input geometry should be used to add all the points in the sketchGeometry to the DimensionFeedback object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.