SlopeAnalysisBuilder Class

class NXOpen.GeometricAnalysis.SlopeAnalysisBuilder

Bases: NXOpen.Builder

Represents a Slope Analysis builder.

To create a new instance of this class, use NXOpen.GeometricAnalysis.AnalysisObjectCollectionEx.CreateSlopeAnalysisBuilder()

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 slope analysis data range.
DisplayMode Returns or sets the display mode.
DisplaySettings Returns the slope analysis display settings.
Faces Returns the face to apply slope analysis.
Normals Returns the slope analysis normals.
NumberOfContourLines Returns or sets the number of contour lines.
PmiPoint Returns the point to draw labels.
SpikeLength Returns or sets the spike length.
Tag Returns the Tag for this object.
Vector Returns or sets the reference vector used for slope analysis.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreatePMILabel Create a PMI label.
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.
StartSlopeAnalysis Start slope analysis.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SlopeAnalysisBuilderDisplayModes Enumeration The display type.

Property Detail

DataRange

SlopeAnalysisBuilder.DataRange

Returns the slope analysis data range.

-------------------------------------

Getter Method

Signature DataRange

Returns:
Return type:NXOpen.GeometricAnalysis.FaceAnalysisDataRangeBuilder

New in version NX11.0.0.

License requirements: None.

DisplayMode

SlopeAnalysisBuilder.DisplayMode

Returns or sets the display mode.

-------------------------------------

Getter Method

Signature DisplayMode

Returns:
Return type:NXOpen.GeometricAnalysis.SlopeAnalysisBuilderDisplayModes

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayMode

Parameters:displayMode (NXOpen.GeometricAnalysis.SlopeAnalysisBuilderDisplayModes) –

New in version NX11.0.0.

License requirements: None.

DisplaySettings

SlopeAnalysisBuilder.DisplaySettings

Returns the slope analysis display settings.

-------------------------------------

Getter Method

Signature DisplaySettings

Returns:
Return type:NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilder

New in version NX11.0.0.

License requirements: None.

Faces

SlopeAnalysisBuilder.Faces

Returns the face to apply slope analysis.

-------------------------------------

Getter Method

Signature Faces

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX11.0.0.

License requirements: None.

Normals

SlopeAnalysisBuilder.Normals

Returns the slope analysis normals.

-------------------------------------

Getter Method

Signature Normals

Returns:
Return type:NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilder

New in version NX11.0.0.

License requirements: None.

NumberOfContourLines

SlopeAnalysisBuilder.NumberOfContourLines

Returns or sets the number of contour lines.

-------------------------------------

Getter Method

Signature NumberOfContourLines

Returns:
Return type:int

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NumberOfContourLines

Parameters:numberOfContourLines (int) –

New in version NX11.0.0.

License requirements: None.

PmiPoint

SlopeAnalysisBuilder.PmiPoint

Returns the point to draw labels.

-------------------------------------

Getter Method

Signature PmiPoint

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX11.0.0.

License requirements: None.

SpikeLength

SlopeAnalysisBuilder.SpikeLength

Returns or sets the spike length.

-------------------------------------

Getter Method

Signature SpikeLength

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SpikeLength

Parameters:spikeLength (float) –

New in version NX11.0.0.

License requirements: None.

Vector

SlopeAnalysisBuilder.Vector

Returns or sets the reference vector used for slope analysis.

-------------------------------------

Getter Method

Signature Vector

Returns:
Return type:NXOpen.Direction

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Vector

Parameters:vector (NXOpen.Direction) –

New in version NX11.0.0.

License requirements: None.

Method Detail

CreatePMILabel

SlopeAnalysisBuilder.CreatePMILabel

Create a PMI label.

Signature CreatePMILabel(location, face)

Parameters:

New in version NX11.0.0.

License requirements: None.

StartSlopeAnalysis

SlopeAnalysisBuilder.StartSlopeAnalysis

Start slope analysis.

Signature StartSlopeAnalysis()

New in version NX11.0.0.

License requirements: None.

Validate

SlopeAnalysisBuilder.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.