FacetBodyFromBodyBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FacetBodyFromBodyBuilder Class

class `NXOpen.Facet.``FacetBodyFromBodyBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Facet.FacetBodyFromBodyBuilder` builder.

  It converts the selected analytic bodies to NX convergent bodies bodies. The original inputs are deleted.

  To create a new instance of this class, use `NXOpen.Facet.FacetModelingCollection.CreateFacetBodyFromBodyBuilder()`

  Default values.

  Property | Value
  --- | ---
  Associative | False
  MaximumDeviation | 0.1 (millimeters part), 0.005 (inches part)
  OriginalBodyOption | Hide
  OutputType | ConvergentBody

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the option that specifies whether the facet body from body operation is associative
MaximumDeviation | Returns or sets the maximum deviation
NonFacetedBodiesToConvert | Returns the input non-faceted bodies to convert
OriginalBodyOption | Returns or sets the original body option of enum
OutputType | Returns or sets the output of the type of enum
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.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

FacetBodyFromBodyBuilderOriginalBodyOptions Enumeration | These options represent the options for handling original body: Keep, Hide, Delete
FacetBodyFromBodyBuilderOutputTypes Enumeration | These options represent the type of output body

# Property Detail

## Associative

`FacetBodyFromBodyBuilder.``Associative`

  Returns or sets the option that specifies whether the facet body from body operation is associative

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX11.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MaximumDeviation

`FacetBodyFromBodyBuilder.``MaximumDeviation`

  Returns or sets the maximum deviation

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

  Getter Method

  Signature `MaximumDeviation`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaximumDeviation`

  Parameters: | maximumDeviation (float) –

  New in version NX10.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## NonFacetedBodiesToConvert

`FacetBodyFromBodyBuilder.``NonFacetedBodiesToConvert`

  Returns the input non-faceted bodies to convert

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

  Getter Method

  Signature `NonFacetedBodiesToConvert`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX10.0.0.

  License requirements: None.

## OriginalBodyOption

`FacetBodyFromBodyBuilder.``OriginalBodyOption`

  Returns or sets the original body option of enum

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

  Getter Method

  Signature `OriginalBodyOption`

  Returns: |
  Return type: | `NXOpen.Facet.FacetBodyFromBodyBuilderOriginalBodyOptions`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OriginalBodyOption`

  Parameters: | enumOriginalBodyOption (`NXOpen.Facet.FacetBodyFromBodyBuilderOriginalBodyOptions`) –

  New in version NX11.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## OutputType

`FacetBodyFromBodyBuilder.``OutputType`

  Returns or sets the output of the type of enum

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

  Getter Method

  Signature `OutputType`

  Returns: |
  Return type: | `NXOpen.Facet.FacetBodyFromBodyBuilderOutputTypes`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputType`

  Parameters: | enumOutputType (`NXOpen.Facet.FacetBodyFromBodyBuilderOutputTypes`) –

  New in version NX11.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

# Method Detail

## Validate

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