nxopen.geometricanalysis

Interface FaceCurvatureAnalysisBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface FaceCurvatureAnalysisBuilder
extends Builder

Represents a FaceCurvatureAnalysisBuilder builder. Use FaceCurvatureAnalysisBuilder to compute different types of curvature analysis for selected faces. The result of the curvature analysis is displayed as color maps and contour lines on the faces. For more details see the NX documentation for Face Curvature Analysis.
To create a new instance of this class, use AnalysisObjectCollection.createFaceCurvatureAnalysisBuilder(nxopen.DisplayableObject)
Default values.

Property	Value
ContourRefinement	0
ContourShift	0
DisplayType	Colormap
MapCenter	50
MapRange	100
NormalOption	Manipulator
NumberOfContours	10
Resolution.AngleTolerance	15.0
Resolution.EdgeTolerance	0.005
Resolution.FaceTolerance	0.005
Resolution.Resolution	Standard
Resolution.WidthTolerance	0.3
SectionOption	Manipulator
ShowZeroContour	0

Created in NX9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FaceCurvatureAnalysisBuilder.CurvatureTypes Represents the face curvature types.
static class	FaceCurvatureAnalysisBuilder.DirectionTypes Methods of specifiying the direction for normal and section curvatures.
static class	FaceCurvatureAnalysisBuilder.DisplayTypes Represents the display types.
static class	FaceCurvatureAnalysisBuilder.ScaleTypes Represents the scaling types for curvature values.

Method Summary

Modifier and Type	Method and Description
int	contourRefinement() Returns the contour refinement level, in the range 0-6.
double	contourShift() Returns the starting contour shift or bias value, as % of the standard contour interval.
Plane	curvatureSectionPlane() Returns the section curvature plane when sectional curvature values are to be computed and displayed.
FaceCurvatureAnalysisBuilder.CurvatureTypes	curvatureType() Returns the curvature type to compute and display.
void	deselectFaces(DisplayableObject[] faces) Deselects faces License requirements: studio_analyze ("STUDIO ANALYZE") .
FaceCurvatureAnalysisBuilder.DisplayTypes	displayType() Returns the display type for curvature values.
double	mapCenter() Returns the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.
double	mapRange() Returns the color map and contour range, as % of the full range of curvature values present in the data.
FaceCurvatureAnalysisBuilder.DirectionTypes	normalOption() Returns the normal for the case of normal curvature type.
Matrix3x3	normalOrientation() Returns the normal orientation when the normal curvature values are to be computed and displayed.
Point3d	normalOrigin() Returns the normal origin when normal curvature values are to be computed and displayed.
Direction	normalVector() Returns the normal vector for the case when normal curvature values are to be computed and displayed.
int	numberOfContours() Returns the number of contour lines to compute and display.
DisplayResolutionBuilder	resolution() Returns the tesselation resolution to use for curvature color map and contours.
void	reverseAllNormals() Reverses all normals.
SelectDisplayableObject	reverseIndividual() Returns the individual face normal.
void	reverseIndividualNormal(DisplayableObject face) Reverses an individual face normal.
FaceCurvatureAnalysisBuilder.ScaleTypes	scaleType() Returns the scaling type of curvature values.
FaceCurvatureAnalysisBuilder.DirectionTypes	sectionOption() Returns whether to use a section plane or maninpulator for sectional curvatures.
Matrix3x3	sectionOrientation() Returns the section orientation for sectional curvatures.
Point3d	sectionOrigin() Returns the section origin for sectional curvatures.
SelectDisplayableObjectList	selectObject() Returns the faces on which to perform curvature analysis.
void	setContourRefinement(int contourRefinement) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setContourShift(double contourShift) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setCurvatureSectionPlane(Plane curvatureSectionPlane) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setCurvatureType(FaceCurvatureAnalysisBuilder.CurvatureTypes curvatureType) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setDisplayType(FaceCurvatureAnalysisBuilder.DisplayTypes displayType) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setMapCenter(double mapCenter) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setMapRange(double mapRange) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setNormalOption(FaceCurvatureAnalysisBuilder.DirectionTypes normalOption) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setNormalOrientation(Matrix3x3 normalOrientation) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setNormalOrigin(Point3d normalOrigin) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setNormalVector(Direction normalVector) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setNumberOfContours(int numberOfContours) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setScaleType(FaceCurvatureAnalysisBuilder.ScaleTypes scaleType) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setSectionOption(FaceCurvatureAnalysisBuilder.DirectionTypes sectionOption) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setSectionOrientation(Matrix3x3 sectionOrientation) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setSectionOrigin(Point3d sectionOrigin) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setShowZeroContour(boolean showContour) License requirements: studio_analyze ("STUDIO ANALYZE") .
boolean	showZeroContour() Returns the option to show zero curvature contour line.
void	updateReverseMap() Updates reverse map.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

selectObject

SelectDisplayableObjectList selectObject()
                                  throws NXException,
                                         RemoteException

Returns the faces on which to perform curvature analysis.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

reverseAllNormals

void reverseAllNormals()
                throws NXException,
                       RemoteException

Reverses all normals.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX9.0.0

Throws:

NXException

RemoteException

reverseIndividualNormal

void reverseIndividualNormal(DisplayableObject face)
                      throws NXException,
                             RemoteException

Reverses an individual face normal.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX9.0.0

Parameters:

face -

Throws:

NXException

RemoteException

reverseIndividual

SelectDisplayableObject reverseIndividual()
                                   throws NXException,
                                          RemoteException

Returns the individual face normal.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

showZeroContour

boolean showZeroContour()
                 throws NXException,
                        RemoteException

Returns the option to show zero curvature contour line.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setShowZeroContour

void setShowZeroContour(boolean showContour)
                 throws NXException,
                        RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

showContour -

Throws:

NXException

RemoteException

numberOfContours

int numberOfContours()
              throws NXException,
                     RemoteException

Returns the number of contour lines to compute and display.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setNumberOfContours

void setNumberOfContours(int numberOfContours)
                  throws NXException,
                         RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

numberOfContours -

Throws:

NXException

RemoteException

contourRefinement

int contourRefinement()
               throws NXException,
                      RemoteException

Returns the contour refinement level, in the range 0-6. Increasing values compute more detailed and accurate contour lines on the face.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setContourRefinement

void setContourRefinement(int contourRefinement)
                   throws NXException,
                          RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

contourRefinement -

Throws:

NXException

RemoteException

contourShift

double contourShift()
             throws NXException,
                    RemoteException

Returns the starting contour shift or bias value, as % of the standard contour interval. Valid values are -100 to 100.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setContourShift

void setContourShift(double contourShift)
              throws NXException,
                     RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

contourShift -

Throws:

NXException

RemoteException

mapRange

double mapRange()
         throws NXException,
                RemoteException

Returns the color map and contour range, as % of the full range of curvature values present in the data.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setMapRange

void setMapRange(double mapRange)
          throws NXException,
                 RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

mapRange -

Throws:

NXException

RemoteException

mapCenter

double mapCenter()
          throws NXException,
                 RemoteException

Returns the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setMapCenter

void setMapCenter(double mapCenter)
           throws NXException,
                  RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

mapCenter -

Throws:

NXException

RemoteException

normalOption

FaceCurvatureAnalysisBuilder.DirectionTypes normalOption()
                                                  throws NXException,
                                                         RemoteException

Returns the normal for the case of normal curvature type.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setNormalOption

void setNormalOption(FaceCurvatureAnalysisBuilder.DirectionTypes normalOption)
              throws NXException,
                     RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

normalOption -

Throws:

NXException

RemoteException

curvatureType

FaceCurvatureAnalysisBuilder.CurvatureTypes curvatureType()
                                                   throws NXException,
                                                          RemoteException

Returns the curvature type to compute and display.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCurvatureType

void setCurvatureType(FaceCurvatureAnalysisBuilder.CurvatureTypes curvatureType)
               throws NXException,
                      RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

curvatureType -

Throws:

NXException

RemoteException

displayType

FaceCurvatureAnalysisBuilder.DisplayTypes displayType()
                                               throws NXException,
                                                      RemoteException

Returns the display type for curvature values.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setDisplayType

void setDisplayType(FaceCurvatureAnalysisBuilder.DisplayTypes displayType)
             throws NXException,
                    RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

displayType -

Throws:

NXException

RemoteException

scaleType

FaceCurvatureAnalysisBuilder.ScaleTypes scaleType()
                                           throws NXException,
                                                  RemoteException

Returns the scaling type of curvature values.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setScaleType

void setScaleType(FaceCurvatureAnalysisBuilder.ScaleTypes scaleType)
           throws NXException,
                  RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

scaleType -

Throws:

NXException

RemoteException

normalVector

Direction normalVector()
                throws NXException,
                       RemoteException

Returns the normal vector for the case when normal curvature values are to be computed and displayed.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setNormalVector

void setNormalVector(Direction normalVector)
              throws NXException,
                     RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

normalVector -

Throws:

NXException

RemoteException

curvatureSectionPlane

Plane curvatureSectionPlane()
                     throws NXException,
                            RemoteException

Returns the section curvature plane when sectional curvature values are to be computed and displayed.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCurvatureSectionPlane

void setCurvatureSectionPlane(Plane curvatureSectionPlane)
                       throws NXException,
                              RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

curvatureSectionPlane -

Throws:

NXException

RemoteException

normalOrigin

Point3d normalOrigin()
              throws NXException,
                     RemoteException

Returns the normal origin when normal curvature values are to be computed and displayed.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setNormalOrigin

void setNormalOrigin(Point3d normalOrigin)
              throws NXException,
                     RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

normalOrigin -

Throws:

NXException

RemoteException

normalOrientation

Matrix3x3 normalOrientation()
                     throws NXException,
                            RemoteException

Returns the normal orientation when the normal curvature values are to be computed and displayed.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setNormalOrientation

void setNormalOrientation(Matrix3x3 normalOrientation)
                   throws NXException,
                          RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

normalOrientation -

Throws:

NXException

RemoteException

sectionOption

FaceCurvatureAnalysisBuilder.DirectionTypes sectionOption()
                                                   throws NXException,
                                                          RemoteException

Returns whether to use a section plane or maninpulator for sectional curvatures.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setSectionOption

void setSectionOption(FaceCurvatureAnalysisBuilder.DirectionTypes sectionOption)
               throws NXException,
                      RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

sectionOption -

Throws:

NXException

RemoteException

sectionOrigin

Point3d sectionOrigin()
               throws NXException,
                      RemoteException

Returns the section origin for sectional curvatures.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setSectionOrigin

void setSectionOrigin(Point3d sectionOrigin)
               throws NXException,
                      RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

sectionOrigin -

Throws:

NXException

RemoteException

sectionOrientation

Matrix3x3 sectionOrientation()
                      throws NXException,
                             RemoteException

Returns the section orientation for sectional curvatures.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setSectionOrientation

void setSectionOrientation(Matrix3x3 sectionOrientation)
                    throws NXException,
                           RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

sectionOrientation -

Throws:

NXException

RemoteException

resolution

DisplayResolutionBuilder resolution()
                             throws NXException,
                                    RemoteException

Returns the tesselation resolution to use for curvature color map and contours.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

updateReverseMap

void updateReverseMap()
               throws NXException,
                      RemoteException

Updates reverse map.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX9.0.0

Throws:

NXException

RemoteException

deselectFaces

void deselectFaces(DisplayableObject[] faces)
            throws NXException,
                   RemoteException

Deselects faces
License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX11.0.0

Parameters:

faces -

Throws:

NXException

RemoteException