GetClosestPointOn Method (IEllipseArc)

GetClosestPointOn Method (IEllipseArc) | Send Feedback
See Also

GivenPointX
  x coordinate of the point

GivenPointY
  y coordinate of the point

GivenPointZ
  z coordinate of the point

Extend
  True to extend the curve to the point on the elliptical Arc that is closest to the specified point, false to not

PointOnCurveX[out]
  x coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point

PointOnCurveY[out]
  y coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point

PointOnCurveZ[out]
  z coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point

Gets the point on the Ellipse or elliptical Arc that is closest to the specified point.

# Syntax

Visual Basic |
--- | ---
    Sub GetClosestPointOn( _
       ByVal GivenPointX As System.Double, _
       ByVal GivenPointY As System.Double, _
       ByVal GivenPointZ As System.Double, _
       ByVal Extend As System.Boolean, _
       ByRef PointOnCurveX As System.Double, _
       ByRef PointOnCurveY As System.Double, _
       ByRef PointOnCurveZ As System.Double _
    )

C# |
--- | ---
    void GetClosestPointOn(
       System.double GivenPointX,
       System.double GivenPointY,
       System.double GivenPointZ,
       System.bool Extend,
       out System.double PointOnCurveX,
       out System.double PointOnCurveY,
       out System.double PointOnCurveZ
    )

JavaScript |
--- | ---
    GetClosestPointOn(
       GivenPointX : Number,
       GivenPointY : Number,
       GivenPointZ : Number,
       Extend : Boolean
    ) : {
       PointOnCurveX : Number,
       PointOnCurveY : Number,
       PointOnCurveZ : Number
    }

COM native C++ |
--- | ---
    HRESULT GetClosestPointOn(
       DOUBLE GivenPointX,
       DOUBLE GivenPointY,
       DOUBLE GivenPointZ,
       VARIANT_BOOL Extend,
       DOUBLE* PointOnCurveX,
       DOUBLE* PointOnCurveY,
       DOUBLE* PointOnCurveZ
    )

C++ |
--- | ---
    DSRESULT GetClosestPointOn(
       double GivenPointX,
       double GivenPointY,
       double GivenPointZ,
       bool Extend,
       double* PointOnCurveX,
       double* PointOnCurveY,
       double* PointOnCurveZ
    )

#### Parameters

GivenPointX
  x coordinate of the point
GivenPointY
  y coordinate of the point
GivenPointZ
  z coordinate of the point
Extend
  True to extend the curve to the point on the elliptical Arc that is closest to the specified point, false to not
PointOnCurveX[out]
  x coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point
PointOnCurveY[out]
  y coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point
PointOnCurveZ[out] or Return Value
  z coordinate of the point on the Ellipse or elliptical Arc that is closest to the specified point

# See Also

####

IEllipseArc Interface
IEllipseArc Members
IEllipseArc::EvaluateAtDistance Method
IEllipseArc::EvaluateAtParameter Method
IEllipseArc::EvaluateAtPoint Method
IEllipseArc::GetEndParams Method
IEllipseArc::GetLength Method

# Availability

DraftSight V1R1.3