CIP JavaScript documentation for class " pfcSurface"

Class pfcSurface

Description

This class defines a surface.

Direct Parent Classes:: pfcModelItem

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

Property Summary


`/* readonly */ boolean`	`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.

`/* readonly / / optional */ pfcQuilt`	`OwnerQuilt`
	The quilt that contains the surface.

Method Summary


`pfcSurfXYZData`	`Eval3DData (pfcUVParams Params)`
	Evaluates the surface in the specified UV point.

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

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

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

`number`	`EvalDiameter ( /* optional */ pfcUVParams Params)`
	Finds the surface diameter at the specified UV point.

`pfcPoint3D`	`EvalMaximum (pfcVector3D 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`	`EvalMinimum (pfcVector3D 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`	`EvalParameters (pfcPoint3D Point)`
	Finds the corresponding UV point on the surface, given the XYZ point.

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

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

`pfcNURBSSurfaceDescriptor`	`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

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

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

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

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

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

`pfcSurfaces`	`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 Params)`
	Verifies whether the specified UV point lies within the surface boundaries.

Property Detail

/* readonly */ boolean 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.

/* readonly */ /* optional */ pfcQuilt OwnerQuilt

The quilt that contains the surface.

Exceptions thrown (but not limited to):

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

Method Detail

pfcSurfXYZData Eval3DData (pfcUVParams 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

Parameters:

Params: The UV parameter on the surface

Returns:: The evaluation data

number EvalArea ()

Finds the surface area.

Exceptions thrown (but not limited to):

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

Returns:: The surface area

/* optional */ pfcPoint3D EvalClosestPoint (pfcPoint3D 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.

Parameters:

ToPoint: The XYZ point

Returns:: The closest point in the surface

/* optional */ pfcPoint3D EvalClosestPointOnSurface (pfcPoint3D ToPoint)

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

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.

number EvalDiameter ( /* optional */ pfcUVParams Params)

Finds the surface diameter at the specified UV point.

Parameters:

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

Returns:: The resulting diameter

pfcPoint3D EvalMaximum (pfcVector3D 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.

Parameters:

Proj: The direction of projection

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

pfcPoint3D EvalMinimum (pfcVector3D 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.

Parameters:

Proj: The direction of projection

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

pfcUVParams EvalParameters (pfcPoint3D 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.

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

pfcCurvatureData EvalPrincipalCurv (pfcUVParams 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.

Parameters:

Params: The UV point

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

pfcFeature GetFeature ()

Returns the feature which contains the geometry.

Returns:: The feaature.

pfcNURBSSurfaceDescriptor GetNURBSRepresentation ()

This method calculates the surface geometry as a non-uniform rational B-spline surface.

Returns:: The NURBS surface geometry.

pfcSurfaceOrientation GetOrientation ()

This method returns the orientation of the surface

Returns:: The surface orientation

pfcSurfaceDescriptor GetSurfaceDescriptor ()

This method returns a data object representing the geometry of the surface.

Returns:: The surface descriptor

pfcSurfaceType GetSurfaceType ()

This method returns the type of the surface.

Returns:: The surface type

pfcUVOutline GetUVExtents ()

This method returns the UV parameters at the corners of the surface.

Returns:: The UV parameters.

pfcOutline3D GetXYZExtents ()

This method returns the XYZ points at the corners of the surface.

Returns:: The XYZ points.

pfcContours 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).

Returns:: The list of contours

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

Returns:: The array of surfaces

pfcPlacement VerifyUV (pfcUVParams Params)

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

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.