Interface Surface
package com.ptc.pfc.pfcGeometry;
public interface Surface
extends com.ptc.pfc.pfcModelItem.ModelItem
Description
This class defines a surface.
Direct Known Subclasses:
TransformedSurface, CoonsPatch, FilletSurface, Spline2DerSurface, SplineSurface, NURBSSurface, WSurface
User Guide References:
Evaluation of Surfaces:Surface, Selection:Surface, Solid Operations:Surface, Solid Body Information:Surface, Accessing and Modifying Annotation Elements:Surface, Automatic Propagation of Annotation Elements:Surface, Ordinate Dimensions:Surface, Surface Finish Annotations:Surface, Curve and Surface Collection:Surface, Introduction to Curve and Surface Collection:Surface, Interactive Collection:Surface, Curve Collection:Surface, Surface Collection:Surface, ModelItem:Surface, Feature Elements:Surface, Datum Coordinate System Features:Surface, Extracting Cross-Sectional Geometry:Surface, Mass Properties of Cross Sections:Surface, Geometry Terms:Surface, Traversing the Geometry of a Solid Block:Surface, Solid Edge Geometry:Surface, Contours:Surface, Surfaces:Surface, Surface Types:Surface, Surface Information:Surface, Evaluation of Surfaces:Surface, Surface Descriptors:Surface, Surface Tessellation:Surface, Part and Assembly Tessellation:Surface, Geometry Objects:Surface, Geometry of Solid Edges:Surface, Geometry of Quilts:Surface, Geometry of Surfaces:Surface, 45 Degree Chamfer Dimensions:Surface, Shrinkwrap Export:Surface, Setting Shrinkwrap Options:Surface, Surface Subset Options:Surface, Modifying the Imported Layers:Surface, Import Feature Properties:Surface, Import Feature Attributes:Surface, Extracting Creo Parametric Creo+ Geometry as Interface Data:Surface, Cosmetic Properties:Surface, Geometry Representations:Surface, General Surface of Revolution:Surface, Ruled Surface:Surface, Fillet Surface:Surface, Spline Surface:Surface, NURBS Surface:Surface, Cylindrical Spline Surface:Surface, Creo Object TOOLKIT Java Classes:Surface
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Method Summary
Evaluates the surface in the specified UV point. | |
double | EvalArea () |
Finds the surface area. | |
/*optional*/ Point3D | |
Finds the point on the surface that is closest to the given point. | |
/*optional*/ Point3D | |
Determines whether the specified point is within a small epsilon value of the invoking surface. | |
double | |
Finds the surface diameter at the specified UV point. | |
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. | |
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. | |
Finds the corresponding UV point on the surface, given the XYZ point. | |
This method returns the principal curvatures and directions of a surface at a specified UV point. | |
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. | |
This method calculates the surface geometry as a non-uniform rational B-spline surface. | |
This method returns the orientation of the surface | |
/*optional*/ Quilt | |
Get method for attribute "OwnerQuilt" The quilt that contains the surface. | |
This method returns a data object representing the geometry of the surface. | |
This method returns the type of the surface. | |
GetUVExtents () | |
This method returns the UV parameters at the corners of the surface. | |
This method returns the XYZ points at the corners of the surface. | |
ListContours () | |
Lists all the contours on the surface. | |
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. | |
Verifies whether the specified UV point lies within the surface boundaries. |
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 | ||
GetFeature | () |
Returns the feature which contains the geometry.
Returns:
The feaature.
GetOwnerQuilt | ||
/*optional*/ Quilt | GetOwnerQuilt | () |
The quilt that contains the surface.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified surface does not belong to any quilt.
User Guide References:
Determines whether the specified point is within a small epsilon value of the invoking surface.
User Guide References:
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.
Finds the point on the surface that is closest to the given point.
Exceptions thrown (but not limited to):
XToolkitNotFound - Projection of the point to the surface was not found.
User Guide References:
Parameters:
ToPoint
The XYZ point
Returns:
The closest point in the surface
Eval3DData | ||
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
User Guide References:
Parameters:
Params
The UV parameter on the surface
Returns:
The evaluation data
Finds the corresponding UV point on the surface, given the XYZ point.
Exceptions thrown (but not limited to):
XToolkitNotFound - Projection of the point to the surface was not found.
User Guide References:
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
EvalArea | ||
double | EvalArea | () |
Finds the surface area.
Exceptions thrown (but not limited to):
XToolkitOutOfRange - Surface area is too small (almost zero).
User Guide References:
Returns:
The surface area
EvalPrincipalCurv | ||
EvalPrincipalCurv |
This method returns the principal curvatures and directions of a surface at a specified UV point.
Exceptions thrown (but not limited to):
XToolkitBadSrfCrv - The input argument is invalid.
User Guide References:
Parameters:
Params
The UV point
Returns:
The minimum and maximum curvatures at the specified point and theprincipal directions at the point
Verifies whether the specified UV point lies within the surface boundaries.
User Guide References:
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.
EvalDiameter | ||
double | EvalDiameter |
Finds the surface diameter at the specified UV point.
User Guide References:
Parameters:
Params
The UV point. This is ignored when the surface diameter is constant.
Returns:
The resulting diameter
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.
User Guide References:
Parameters:
Proj
The direction of projection
Returns:
The coordinates of the point where the function finds the maximum projection
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.
User Guide References:
Parameters:
Proj
The direction of projection
Returns:
The coordinates of the point where the function finds the minimum projection
ListContours | ||
ListContours | () |
Lists all the contours on the surface.
Exceptions thrown (but not limited to):
XToolkitNotFound - No contours were visited (either because of the filter or for another reason).
User Guide References:
Returns:
The list of contours
ListSameSurfaces | ||
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.
User Guide References:
Returns:
The array of surfaces
GetSurfaceType | ||
GetSurfaceType | () |
This method returns the type of the surface.
User Guide References:
Returns:
The surface type
GetXYZExtents | ||
GetXYZExtents | () |
This method returns the XYZ points at the corners of the surface.
User Guide References:
Returns:
The XYZ points.
GetUVExtents | ||
GetUVExtents | () |
This method returns the UV parameters at the corners of the surface.
User Guide References:
Returns:
The UV parameters.
GetOrientation | ||
GetOrientation | () |
This method returns the orientation of the surface
User Guide References:
Returns:
The surface orientation
GetSurfaceDescriptor | ||
GetSurfaceDescriptor | () |
This method returns a data object representing the geometry of the surface.
User Guide References:
Returns:
The surface descriptor
GetNURBSRepresentation | ||
GetNURBSRepresentation | () |
This method calculates the surface geometry as a non-uniform rational B-spline surface.
User Guide References:
Returns:
The NURBS surface geometry.