CIP C++ documentation for class "pfcGeomCurve"

Class pfcGeomCurve

# include <pfcGeometry.h> class pfcGeomCurve : public virtual pfcObject { xaideclare(pfcGeomCurve) ... };

Description

This class provides information for a geometry curve or edge.

Manual References:: Geometry Evaluation: Curve and Edge Types, Geometry Evaluation: Evaluation of Curves and Edges

Direct Known Subclasses:: pfcEdge, pfcCurve

Method Summary


`pfcCurveXYZData_ptr`	`Eval3DData (xreal Param)`
	This method is enabled for Creo Direct. Returns a `pfcCurveXYZData` object with information on the point represented by input parameter t.

`pfcCurveXYZData_ptr`	`EvalFromLength (xreal StartParameter, xreal Length)`
	This method is enabled for Creo Direct. Returns a CURVEXYZData object with information on the point that is a specified distance from the starting point as specified by input parameter t.

`xreal`	`EvalLength ()`
	This method is enabled for Creo Direct. Finds the length of the specified edge.

`xreal`	`EvalLengthBetween (xreal Param1, xreal Param2)`
	This method is enabled for Creo Direct. Finds the length of the specified curve between two given parameters.

`xreal`	`EvalParameter (pfcPoint3D_ptr Point)`
	This method is enabled for Creo Direct. Finds the corresponding normalized parameter on the curve, given the XYZ point.

`pfcCurveDescriptor_ptr`	`GetCurveDescriptor ()`
	This method is enabled for Creo Direct. This method returns a data object containing the geometry of the edge or curve.

`pfcFeature_ptr`	`GetFeature ()`
	Returns the feature which contains the geometry.

`xbool`	`GetIsVisible ()`
	This method is enabled for Creo Direct. true if the geometry is visible and active, false if it is invisible and inactive. Inactive geometry may not have all geometric properties defined.

`pfcBSplineDescriptor_ptr`	`GetNURBSRepresentation ()`
	This method returns the geometry of the edge or curve as a non-uniform rational B-spline curve.

Method Detail

xbool GetIsVisible ()

This method is enabled for Creo Direct.

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

pfcFeature_ptr GetFeature ()

Returns the feature which contains the geometry.

Returns:: The feature.

pfcCurveXYZData_ptr Eval3DData (xreal Param)

This method is enabled for Creo Direct.

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

If the curve is a composite curve,first derivative pfcCurveXYZData::GetDerivative1(optional pfcVector3D_ptr) and second derivative pfcCurveXYZData::GetDerivative2(optional pfcVector3D_ptr) are not accessible and will benull.

Exceptions thrown (but not limited to):

pfcXToolkitNotImplemented - 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

pfcCurveXYZData_ptr EvalFromLength (xreal StartParameter, xreal Length)

This method is enabled for Creo Direct.

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):

pfcXToolkitBadSrfCrv - 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

xreal EvalParameter (pfcPoint3D_ptr Point)

This method is enabled for Creo Direct.

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.

xreal EvalLength ()

This method is enabled for Creo Direct.

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

xreal EvalLengthBetween (xreal Param1, xreal Param2)

This method is enabled for Creo Direct.

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

Exceptions thrown (but not limited to):

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

pfcCurveDescriptor_ptr GetCurveDescriptor ()

This method is enabled for Creo Direct.

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

Exceptions thrown (but not limited to):

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

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

Returns:: The edge or curve geometry

pfcBSplineDescriptor_ptr 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