LocalRadiusAnalysisBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LocalRadiusAnalysisBuilder Class

class `NXOpen.GeometricAnalysis.``LocalRadiusAnalysisBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.GeometricAnalysis.LocalRadiusAnalysis` builder

  To create a new instance of this class, use `NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateLocalRadiusAnalysisBuilder()`

  Default values.

  Property | Value
  --- | ---
  VisibilityCoordinates | 0
  VisibilityMaxRadius | 0
  VisibilityMinMaxRadiusTangent | 0
  VisibilityMinRadius | 1
  VisibilityRadius | 1
  VisibilityURadius | 0
  VisibilityUV | 0
  VisibilityUVTangent | 0
  VisibilityVRadius | 0

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
SelectionPoint | Returns the selection point
Tag | Returns the Tag for this object.
VisibilityCoordinates | Returns or sets the toggle coordinates
VisibilityMaxRadius | Returns or sets the toggle max radius show
VisibilityMinMaxRadiusTangent | Returns or sets the toggle min radius tangent
VisibilityMinRadius | Returns or sets the toggle min radius show
VisibilityRadius | Returns or sets the toggle radius show
VisibilityURadius | Returns or sets the toggle uradius show
VisibilityUV | Returns or sets the toggle uv
VisibilityUVTangent | Returns or sets the toggle max radius tangent
VisibilityVRadius | Returns or sets the toggle vradius show

# Methods

Method | Description
--- | ---
ButtonOpenInformationWindow | TODO: fill in a description for this
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.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## SelectionPoint

`LocalRadiusAnalysisBuilder.``SelectionPoint`

  Returns the selection point

  `-------------------------------------`

  Getter Method

  Signature `SelectionPoint`

  Returns: |
  Return type: | `NXOpen.Features.GeometricConstraintDataManager`

  New in version NX8.5.0.

  License requirements: None.

## VisibilityCoordinates

`LocalRadiusAnalysisBuilder.``VisibilityCoordinates`

  Returns or sets the toggle coordinates

  `-------------------------------------`

  Getter Method

  Signature `VisibilityCoordinates`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityCoordinates`

  Parameters: | visibilityCoordinates (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityMaxRadius

`LocalRadiusAnalysisBuilder.``VisibilityMaxRadius`

  Returns or sets the toggle max radius show

  `-------------------------------------`

  Getter Method

  Signature `VisibilityMaxRadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityMaxRadius`

  Parameters: | visibilityMaxRadius (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityMinMaxRadiusTangent

`LocalRadiusAnalysisBuilder.``VisibilityMinMaxRadiusTangent`

  Returns or sets the toggle min radius tangent

  `-------------------------------------`

  Getter Method

  Signature `VisibilityMinMaxRadiusTangent`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityMinMaxRadiusTangent`

  Parameters: | visibilityMinMaxRadiusTangent (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityMinRadius

`LocalRadiusAnalysisBuilder.``VisibilityMinRadius`

  Returns or sets the toggle min radius show

  `-------------------------------------`

  Getter Method

  Signature `VisibilityMinRadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityMinRadius`

  Parameters: | visibilityMinRadius (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityRadius

`LocalRadiusAnalysisBuilder.``VisibilityRadius`

  Returns or sets the toggle radius show

  `-------------------------------------`

  Getter Method

  Signature `VisibilityRadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityRadius`

  Parameters: | visibilityRadius (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityURadius

`LocalRadiusAnalysisBuilder.``VisibilityURadius`

  Returns or sets the toggle uradius show

  `-------------------------------------`

  Getter Method

  Signature `VisibilityURadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityURadius`

  Parameters: | visibilityURadius (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityUV

`LocalRadiusAnalysisBuilder.``VisibilityUV`

  Returns or sets the toggle uv

  `-------------------------------------`

  Getter Method

  Signature `VisibilityUV`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityUV`

  Parameters: | visibilityUV (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityUVTangent

`LocalRadiusAnalysisBuilder.``VisibilityUVTangent`

  Returns or sets the toggle max radius tangent

  `-------------------------------------`

  Getter Method

  Signature `VisibilityUVTangent`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityUVTangent`

  Parameters: | visibilityUVTangent (bool) –

  New in version NX8.5.0.

  License requirements: None.

## VisibilityVRadius

`LocalRadiusAnalysisBuilder.``VisibilityVRadius`

  Returns or sets the toggle vradius show

  `-------------------------------------`

  Getter Method

  Signature `VisibilityVRadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `VisibilityVRadius`

  Parameters: | visibilityVRadius (bool) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## ButtonOpenInformationWindow

`LocalRadiusAnalysisBuilder.``ButtonOpenInformationWindow`

  TODO: fill in a description for this

  Signature `ButtonOpenInformationWindow()`

  New in version NX8.5.0.

  License requirements: None.

## Validate

`LocalRadiusAnalysisBuilder.``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.