RadiusAnalysisBuilder Class¶

class NXOpen.GeometricAnalysis.RadiusAnalysisBuilder¶

Bases: NXOpen.Builder

Represents a Radius Analysis builder.

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

Default values.

Property	Value
DataRange.IsFixed	1
DataRange.Max	0.01
DataRange.Middle	0.00001
DataRange.MiddleScale	999999
DataRange.Min	-0.01
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 radius analysis data range.
DisplayMode	Returns or sets the display mode.
DisplaySettings	Returns the radius analysis display settings.
Faces	Returns the face to apply radius analysis.
Normals	Returns the radius analysis normals.
NumberOfContourLines	Returns or sets the number of contour lines.
Plane	Returns or sets the reference plane used for `NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes.Sectional`.
SpikeLength	Returns or sets the spike length.
Tag	Returns the Tag for this object.
Type	Returns or sets the radius type.
Vector	Returns or sets the reference vector for `NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes.Normal`.

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.
StartRadiusAnalysis	Start radius analysis.
UpdateDisplayOnPlaneChange	Update display after plane changes.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

RadiusAnalysisBuilderDisplayModes Enumeration	The display type.
RadiusAnalysisBuilderTypes Enumeration	Represents the radius type.

Property Detail¶

DataRange¶

RadiusAnalysisBuilder.DataRange¶

Returns the radius analysis data range.

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

Getter Method

Signature DataRange()

Returns:
Return type:	`NXOpen.GeometricAnalysis.FaceAnalysisDataRangeBuilder`

New in version NX11.0.0.

License requirements: None.

DisplayMode¶

RadiusAnalysisBuilder.DisplayMode¶

Returns or sets the display mode.

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

Getter Method

Signature DisplayMode()

Returns:
Return type:	`NXOpen.GeometricAnalysis.RadiusAnalysisBuilderDisplayModes`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature DisplayMode(displayMode)

Parameters:	displayMode (`NXOpen.GeometricAnalysis.RadiusAnalysisBuilderDisplayModes`) –

New in version NX11.0.0.

License requirements: None.

DisplaySettings¶

RadiusAnalysisBuilder.DisplaySettings¶

Returns the radius analysis display settings.

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

Getter Method

Signature DisplaySettings()

Returns:
Return type:	`NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilder`

New in version NX11.0.0.

License requirements: None.

Faces¶

RadiusAnalysisBuilder.Faces¶

Returns the face to apply radius analysis.

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

Getter Method

Signature Faces()

Returns:
Return type:	`NXOpen.SelectDisplayableObjectList`

New in version NX11.0.0.

License requirements: None.

Normals¶

RadiusAnalysisBuilder.Normals¶

Returns the radius analysis normals.

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

Getter Method

Signature Normals()

Returns:
Return type:	`NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilder`

New in version NX11.0.0.

License requirements: None.

NumberOfContourLines¶

RadiusAnalysisBuilder.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(numberOfContourLines)

Parameters:	numberOfContourLines (int) –

New in version NX11.0.0.

License requirements: None.

Plane¶

RadiusAnalysisBuilder.Plane¶

Returns or sets the reference plane used for NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes.Sectional.

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

Getter Method

Signature Plane()

Returns:
Return type:	`NXOpen.Plane`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Plane(plane)

Parameters:	plane (`NXOpen.Plane`) –

New in version NX11.0.0.

License requirements: None.

SpikeLength¶

RadiusAnalysisBuilder.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(spikeLength)

Parameters:	spikeLength (float) –

New in version NX11.0.0.

License requirements: None.

Type¶

RadiusAnalysisBuilder.Type¶

Returns or sets the radius type.

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

Getter Method

Signature Type()

Returns:
Return type:	`NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Type(type)

Parameters:	type (`NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes`) –

New in version NX11.0.0.

License requirements: None.

Vector¶

RadiusAnalysisBuilder.Vector¶

Returns or sets the reference vector for NXOpen.GeometricAnalysis.RadiusAnalysisBuilderTypes.Normal.

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

Getter Method

Signature Vector()

Returns:
Return type:	`NXOpen.Direction`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Vector(vector)

Parameters:	vector (`NXOpen.Direction`) –

New in version NX11.0.0.

License requirements: None.

Method Detail¶

StartRadiusAnalysis¶

RadiusAnalysisBuilder.StartRadiusAnalysis¶

Start radius analysis.

Signature StartRadiusAnalysis()

New in version NX11.0.0.

License requirements: None.

UpdateDisplayOnPlaneChange¶

RadiusAnalysisBuilder.UpdateDisplayOnPlaneChange¶

Update display after plane changes.

Signature UpdateDisplayOnPlaneChange()

New in version NX11.0.0.

License requirements: None.

Validate¶

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