FaceCurvatureAnalysisBuilder Class¶
-
class
NXOpen.GeometricAnalysis.
FaceCurvatureAnalysisBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilder
builder.Use
NXOpen.GeometricAnalysis.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
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateFaceCurvatureAnalysisBuilder()
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 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
ContourRefinement | Returns or sets the contour refinement level, in the range 0-6. |
ContourShift | Returns or sets the starting contour shift or bias value, as % of the standard contour interval. |
CurvatureSectionPlane | Returns or sets the section curvature plane when sectional curvature values are to be computed and displayed. |
CurvatureType | Returns or sets the curvature type to compute and display. |
DisplayType | Returns or sets the display type for curvature values. |
MapCenter | Returns or sets the center point of the color mapping and contouring, as % of the full range of curvature values present in the data. |
MapRange | Returns or sets the color map and contour range, as % of the full range of curvature values present in the data. |
NormalOption | Returns or sets the normal for the case of normal curvature type. |
NormalOrientation | Returns or sets the normal orientation when the normal curvature values are to be computed and displayed. |
NormalOrigin | Returns or sets the normal origin when normal curvature values are to be computed and displayed. |
NormalVector | Returns or sets the normal vector for the case when normal curvature values are to be computed and displayed. |
NumberOfContours | Returns or sets the number of contour lines to compute and display. |
Resolution | Returns the tesselation resolution to use for curvature color map and contours. |
ReverseIndividual | Returns the individual face normal. |
ScaleType | Returns or sets the scaling type of curvature values. |
SectionOption | Returns or sets whether to use a section plane or maninpulator for sectional curvatures. |
SectionOrientation | Returns or sets the section orientation for sectional curvatures. |
SectionOrigin | Returns or sets the section origin for sectional curvatures. |
SelectObject | Returns the faces on which to perform curvature analysis. |
ShowZeroContour | Returns or sets the option to show zero curvature contour line. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
DeselectFaces | Deselects faces |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ReverseAllNormals | Reverses all normals. |
ReverseIndividualNormal | Reverses an individual face normal. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateReverseMap | Updates reverse map. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
FaceCurvatureAnalysisBuilderCurvatureTypes Enumeration | Represents the face curvature types. |
FaceCurvatureAnalysisBuilderDirectionTypes Enumeration | Methods of specifiying the direction for normal and section curvatures. |
FaceCurvatureAnalysisBuilderDisplayTypes Enumeration | Represents the display types. |
FaceCurvatureAnalysisBuilderScaleTypes Enumeration | Represents the scaling types for curvature values. |
Property Detail¶
ContourRefinement¶
-
FaceCurvatureAnalysisBuilder.
ContourRefinement
¶ Returns or sets the contour refinement level, in the range 0-6.
Increasing values compute more detailed and accurate contour lines on the face.
-------------------------------------
Getter Method
Signature
ContourRefinement
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ContourRefinement
Parameters: contourRefinement (int) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ContourShift¶
-
FaceCurvatureAnalysisBuilder.
ContourShift
¶ Returns or sets the starting contour shift or bias value, as % of the standard contour interval.
Valid values are -100 to 100.
-------------------------------------
Getter Method
Signature
ContourShift
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ContourShift
Parameters: contourShift (float) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CurvatureSectionPlane¶
-
FaceCurvatureAnalysisBuilder.
CurvatureSectionPlane
¶ Returns or sets the section curvature plane when sectional curvature values are to be computed and displayed.
-------------------------------------
Getter Method
Signature
CurvatureSectionPlane
Returns: Return type: NXOpen.Plane
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurvatureSectionPlane
Parameters: curvatureSectionPlane ( NXOpen.Plane
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CurvatureType¶
-
FaceCurvatureAnalysisBuilder.
CurvatureType
¶ Returns or sets the curvature type to compute and display.
-------------------------------------
Getter Method
Signature
CurvatureType
Returns: Return type: NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderCurvatureTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurvatureType
Parameters: curvatureType ( NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderCurvatureTypes
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DisplayType¶
-
FaceCurvatureAnalysisBuilder.
DisplayType
¶ Returns or sets the display type for curvature values.
-------------------------------------
Getter Method
Signature
DisplayType
Returns: Return type: NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDisplayTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayType
Parameters: displayType ( NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDisplayTypes
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
MapCenter¶
-
FaceCurvatureAnalysisBuilder.
MapCenter
¶ Returns or sets the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.
-------------------------------------
Getter Method
Signature
MapCenter
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapCenter
Parameters: mapCenter (float) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
MapRange¶
-
FaceCurvatureAnalysisBuilder.
MapRange
¶ Returns or sets the color map and contour range, as % of the full range of curvature values present in the data.
-------------------------------------
Getter Method
Signature
MapRange
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapRange
Parameters: mapRange (float) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NormalOption¶
-
FaceCurvatureAnalysisBuilder.
NormalOption
¶ Returns or sets the normal for the case of normal curvature type.
-------------------------------------
Getter Method
Signature
NormalOption
Returns: Return type: NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDirectionTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalOption
Parameters: normalOption ( NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDirectionTypes
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NormalOrientation¶
-
FaceCurvatureAnalysisBuilder.
NormalOrientation
¶ Returns or sets the normal orientation when the normal curvature values are to be computed and displayed.
-------------------------------------
Getter Method
Signature
NormalOrientation
Returns: Return type: NXOpen.Matrix3x3
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalOrientation
Parameters: normalOrientation ( NXOpen.Matrix3x3
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NormalOrigin¶
-
FaceCurvatureAnalysisBuilder.
NormalOrigin
¶ Returns or sets the normal origin when normal curvature values are to be computed and displayed.
-------------------------------------
Getter Method
Signature
NormalOrigin
Returns: Return type: NXOpen.Point3d
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalOrigin
Parameters: normalOrigin ( NXOpen.Point3d
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NormalVector¶
-
FaceCurvatureAnalysisBuilder.
NormalVector
¶ Returns or sets the normal vector for the case when normal curvature values are to be computed and displayed.
-------------------------------------
Getter Method
Signature
NormalVector
Returns: Return type: NXOpen.Direction
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalVector
Parameters: normalVector ( NXOpen.Direction
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
NumberOfContours¶
-
FaceCurvatureAnalysisBuilder.
NumberOfContours
¶ Returns or sets the number of contour lines to compute and display.
-------------------------------------
Getter Method
Signature
NumberOfContours
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfContours
Parameters: numberOfContours (int) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Resolution¶
-
FaceCurvatureAnalysisBuilder.
Resolution
¶ Returns the tesselation resolution to use for curvature color map and contours.
-------------------------------------
Getter Method
Signature
Resolution
Returns: Return type: NXOpen.GeometricUtilities.DisplayResolutionBuilder
New in version NX9.0.0.
License requirements: None.
ReverseIndividual¶
-
FaceCurvatureAnalysisBuilder.
ReverseIndividual
¶ Returns the individual face normal.
-------------------------------------
Getter Method
Signature
ReverseIndividual
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX9.0.0.
License requirements: None.
ScaleType¶
-
FaceCurvatureAnalysisBuilder.
ScaleType
¶ Returns or sets the scaling type of curvature values.
-------------------------------------
Getter Method
Signature
ScaleType
Returns: Return type: NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderScaleTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScaleType
Parameters: scaleType ( NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderScaleTypes
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SectionOption¶
-
FaceCurvatureAnalysisBuilder.
SectionOption
¶ Returns or sets whether to use a section plane or maninpulator for sectional curvatures.
-------------------------------------
Getter Method
Signature
SectionOption
Returns: Return type: NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDirectionTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionOption
Parameters: sectionOption ( NXOpen.GeometricAnalysis.FaceCurvatureAnalysisBuilderDirectionTypes
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SectionOrientation¶
-
FaceCurvatureAnalysisBuilder.
SectionOrientation
¶ Returns or sets the section orientation for sectional curvatures.
-------------------------------------
Getter Method
Signature
SectionOrientation
Returns: Return type: NXOpen.Matrix3x3
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionOrientation
Parameters: sectionOrientation ( NXOpen.Matrix3x3
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SectionOrigin¶
-
FaceCurvatureAnalysisBuilder.
SectionOrigin
¶ Returns or sets the section origin for sectional curvatures.
-------------------------------------
Getter Method
Signature
SectionOrigin
Returns: Return type: NXOpen.Point3d
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionOrigin
Parameters: sectionOrigin ( NXOpen.Point3d
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SelectObject¶
-
FaceCurvatureAnalysisBuilder.
SelectObject
¶ Returns the faces on which to perform curvature analysis.
-------------------------------------
Getter Method
Signature
SelectObject
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX9.0.0.
License requirements: None.
ShowZeroContour¶
-
FaceCurvatureAnalysisBuilder.
ShowZeroContour
¶ Returns or sets the option to show zero curvature contour line.
-------------------------------------
Getter Method
Signature
ShowZeroContour
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowZeroContour
Parameters: showContour (bool) – New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
DeselectFaces¶
-
FaceCurvatureAnalysisBuilder.
DeselectFaces
¶ Deselects faces
Signature
DeselectFaces(faces)
Parameters: faces (list of NXOpen.DisplayableObject
) –New in version NX11.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ReverseAllNormals¶
-
FaceCurvatureAnalysisBuilder.
ReverseAllNormals
¶ Reverses all normals.
Signature
ReverseAllNormals()
New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ReverseIndividualNormal¶
-
FaceCurvatureAnalysisBuilder.
ReverseIndividualNormal
¶ Reverses an individual face normal.
Signature
ReverseIndividualNormal(face)
Parameters: face ( NXOpen.DisplayableObject
) –New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
UpdateReverseMap¶
-
FaceCurvatureAnalysisBuilder.
UpdateReverseMap
¶ Updates reverse map.
Signature
UpdateReverseMap()
New in version NX9.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Validate¶
-
FaceCurvatureAnalysisBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.