CIP JAVA documentation for class "com.ptc.pfc.pfcGeometry.Surface"

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

Method Summary
`SurfXYZData`	`Eval3DData (UVParams Params)` Evaluates the surface in the specified UV point.
`double`	`EvalArea ()` Finds the surface area.
`/optional/ Point3D`	`EvalClosestPoint (Point3D ToPoint)` Finds the point on the surface that is closest to the given point.
`/optional/ Point3D`	`EvalClosestPointOnSurface (Point3D ToPoint)` Determines whether the specified point is within a small epsilon value of the invoking surface.
`double`	`EvalDiameter ( /optional/ UVParams Params)` Finds the surface diameter at the specified UV point.
`Point3D`	`EvalMaximum (Vector3D 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.
`Point3D`	`EvalMinimum (Vector3D 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.
`UVParams`	`EvalParameters (Point3D Point)` Finds the corresponding UV point on the surface, given the XYZ point.
`CurvatureData`	`EvalPrincipalCurv (UVParams Params)` This method returns the principal curvatures and directions of a surface at a specified UV point.
`Feature`	`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.
`NURBSSurfaceDescriptor`	`GetNURBSRepresentation ()` This method calculates the surface geometry as a non-uniform rational B-spline surface.
`SurfaceOrientation`	`GetOrientation ()` This method returns the orientation of the surface
`/optional/ Quilt`	`GetOwnerQuilt ()` Get method for attribute "OwnerQuilt" The quilt that contains the surface.
`SurfaceDescriptor`	`GetSurfaceDescriptor ()` This method returns a data object representing the geometry of the surface.
`SurfaceType`	`GetSurfaceType ()` This method returns the type of the surface.
`UVOutline`	`GetUVExtents ()` This method returns the UV parameters at the corners of the surface.
`Outline3D`	`GetXYZExtents ()` This method returns the XYZ points at the corners of the surface.
`Contours`	`ListContours ()` Lists all the contours on the surface.
`Surfaces`	`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.
`Placement`	`VerifyUV (UVParams Params)` Verifies whether the specified UV point lies within the surface boundaries.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

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

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

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

EvalClosestPointOnSurface

/*optional*/ Point3D EvalClosestPointOnSurface (Point3D 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.

EvalClosestPoint

/*optional*/ Point3D EvalClosestPoint (Point3D ToPoint)

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.

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

Parameters:

ToPoint: The XYZ point

Returns:: The closest point in the surface

Eval3DData

SurfXYZData Eval3DData (UVParams 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

EvalParameters

UVParams EvalParameters (Point3D Point)

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.

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

EvalArea

double EvalArea ()

Finds the surface area.

Exceptions thrown (but not limited to):

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

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

Returns:: The surface area

EvalPrincipalCurv

CurvatureData EvalPrincipalCurv (UVParams Params)

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.

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

VerifyUV

Placement VerifyUV (UVParams 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.

EvalDiameter

double EvalDiameter ( /*optional*/ UVParams 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

EvalMaximum

Point3D EvalMaximum (Vector3D 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

EvalMinimum

Point3D EvalMinimum (Vector3D 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

ListContours

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

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

ListSameSurfaces

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

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

Returns:: The array of surfaces

GetSurfaceType

SurfaceType GetSurfaceType ()

This method returns the type of the surface.

Manual References:: Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information

Returns:: The surface type

GetXYZExtents

Outline3D GetXYZExtents ()

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

Manual References:: Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information

Returns:: The XYZ points.

GetUVExtents

UVOutline GetUVExtents ()

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

Manual References:: Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information

Returns:: The UV parameters.

GetOrientation

SurfaceOrientation GetOrientation ()

This method returns the orientation of the surface

Manual References:: Geometry Evaluation: Surface Information, Geometry Evaluation: Surface Information

Returns:: The surface orientation

GetSurfaceDescriptor

SurfaceDescriptor GetSurfaceDescriptor ()

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

Manual References:: Geometry Evaluation: Surface Descriptors, Geometry Evaluation: Surface Descriptors

Returns:: The surface descriptor

GetNURBSRepresentation

NURBSSurfaceDescriptor GetNURBSRepresentation ()

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

Manual References:: Geometry Evaluation: Surface Descriptors, Geometry Evaluation: Surface Descriptors

Returns:: The NURBS surface geometry.