CIP C++ documentation for class "pfcSurface"

Class pfcSurface

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

Description

This class defines a surface.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Cross Sections: Extracting Cross-Sectional Geometry

Direct Known Subclasses:: pfcTransformedSurface, pfcCoonsPatch, pfcFilletSurface, pfcSpline2DerSurface, pfcSplineSurface, pfcNURBSSurface, wfcWSurface

Method Summary


`pfcSurfXYZData_ptr`	`Eval3DData (pfcUVParams_ptr Params)`
	Evaluates the surface in the specified UV point.

`xreal`	`EvalArea ()`
	Finds the surface area.

`optional pfcPoint3D_ptr`	`EvalClosestPoint (pfcPoint3D_ptr ToPoint)`
	Finds the point on the surface that is closest to the given point.

`optional pfcPoint3D_ptr`	`EvalClosestPointOnSurface (pfcPoint3D_ptr ToPoint)`
	Determines whether the specified point is within a small epsilon value of the invoking surface.

`xreal`	`EvalDiameter (optional pfcUVParams_ptr Params)`
	Finds the surface diameter at the specified UV point.

`pfcPoint3D_ptr`	`EvalMaximum (pfcVector3D_ptr Proj)`
	Finds the coordinates of the surface edge at the maximum projection, in the specified direction. The accuracy of this result is limited to the accuracy of the edge tessellation.

`pfcPoint3D_ptr`	`EvalMinimum (pfcVector3D_ptr Proj)`
	Finds the coordinates of the surface edge at the minimum projection, in the specified direction. The accuracy of this result is limited to the accuracy of the edge tessellation.

`pfcUVParams_ptr`	`EvalParameters (pfcPoint3D_ptr Point)`
	Finds the corresponding UV point on the surface, given the XYZ point.

`pfcCurvatureData_ptr`	`EvalPrincipalCurv (pfcUVParams_ptr Params)`
	This method returns the principal curvatures and directions of a surface at a specified UV point.

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

`xbool`	`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.

`pfcNURBSSurfaceDescriptor_ptr`	`GetNURBSRepresentation ()`
	This method calculates the surface geometry as a non-uniform rational B-spline surface.

`pfcSurfaceOrientation`	`GetOrientation ()`
	This method returns the orientation of the surface

`optional pfcQuilt_ptr`	`GetOwnerQuilt ()`
	The quilt that contains the surface.

`pfcSurfaceDescriptor_ptr`	`GetSurfaceDescriptor ()`
	This method returns a data object representing the geometry of the surface.

`pfcSurfaceType`	`GetSurfaceType ()`
	This method returns the type of the surface.

`pfcUVOutline_ptr`	`GetUVExtents ()`
	This method returns the UV parameters at the corners of the surface.

`pfcOutline3D_ptr`	`GetXYZExtents ()`
	This method returns the XYZ points at the corners of the surface.

`pfcContours_ptr`	`ListContours ()`
	Lists all the contours on the surface.

`pfcSurfaces_ptr`	`ListSameSurfaces ()`
	Finds and returns an array of surfaces that are the same as the input surface. For example, in the case of a cylinder, Creo Parametric creates two, half-cylindrical surfaces. If you input one half of the cylinder, this function returns the other half.

`pfcPlacement`	`VerifyUV (pfcUVParams_ptr Params)`
	Verifies whether the specified UV point lies within the surface boundaries.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

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

pfcFeature_ptr GetFeature ()

Returns the feature which contains the geometry.

Returns:: The feaature.

optional pfcQuilt_ptr GetOwnerQuilt ()

The quilt that contains the surface.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified surface does not belong to any quilt.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

optional pfcPoint3D_ptr EvalClosestPointOnSurface (pfcPoint3D_ptr ToPoint)

Determines whether the specified point is within a small epsilon value of the invoking surface.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

ToPoint: The point to evaluate

Returns:: If the point is within tolerance, the method returns the closest three-dimensional point that is on the surface. If the specified point is not within tolerance, the method returns null.

optional pfcPoint3D_ptr EvalClosestPoint (pfcPoint3D_ptr ToPoint)

Finds the point on the surface that is closest to the given point.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Projection of the point to the surface was not found.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

ToPoint: The XYZ point

Returns:: The closest point in the surface

pfcSurfXYZData_ptr Eval3DData (pfcUVParams_ptr Params)

Evaluates the surface in the specified UV point.

The function returns the following information:

The resulting XYZ point
The first and second derivatives
The normal to the surface

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Params: The UV parameter on the surface

Returns:: The evaluation data

pfcUVParams_ptr EvalParameters (pfcPoint3D_ptr Point)

Finds the corresponding UV point on the surface, given the XYZ point.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Projection of the point to the surface was not found.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

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

Returns:: The corresponding UV point

xreal EvalArea ()

Finds the surface area.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfRange - Surface area is too small (almost zero).

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Returns:: The surface area

pfcCurvatureData_ptr EvalPrincipalCurv (pfcUVParams_ptr Params)

This method returns the principal curvatures and directions of a surface at a specified UV point.

Exceptions thrown (but not limited to):

pfcXToolkitBadSrfCrv - The input argument is invalid.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Params: The UV point

Returns:: The minimum and maximum curvatures at the specified point and theprincipal directions at the point

pfcPlacement VerifyUV (pfcUVParams_ptr Params)

Verifies whether the specified UV point lies within the surface boundaries.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Params: The UV point to test

Returns:

The resulting status. The function returns one of the following values:

PLACE_ON_BOUNDARY -- The point is on the contour.
PLACE_OUTSIDE -- The point is outside the contour.
PLACE_INSIDE -- The point is inside the contour.

xreal EvalDiameter (optional pfcUVParams_ptr Params)

Finds the surface diameter at the specified UV point.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Params: The UV point. This is ignored when the surface diameter is constant.

Returns:: The resulting diameter

pfcPoint3D_ptr EvalMaximum (pfcVector3D_ptr Proj)

Finds the coordinates of the surface edge at the maximum projection, in the specified direction. The accuracy of this result is limited to the accuracy of the edge tessellation.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Proj: The direction of projection

Returns:: The coordinates of the point where the function finds the maximum projection

pfcPoint3D_ptr EvalMinimum (pfcVector3D_ptr Proj)

Finds the coordinates of the surface edge at the minimum projection, in the specified direction. The accuracy of this result is limited to the accuracy of the edge tessellation.

Manual References:: Geometry Evaluation: Evaluation of Surfaces, Geometry Evaluation: Evaluation of Surfaces

Parameters:

Proj: The direction of projection

Returns:: The coordinates of the point where the function finds the minimum projection

pfcContours_ptr ListContours ()

Lists all the contours on the surface.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No contours were visited (either because of the filter or for another reason).

Manual References:: Geometry Evaluation: Traversing the Geometry of a Solid Block, Geometry Evaluation: Traversing the Geometry of a Solid Block, Geometry Evaluation: Contours, Geometry Evaluation: Contours

Returns:: The list of contours

pfcSurfaces_ptr ListSameSurfaces ()

Finds and returns an array of surfaces that are the same as the input surface. For example, in the case of a cylinder, Creo Parametric creates two, half-cylindrical surfaces. If you input one half of the cylinder, this function returns the other half.