Class pfcContour
Description
This class describes a contour.
Direct Parent Classes:
User Guide References:
Property Summary
/* readonly */ /* optional */ pfcContourTraversal | |
Determines if a countour's traversal is internal or external. |
Method Summary
number | EvalArea () |
Finds the surface area inside the given outer contour, accounting for internal voids. | |
EvalOutline () | |
Finds the two-dimensional bounding box of the surface inside the outer contour. | |
/* optional */ pfcContour | |
Finds the innermost contour that encloses the specified contour. If the specified contour is internal, the returned contour will be external, and vice versa. | |
ListElements () | |
Gets an array of edges for the contour. | |
Verifies whether the specified UV point lies within the given contour. |
Property Detail
/* readonly */ /* optional */ pfcContourTraversal | InternalTraversal |
Determines if a countour's traversal is internal or external.
Method Detail
number | EvalArea | () |
Finds the surface area inside the given outer contour, accounting for internal voids.
Exceptions thrown (but not limited to):
pfcXToolkitBadSrfCrv - The input argument is invalid.
Returns:
The contour area
User Guide References:
EvalOutline | () |
Finds the two-dimensional bounding box of the surface inside the outer contour.
Exceptions thrown (but not limited to):
pfcXToolkitBadSrfCrv - The input argument is invalid.
Returns:
The bounding box, as an array of points
User Guide References:
/* optional */ pfcContour | 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):
pfcXToolkitNotFound - The specified contour was not found.
pfcXToolkitInvalidPtr - The specified pointer is not a solid pointer.
Returns:
The containing contour.
User Guide References:
ListElements | () |
Gets an array of edges for the contour.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - No edges were visited, either because of the filter or for another reason.
Returns:
The list of edges
User Guide References:
VerifyUV |
Verifies whether the specified UV point lies within the given contour.
Exceptions thrown (but not limited to):
pfcXToolkitBadSrfCrv - One or more of the input arguments are invalid.
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.
User Guide References: