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

Interface Contour

package com.ptc.pfc.pfcGeometry; public interface Contour extends com.ptc.pfc.pfcObject.Object

Description

This class describes a contour.

Direct Known Subclasses:: WContour

Method Summary
`double`	`EvalArea ()` Finds the surface area inside the given outer contour, accounting for internal voids.
`Outline2D`	`EvalOutline ()` Finds the two-dimensional bounding box of the surface inside the outer contour.
`/optional/ Contour`	`FindContainingContour ()` Finds the innermost contour that encloses the specified contour. If the specified contour is internal, the returned contour will be external, and vice versa.
`/optional/ ContourTraversal`	`GetInternalTraversal ()` Get method for attribute "InternalTraversal" Determines if a countour's traversal is internal or external.
`Edges`	`ListElements ()` Gets an array of edges for the contour.
`Placement`	`VerifyUV (UVParams Params)` Verifies whether the specified UV point lies within the given contour.

Method Detail

ListElements

Edges ListElements ()

Gets an array of edges for the contour.

Exceptions thrown (but not limited to):

XToolkitNotFound - No edges were visited, either because of the filter or for another reason.

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

Returns:: The list of edges

GetInternalTraversal

/*optional*/ ContourTraversal GetInternalTraversal ()

Determines if a countour's traversal is internal or external.

Manual References:: Geometry Evaluation: Contours, Geometry Evaluation: Contours

FindContainingContour

/*optional*/ Contour FindContainingContour ()

Finds the innermost contour that encloses the specified contour. If the specified contour is internal, the returned contour will be external, and vice versa.

In case the specified contour is the outermost contour for the surface then null is returned.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified contour was not found.

XToolkitInvalidPtr - The specified pointer is not a solid pointer.

Manual References:: Geometry Evaluation: Contours, Geometry Evaluation: Contours

Returns:: The containing contour.

EvalArea

double EvalArea ()

Finds the surface area inside the given outer contour, accounting for internal voids.

Exceptions thrown (but not limited to):

XToolkitBadSrfCrv - The input argument is invalid.

Manual References:: Geometry Evaluation: Contours, Geometry Evaluation: Contours

Returns:: The contour area

EvalOutline

Outline2D EvalOutline ()

Finds the two-dimensional bounding box of the surface inside the outer contour.

Exceptions thrown (but not limited to):

XToolkitBadSrfCrv - The input argument is invalid.

Manual References:: Geometry Evaluation: Contours, Geometry Evaluation: Contours

Returns:: The bounding box, as an array of points

VerifyUV

Placement VerifyUV (UVParams Params)

Verifies whether the specified UV point lies within the given contour.

Exceptions thrown (but not limited to):

XToolkitBadSrfCrv - One or more of the input arguments are invalid.

Manual References:: Geometry Evaluation: Contours, Geometry Evaluation: Contours

Parameters:

Params

Returns:

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.