DistanceAnalysisBuilder Class¶
-
class
NXOpen.GeometricAnalysis.DistanceAnalysisBuilder¶ Bases:
NXOpen.BuilderRepresents a Distance Analysis builder.
To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollectionEx.CreateDistanceAnalysisBuilder()Default values.
Property Value DataRange.IsFixed 1 DataRange.Max 0.010000 DataRange.Middle 0.000000 DataRange.MiddleScale 0.000000 DataRange.Min -0.010000 DataRange.ZoomScale 8 DisplayMode Fringe DisplaySettings.CanShowFacet 0 DisplaySettings.ColorLegendOption Blend DisplaySettings.DisplayResolution.AngleTolerance 15.0 DisplaySettings.DisplayResolution.EdgeTolerance 0.005 DisplaySettings.DisplayResolution.FaceTolerance 0.005 DisplaySettings.DisplayResolution.Resolution Standard DisplaySettings.DisplayResolution.WidthTolerance 0.3 DisplaySettings.NumberOfColors Seven NumberOfContourLines 8 SpikeLength 25.4 (millimeters part), 1.0 (inches part) New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| DataRange | Returns the distance analysis data range. |
| DisplayMode | Returns or sets the display mode. |
| DisplaySettings | Returns the distance analysis display settings. |
| Faces | Returns the face to apply distance analysis. |
| Normals | Returns the distance analysis normals. |
| NumberOfContourLines | Returns or sets the number of contour lines. |
| Plane | Returns or sets the reference plane for distance analysis. |
| SpikeLength | Returns or sets the spike length. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| StartDistanceAnalysis | Start distance analysis. |
| UpdateDisplayOnPlaneChange | Update display after plane changes. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| DistanceAnalysisBuilderDisplayModes Enumeration | The display type. |
Property Detail¶
DataRange¶
-
DistanceAnalysisBuilder.DataRange¶ Returns the distance analysis data range.
-------------------------------------Getter Method
Signature
DataRangeReturns: Return type: NXOpen.GeometricAnalysis.FaceAnalysisDataRangeBuilderNew in version NX11.0.0.
License requirements: None.
DisplayMode¶
-
DistanceAnalysisBuilder.DisplayMode¶ Returns or sets the display mode.
-------------------------------------Getter Method
Signature
DisplayModeReturns: Return type: NXOpen.GeometricAnalysis.DistanceAnalysisBuilderDisplayModesNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayModeParameters: displayMode ( NXOpen.GeometricAnalysis.DistanceAnalysisBuilderDisplayModes) –New in version NX11.0.0.
License requirements: None.
DisplaySettings¶
-
DistanceAnalysisBuilder.DisplaySettings¶ Returns the distance analysis display settings.
-------------------------------------Getter Method
Signature
DisplaySettingsReturns: Return type: NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilderNew in version NX11.0.0.
License requirements: None.
Faces¶
-
DistanceAnalysisBuilder.Faces¶ Returns the face to apply distance analysis.
-------------------------------------Getter Method
Signature
FacesReturns: Return type: NXOpen.SelectDisplayableObjectListNew in version NX11.0.0.
License requirements: None.
Normals¶
-
DistanceAnalysisBuilder.Normals¶ Returns the distance analysis normals.
-------------------------------------Getter Method
Signature
NormalsReturns: Return type: NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilderNew in version NX11.0.0.
License requirements: None.
NumberOfContourLines¶
-
DistanceAnalysisBuilder.NumberOfContourLines¶ Returns or sets the number of contour lines.
-------------------------------------Getter Method
Signature
NumberOfContourLinesReturns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NumberOfContourLinesParameters: numberOfContourLines (int) – New in version NX11.0.0.
License requirements: None.
Plane¶
-
DistanceAnalysisBuilder.Plane¶ Returns or sets the reference plane for distance analysis.
-------------------------------------Getter Method
Signature
PlaneReturns: Return type: NXOpen.PlaneNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneParameters: plane ( NXOpen.Plane) –New in version NX11.0.0.
License requirements: None.
SpikeLength¶
-
DistanceAnalysisBuilder.SpikeLength¶ Returns or sets the spike length.
-------------------------------------Getter Method
Signature
SpikeLengthReturns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpikeLengthParameters: spikeLength (float) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
StartDistanceAnalysis¶
-
DistanceAnalysisBuilder.StartDistanceAnalysis¶ Start distance analysis.
Signature
StartDistanceAnalysis()New in version NX11.0.0.
License requirements: None.
UpdateDisplayOnPlaneChange¶
-
DistanceAnalysisBuilder.UpdateDisplayOnPlaneChange¶ Update display after plane changes.
Signature
UpdateDisplayOnPlaneChange()New in version NX11.0.0.
License requirements: None.
Validate¶
-
DistanceAnalysisBuilder.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.