WrapBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# WrapBuilder Class

class `NXOpen.Features.``WrapBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.WrapUnwrap` builder.

  This class is used in the process of creating or editing a wrap or unwrap curve feature, as well as creating wrapped or unwrapped curves not associated to a feature.

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

  Default values.

  Property | Value
  --- | ---
  AngleTolerance | 0.5
  Associative | 1
  CutLineAngle.Value | 180 (millimeters part), 180 (inches part)
  DistanceTolerance | 0.0254 (millimeters part), 0.001 (inches part)

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.
Associative | Returns or sets the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created.
Curves | Returns the curves that are being wrapped or unwrapped.
CutLineAngle | Returns the angle, measured from the point of tangency of the plane and the faces, at which curves will be split during the wrapping operation.
DistanceTolerance | Returns or sets the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.
Faces | Returns the faces that the curves are being unwrapped from or wrapped to.
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
Plane | Returns the planar face or datum plane that the curves are being wrapped from or unwrapped to.
SpecifyPlane | Returns or sets the specified plane that the curves are being wrapped from or unwrapped to.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the type of operation being performed.

# 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

WrapBuilderTypes Enumeration | Settings for the type of wrap operation being performed.

# Property Detail

## AngleTolerance

`WrapBuilder.``AngleTolerance`

  Returns or sets the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Associative

`WrapBuilder.``Associative`

  Returns or sets the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created.

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Curves

`WrapBuilder.``Curves`

  Returns the curves that are being wrapped or unwrapped.

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

  Getter Method

  Signature `Curves`

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

  New in version NX6.0.0.

  License requirements: None.

## CutLineAngle

`WrapBuilder.``CutLineAngle`

  Returns the angle, measured from the point of tangency of the plane and the faces, at which curves will be split during the wrapping operation.

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

  Getter Method

  Signature `CutLineAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## DistanceTolerance

`WrapBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Faces

`WrapBuilder.``Faces`

  Returns the faces that the curves are being unwrapped from or wrapped to.

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

  Getter Method

  Signature `Faces`

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

  New in version NX6.0.0.

  License requirements: None.

## Plane

`WrapBuilder.``Plane`

  Returns the planar face or datum plane that the curves are being wrapped from or unwrapped to.

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

  Getter Method

  Signature `Plane`

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

  New in version NX6.0.0.

  License requirements: None.

## SpecifyPlane

`WrapBuilder.``SpecifyPlane`

  Returns or sets the specified plane that the curves are being wrapped from or unwrapped to.

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

  Getter Method

  Signature `SpecifyPlane`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SpecifyPlane`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Type

`WrapBuilder.``Type`

  Returns or sets the type of operation being performed.

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

  Getter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

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