com.esri.arcgis.geometry
Interface IConstructEllipticArc

All Superinterfaces:

Serializable

All Known Implementing Classes:

EllipticArc

public interface IConstructEllipticArc
extends Serializable

Provides access to members that construct an elliptic arc segment using other geometries and measures.

Description

IConstructEllipticArc contains methods for constructing Full EllipticArcs, Quarter EllipticArcs, suggested EllipticArcs, and general EllipticArcs. Only ConstructUpToFivePoints can construct a rotated EllipticArc. All other EllipticArcs are unrotated (or rotated by Pi/2).

Product Availability

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

Method Summary

void	constructEnvelope(IEnvelope boundingEnvelope) Constructs the inscribed ellipse of the given envelope.
void	constructQuarterEllipse(IPoint fromPoint, IPoint toPoint, boolean cCW) Construct an elliptic arc that starts at fromPoint, goes to toPoint, and spans an angle of pi/2.
void	constructTwoPointsEnvelope(IPoint fromPoint, IPoint toPoint, IEnvelope suggestedEnvelope, int orientation) Construct an elliptic arc that starts at fromPoint, goes to toPoint, and tries to have the embedded ellipse inscribed in the suggestedEnvelope.
void	constructUpToFivePoints(IPoint from, IPoint to, IPoint thru, IPoint point4, IPoint point5) Constructs an elliptic arc, given up to 5 points, such that the embedded ellipse passes through as many as possible.

Method Detail

constructEnvelope

void constructEnvelope(IEnvelope boundingEnvelope)
                       throws IOException,
                              AutomationException

Constructs the inscribed ellipse of the given envelope. The ellipse is oriented counterclockwise.

Description

ConstructEnvelope creates an EllipticArc from a given Envelope. The constructed EllipticArc is the full EllipticArc that has the given Envelope as its Envelope. The EllipticArc has a Major Axis equal to the larger of the Width and Height, and the Minor Axis equal to the smaller of the Width and Height. The CenterPoint of the EllipticArc is the CenterPoint of the Envelope.

Remarks

The method ignores the Z values of the given envelope and therefore the output elliptic arc is 2D.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructUpToFivePoints

void constructUpToFivePoints(IPoint from,
                             IPoint to,
                             IPoint thru,
                             IPoint point4,
                             IPoint point5)
                             throws IOException,
                                    AutomationException

Constructs an elliptic arc, given up to 5 points, such that the embedded ellipse passes through as many as possible. The arc will start at the first point and end at the second, passing through the third.

Description

Constructs an EllipticArc using as many of the zero to five input points as possible. The first input point is always the From Point of the constructed EllipticArc. The second input point is always the To Point of the constructed EllipticArc. The third point is the Thru Point of the EllipticArc and is always guaranteed to lie on the constructed EllipticArc. The fourth and fifth points may lie on either the constructed EllipticArc or the embedded extension of the EllipticArc. The first three input points are guaranteed to be used in the construction of the EllipticArc. The fourth and fifth points are used in preferential order as long as they do not create an invalid EllipticArc. All points used to construct an EllipticArc must lie on a Convex Hull, otherwise the fourth or fifth non-convex points are discarded to maintain convexity. Zero input points defines an empty EllipticArc. One input point defines a degenerate IsPoint EllipticArc. Two disjoint input points uniquely define a degenerate IsLine EllipticArc with the points at the end of the semiMajor axis with a Minor/Major Ratio of 0. Three non-colinear input points uniquely define an IsCircular EllipticArc in the same manner as ConstructThreePoints constructs a CircularArc. Four input points on a convex hull may be sufficient to uniquely define an unrotated (or Pi / 2 rotated) EllipticArc. For cases where an unrotated EllipticArc cannot be fit to the input points, a reasonable rotated EllipticArc is constructed to fit the input points (this EllipticArc is not the only rotated EllipticArc that can be fit to the input points.).

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

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

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

point5 - 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.

constructQuarterEllipse

void constructQuarterEllipse(IPoint fromPoint,
                             IPoint toPoint,
                             boolean cCW)
                             throws IOException,
                                    AutomationException

Construct an elliptic arc that starts at fromPoint, goes to toPoint, and spans an angle of pi/2. The rotation of the ellipse will be either 0 or pi/2.

Description

ConstructQuarterEllipse constructs a quarter EllipticArc between a given From Point and To Point with the desired orientation. The From Point and the To Point lie on the ends of the EllipticArc Axes. The constructed quarter Ellipse can be thought of as being the EllipticArc within the envelope defined by the From Point and To Point with a semiMajor axis equal to the longer side of the envelope and a semiMinor axis equal to the shorter side of the envelope.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

cCW - The cCW (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructTwoPointsEnvelope

void constructTwoPointsEnvelope(IPoint fromPoint,
                                IPoint toPoint,
                                IEnvelope suggestedEnvelope,
                                int orientation)
                                throws IOException,
                                       AutomationException

Construct an elliptic arc that starts at fromPoint, goes to toPoint, and tries to have the embedded ellipse inscribed in the suggestedEnvelope. The result will have rotation of 0 or pi/2.

Description

ConstructTwoPointsEnvelope constructs an EllipticArc given the From and To Points and a suggested Envelope as input. The constructed EllipticArc has characteristics similar to the full ellipse defined by the input Envelope. The final EllipticArc may vary slightly from the input Envelope depending on how well the input Points fit the suggested EllipticArc.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

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

orientation - A com.esri.arcgis.geometry.esriArcOrientation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.