CIP JAVA documentation for class "com.ptc.pfc.pfcGeometry.GeomCurve"

Interface GeomCurve

package com.ptc.pfc.pfcGeometry; public interface GeomCurve extends com.ptc.pfc.pfcObject.Object

Description

This class provides information for a geometry curve or edge.

Direct Known Subclasses:: Edge, Curve

Method Summary
`CurveXYZData`	`Eval3DData (double Param)` Returns a `CurveXYZData` object with information on the point represented by input parameter t.
`CurveXYZData`	`EvalFromLength (double StartParameter, double Length)` Returns a CURVEXYZData object with information on the point that is a specified distance from the starting point as specified by input parameter t.
`double`	`EvalLength ()` Finds the length of the specified edge.
`double`	`EvalLengthBetween (double Param1, double Param2)` Finds the length of the specified curve between two given parameters.
`double`	`EvalParameter (Point3D Point)` Finds the corresponding normalized parameter on the curve, given the XYZ point.
`CurveDescriptor`	`GetCurveDescriptor ()` This method returns a data object containing the geometry of the edge or curve.
`Feature`	`GetFeature ()` Returns the feature which contains the geometry.
`boolean`	`GetIsVisible ()` Get method for attribute "IsVisible" true if the geometry is visible and active, false if it is invisible and inactive. Inactive geometry may not have all geometric properties defined.
`BSplineDescriptor`	`GetNURBSRepresentation ()` This method returns the geometry of the edge or curve as a non-uniform rational B-spline curve.

Method Detail

GetIsVisible

boolean GetIsVisible ()

true if the geometry is visible and active, false if it is invisible and inactive. Inactive geometry may not have all geometric properties defined.

GetFeature

Feature GetFeature ()

Returns the feature which contains the geometry.

Returns:: The feature.

Eval3DData

CurveXYZData Eval3DData (double Param)

Returns a CurveXYZData object with information on the point represented by input parameter t.

If the curve is a composite curve,first derivative CurveXYZData.GetDerivative1(/*optional*/ Vector3D) and second derivative CurveXYZData.GetDerivative2(/*optional*/ Vector3D) are not accessible and will benull.

Exceptions thrown (but not limited to):

XToolkitNotImplemented - The argument p_curve represents a composite curve, while deriv1 or deriv2 is not NULL.

Manual References:: Geometry Evaluation: Evaluation of Curves and Edges, Geometry Evaluation: Evaluation of Curves and Edges

Parameters:

Param: The t parameter on the edge.

Returns:: The evaluation data, including the resulting point, the first and second derivatives, and the normal to the surface

EvalFromLength

CurveXYZData EvalFromLength (double StartParameter, double Length)

Returns a CURVEXYZData object with information on the point that is a specified distance from the starting point as specified by input parameter t.

Exceptions thrown (but not limited to):

XToolkitBadSrfCrv - The input argument is invalid.

Manual References:: Geometry Evaluation: Evaluation of Curves and Edges, Geometry Evaluation: Evaluation of Curves and Edges

Parameters:

StartParameter: The starting t parameter
Length: The distance from the starting parameter t to the resulting point

Returns:: The point at the specified distance from the starting parameter

EvalParameter

double EvalParameter (Point3D Point)

Finds the corresponding normalized parameter on the curve, given the XYZ point.

Manual References:: Geometry Evaluation: Evaluation of Curves and Edges, Geometry Evaluation: Evaluation of Curves and Edges

Parameters:

Point: The XYZ point. The point does not need to lie on the curve.If the point is not on the curve, the function finds the closest curve point.

Returns:: The t parameter that represents the input Point3D object.

EvalLength

double EvalLength ()

Finds the length of the specified edge.

Manual References:: Geometry Evaluation: Evaluation of Curves and Edges, Geometry Evaluation: Evaluation of Curves and Edges

Returns:: The edge length

EvalLengthBetween

double EvalLengthBetween (double Param1, double Param2)

Finds the length of the specified curve between two given parameters.

Exceptions thrown (but not limited to):

XToolkitBadSrfCrv - The input argument is invalid.

Manual References:: Geometry Evaluation: Evaluation of Curves and Edges, Geometry Evaluation: Evaluation of Curves and Edges

Parameters:

Param1: The start t parameter
Param2: The end t parameter

Returns:: The curve length between the parameters.

GetCurveDescriptor

CurveDescriptor GetCurveDescriptor ()

This method returns a data object containing the geometry of the edge or curve.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The specified data is not a composite curve data structure.

Manual References:: Geometry Evaluation: Curve Descriptors, Geometry Evaluation: Curve Descriptors, Geometry Evaluation: Curve Descriptors

Returns:: The edge or curve geometry

GetNURBSRepresentation

BSplineDescriptor GetNURBSRepresentation ()

This method returns the geometry of the edge or curve as a non-uniform rational B-spline curve.

Manual References:: Geometry Evaluation: Curve Descriptors, Geometry Evaluation: Curve Descriptors

Returns:: The B-spline curve geometry