PatchOpeningsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PatchOpeningsBuilder Class

class `NXOpen.Features.``PatchOpeningsBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a builder for a Patch Openings feature.

  This allows creation and editing of a Patch Openings feature.

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

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
CutoutLength | Returns the cutout length, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
CutoutRadius | Returns the cutout radius, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
Distance | Returns the extension distance, used only when type is `Features.PatchOpeningsBuilderTypes.Extension`
DistanceTolerance | Returns or sets the distance tolerance.
DividingCurves | Returns the curves used to divide the opening.
Faces | Returns the faces to form patching boundary.
Limits | Returns the limits to control the span of the patch
Openings | Returns the edges defining the openings to patch.
Output | Returns or sets the type of output desired - one feature, multiple features, sewn.
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
ShelfLength | Returns the shelf length, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
ShelfPoint1 | Returns or sets the first shelf point, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
ShelfPoint2 | Returns or sets the second shelf point, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
ShelfRadius | Returns the shelf radius, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the method used to patch the opening

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreatePathFromOpening | Create a closed curve (path) from the currently selected opening.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
FindOpenings | Find all valid openings based upon input faces.
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

PatchOpeningsBuilderOutputTypes Enumeration | Indicates what to output
PatchOpeningsBuilderTypes Enumeration | The method used to patch the opening

# Property Detail

## CutoutLength

`PatchOpeningsBuilder.``CutoutLength`

  Returns the cutout length, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `CutoutLength`

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

  New in version NX7.5.0.

  License requirements: None.

## CutoutRadius

`PatchOpeningsBuilder.``CutoutRadius`

  Returns the cutout radius, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `CutoutRadius`

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

  New in version NX7.5.0.

  License requirements: None.

## Distance

`PatchOpeningsBuilder.``Distance`

  Returns the extension distance, used only when type is `Features.PatchOpeningsBuilderTypes.Extension`

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

  Getter Method

  Signature `Distance`

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

  New in version NX6.0.0.

  License requirements: None.

## DistanceTolerance

`PatchOpeningsBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance.

  Used for sewing sheet bodies and joining curves

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distTol (float) –

  New in version NX6.0.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## DividingCurves

`PatchOpeningsBuilder.``DividingCurves`

  Returns the curves used to divide the opening.

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

  Getter Method

  Signature `DividingCurves`

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

  New in version NX7.5.0.

  License requirements: None.

## Faces

`PatchOpeningsBuilder.``Faces`

  Returns the faces to form patching boundary.

  These faces will be sewn into a sheet body internally to determine the internal openings to fill

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

  Getter Method

  Signature `Faces`

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

  New in version NX6.0.0.

  License requirements: None.

## Limits

`PatchOpeningsBuilder.``Limits`

  Returns the limits to control the span of the patch

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

  Getter Method

  Signature `Limits`

  Returns: |
  Return type: | `NXOpen.Die.DieLimitsBuilder`

  New in version NX7.5.0.

  License requirements: None.

## Openings

`PatchOpeningsBuilder.``Openings`

  Returns the edges defining the openings to patch.

  Must define closed loops

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

  Getter Method

  Signature `Openings`

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

  New in version NX6.0.0.

  License requirements: None.

## Output

`PatchOpeningsBuilder.``Output`

  Returns or sets the type of output desired - one feature, multiple features, sewn.

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

  Getter Method

  Signature `Output`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Output`

  Parameters: | type (`NXOpen.Features.PatchOpeningsBuilderOutputTypes`) –

  New in version NX6.0.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## ShelfLength

`PatchOpeningsBuilder.``ShelfLength`

  Returns the shelf length, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `ShelfLength`

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

  New in version NX7.5.0.

  License requirements: None.

## ShelfPoint1

`PatchOpeningsBuilder.``ShelfPoint1`

  Returns or sets the first shelf point, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `ShelfPoint1`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ShelfPoint1`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX7.5.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## ShelfPoint2

`PatchOpeningsBuilder.``ShelfPoint2`

  Returns or sets the second shelf point, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `ShelfPoint2`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ShelfPoint2`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX7.5.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## ShelfRadius

`PatchOpeningsBuilder.``ShelfRadius`

  Returns the shelf radius, used only when type is `Features.PatchOpeningsBuilderTypes.Joggle`

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

  Getter Method

  Signature `ShelfRadius`

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

  New in version NX7.5.0.

  License requirements: None.

## Type

`PatchOpeningsBuilder.``Type`

  Returns or sets the method used to patch the opening

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

  Getter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.PatchOpeningsBuilderTypes`) –

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## CreatePathFromOpening

`PatchOpeningsBuilder.``CreatePathFromOpening`

  Create a closed curve (path) from the currently selected opening.

  Signature `CreatePathFromOpening()`

  Returns: | a tuple
  Return type: | A tuple consisting of (objectArray, path). objectArray is a list of `NXOpen.NXObject`. The opening objects that were used to create the path. path is a `NXOpen.NXObject`. The curve created by combining object_array items.

  New in version NX7.5.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## FindOpenings

`PatchOpeningsBuilder.``FindOpenings`

  Find all valid openings based upon input faces.

  Signature `FindOpenings(filterNoise)`

  Parameters: | filterNoise (bool) – if true, do not allow small openings and exterior edges

  New in version NX7.5.0.

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## Validate

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