API Documentation > Classes > Interface IpfcSurface
Interface IpfcSurface
Description
This class defines a surface.
Direct Parent Classes:
Direct Known Subclasses:
User Guide References:
Property Summary
Property
as Boolean
true if the geometry is visible and active, false if it is invisible and inactive. Inactive geometry may not have all geometric properties defined.
Property
as IpfcQuilt [readonly, optional]
The quilt that contains the surface.
Method Summary
Function
Evaluates the surface in the specified UV point.
Function
EvalArea () as Double
Finds the surface area.
Function
EvalClosestPoint (ToPoint as IpfcPoint3D) as IpfcPoint3D [optional]
Finds the point on the surface that is closest to the given point.
Function
Determines whether the specified point is within a small epsilon value of the invoking surface.
Function
EvalDiameter (Params as IpfcUVParams [optional]) as Double
Finds the surface diameter at the specified UV point.
Function
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.
Function
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.
Function
Finds the corresponding UV point on the surface, given the XYZ point.
Function
This method returns the principal curvatures and directions of a surface at a specified UV point.
Function
Returns the feature which contains the geometry.
Function
This method calculates the surface geometry as a non-uniform rational B-spline surface.
Function
This method returns the orientation of the surface
Function
This method returns a data object representing the geometry of the surface.
Function
This method returns the type of the surface.
Function
This method returns the UV parameters at the corners of the surface.
Function
This method returns the XYZ points at the corners of the surface.
Function
Lists all the contours on the surface.
Function
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.
Function
Verifies whether the specified UV point lies within the surface boundaries.
Property Detail
Property
IsVisible
as Boolean
true if the geometry is visible and active, false if it is invisible and inactive. Inactive geometry may not have all geometric properties defined.
Property
OwnerQuilt
as IpfcQuilt [readonly, optional]
The quilt that contains the surface.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified surface does not belong to any quilt.
Method Detail
Function
Eval3DData
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
User Guide References:
Function
EvalArea
() as Double
Finds the surface area.
Exceptions thrown (but not limited to):
IpfcXToolkitOutOfRange - Surface area is too small (almost zero).
Returns:
The surface area
User Guide References:
Function
EvalClosestPoint
(ToPoint as IpfcPoint3D) as IpfcPoint3D [optional]
Finds the point on the surface that is closest to the given point.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - Projection of the point to the surface was not found.
Parameters:
ToPoint
The XYZ point
Returns:
The closest point in the surface
User Guide References:
Function
EvalClosestPointOnSurface
(ToPoint as IpfcPoint3D) as IpfcPoint3D [optional]
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.
User Guide References:
Function
EvalDiameter
(Params as IpfcUVParams [optional]) as Double
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
User Guide References:
Function
EvalMaximum
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
User Guide References:
Function
EvalMinimum
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
User Guide References:
Function
EvalParameters
(Point as IpfcPoint3D) as IpfcUVParams
Finds the corresponding UV point on the surface, given the XYZ point.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - 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
User Guide References:
Function
EvalPrincipalCurv
This method returns the principal curvatures and directions of a surface at a specified UV point.
Exceptions thrown (but not limited to):
IpfcXToolkitBadSrfCrv - 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
User Guide References:
Function
GetFeature
Returns the feature which contains the geometry.
Returns:
The feaature.
Function
GetNURBSRepresentation
This method calculates the surface geometry as a non-uniform rational B-spline surface.
Returns:
The NURBS surface geometry.
User Guide References:
Function
GetOrientation
This method returns the orientation of the surface
Returns:
The surface orientation
User Guide References:
Function
GetSurfaceDescriptor
This method returns a data object representing the geometry of the surface.
Returns:
The surface descriptor
User Guide References:
Function
GetSurfaceType
This method returns the type of the surface.
Returns:
The surface type
User Guide References:
Function
GetUVExtents
This method returns the UV parameters at the corners of the surface.
Returns:
The UV parameters.
User Guide References:
Function
GetXYZExtents
This method returns the XYZ points at the corners of the surface.
Returns:
The XYZ points.
User Guide References:
Function
ListContours
Lists all the contours on the surface.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - No contours were visited (either because of the filter or for another reason).
Returns:
The list of contours
User Guide References:
Function
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
User Guide References:
Function
VerifyUV
(Params as IpfcUVParams) as IpfcPlacement
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.
User Guide References:
Was this helpful?