DeleteFaceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DeleteFaceBuilder Class

class `NXOpen.Features.``DeleteFaceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a builder for a delete face feature, don’t use it until nx502.

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateDeleteFaceBuilder()`

  Default values.

  Property | Value
  --- | ---
  CapOption | FaceOrPlane
  DeletePartialBlend | False
  FaceEdgeBlendPreference | Cliff
  Heal | True
  HealPlanar | False
  MaxBlendRadius.Value | 5.0 (millimeters part), 0.2 (inches part)
  MaxHoleDiameter.Value | 5.0 (millimeters part), 0.2 (inches part)
  Setback | SelectedBlend
  SpecifyBlend | False
  UseHoleDiameter | True

  New in version NX5.0.2.

# Properties

Property | Description
--- | ---
BlendCollector | Returns the blend collector holding the blends to delete
CapFace | Returns the face or plane to be used as cap face.
CapOption | Returns or sets the cap option.
CapPlane | Returns or sets the new plane to be used as cap face.
DeletePartialBlend | Returns or sets the flag indicating whether to delete the partial blend or not.
FaceCollector | Returns the face collector holding the faces to delete, don’t use it until nx502
FaceEdgeBlendPreference | Returns or sets the preference option indicating wether to delete undetermined blend chain as notch chain or as cliff chain
Heal | Returns or sets the flag specifying whether to heal the body while deleting its face.
HealPlanar | Returns or sets the flag of finding a plane in which all edges of a hole lie and attach this to a face covering the hole during heal hole process, don’t use it until further notification
MaxBlendRadius | Returns the maximal radius of deleted blends, only for delete blend type
MaxHoleDiameter | Returns the maximal diameter of deleted holes, only for delete hole type and only working when use_hole_diameter is true, don’t use it until nx502
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Setback | Returns or sets the set back options.
SpecifyBlend | Returns or sets the flag of treating all input faces as blend, don’t use it until further notification
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the delete face type, don’t use it until nx502
UseHoleDiameter | Returns or sets the flag of using hole diameter to filter hole or not, only for delete hole type and the max hole diameter should be set if it is true, don’t use it until nx502

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DeleteFaceBuilderCapOptionValues Enumeration | Represents the cap option values.
DeleteFaceBuilderFaceEdgeBlendPreferenceOptions Enumeration | Represents the face edge blend preference options.
DeleteFaceBuilderSelectTypes Enumeration | Enumeration of select type, don’t use it until nx502
DeleteFaceBuilderSetbackOptions Enumeration | Represents the set back options.

# Property Detail

## BlendCollector

`DeleteFaceBuilder.``BlendCollector`

  Returns the blend collector holding the blends to delete

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

  Getter Method

  Signature `BlendCollector`

  Returns: | the delete blend collector
  Return type: | `NXOpen.ScCollector`

  New in version NX9.0.0.

  License requirements: None.

## CapFace

`DeleteFaceBuilder.``CapFace`

  Returns the face or plane to be used as cap face.

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

  Getter Method

  Signature `CapFace`

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

  New in version NX8.0.1.

  License requirements: None.

## CapOption

`DeleteFaceBuilder.``CapOption`

  Returns or sets the cap option.

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

  Getter Method

  Signature `CapOption`

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

  New in version NX8.0.1.

  License requirements: None.

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

  Setter Method

  Signature `CapOption`

  Parameters: | capOption (`NXOpen.Features.DeleteFaceBuilderCapOptionValues`) –

  New in version NX8.0.1.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## CapPlane

`DeleteFaceBuilder.``CapPlane`

  Returns or sets the new plane to be used as cap face.

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

  Getter Method

  Signature `CapPlane`

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

  New in version NX8.0.1.

  License requirements: None.

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

  Setter Method

  Signature `CapPlane`

  Parameters: | capPlane (`NXOpen.Plane`) –

  New in version NX8.0.1.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## DeletePartialBlend

`DeleteFaceBuilder.``DeletePartialBlend`

  Returns or sets the flag indicating whether to delete the partial blend or not.

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

  Getter Method

  Signature `DeletePartialBlend`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DeletePartialBlend`

  Parameters: | deletePartialBlend (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## FaceCollector

`DeleteFaceBuilder.``FaceCollector`

  Returns the face collector holding the faces to delete, don’t use it until nx502

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

  Getter Method

  Signature `FaceCollector`

  Returns: | the delete face collector
  Return type: | `NXOpen.ScCollector`

  New in version NX5.0.2.

  License requirements: None.

## FaceEdgeBlendPreference

`DeleteFaceBuilder.``FaceEdgeBlendPreference`

  Returns or sets the preference option indicating wether to delete undetermined blend chain as notch chain or as cliff chain

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

  Getter Method

  Signature `FaceEdgeBlendPreference`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FaceEdgeBlendPreference`

  Parameters: | faceEdgeBlendPreference (`NXOpen.Features.DeleteFaceBuilderFaceEdgeBlendPreferenceOptions`) –

  New in version NX10.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”)

## Heal

`DeleteFaceBuilder.``Heal`

  Returns or sets the flag specifying whether to heal the body while deleting its face.

  If True, body is healed, else it is not.

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

  Getter Method

  Signature `Heal`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Heal`

  Parameters: | heal (bool) –

  New in version NX8.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## HealPlanar

`DeleteFaceBuilder.``HealPlanar`

  Returns or sets the flag of finding a plane in which all edges of a hole lie and attach this to a face covering the hole during heal hole process, don’t use it until further notification

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

  Getter Method

  Signature `HealPlanar`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HealPlanar`

  Parameters: | healPlanar (bool) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## MaxBlendRadius

`DeleteFaceBuilder.``MaxBlendRadius`

  Returns the maximal radius of deleted blends, only for delete blend type

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

  Getter Method

  Signature `MaxBlendRadius`

  Returns: | the maximal radius expression
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## MaxHoleDiameter

`DeleteFaceBuilder.``MaxHoleDiameter`

  Returns the maximal diameter of deleted holes, only for delete hole type and only working when use_hole_diameter is true, don’t use it until nx502

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

  Getter Method

  Signature `MaxHoleDiameter`

  Returns: | the maximal diameter expression
  Return type: | `NXOpen.Expression`

  New in version NX5.0.2.

  License requirements: None.

## Setback

`DeleteFaceBuilder.``Setback`

  Returns or sets the set back options.

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

  Getter Method

  Signature `Setback`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Setback`

  Parameters: | setback (`NXOpen.Features.DeleteFaceBuilderSetbackOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## SpecifyBlend

`DeleteFaceBuilder.``SpecifyBlend`

  Returns or sets the flag of treating all input faces as blend, don’t use it until further notification

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

  Getter Method

  Signature `SpecifyBlend`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SpecifyBlend`

  Parameters: | specifyBlend (bool) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## Type

`DeleteFaceBuilder.``Type`

  Returns or sets the delete face type, don’t use it until nx502

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

  Getter Method

  Signature `Type`

  Returns: | the delete face type
  Return type: | `NXOpen.Features.DeleteFaceBuilderSelectTypes`

  New in version NX5.0.2.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | selectType (`NXOpen.Features.DeleteFaceBuilderSelectTypes`) – the delete face type

  New in version NX5.0.2.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## UseHoleDiameter

`DeleteFaceBuilder.``UseHoleDiameter`

  Returns or sets the flag of using hole diameter to filter hole or not, only for delete hole type and the max hole diameter should be set if it is true, don’t use it until nx502

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

  Getter Method

  Signature `UseHoleDiameter`

  Returns: | the flag of use hole diameter
  Return type: | bool

  New in version NX5.0.2.

  License requirements: None.

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

  Setter Method

  Signature `UseHoleDiameter`

  Parameters: | useHoleDiameter (bool) – the flag of use hole diameter

  New in version NX5.0.2.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## Validate

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