FillBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FillBuilder Class

class `NXOpen.Die.``FillBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents an Area Fill feature

  To create a new instance of this class, use `NXOpen.Die.DieCollection.Fill()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance of the area fill
CopyAndMirror | Returns or sets the copy and mirror setting of the area fill
DistanceTolerance | Returns or sets the distance tolerance of the area fill
FillForAddendum | Returns or sets the fill for addendum setting of the area fill
MirrorPlane | Returns or sets the plane to mirror the area fill about
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
PointInRegion | Returns or sets the point in region of the area fill
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TippedProduct | Returns or sets the tipped product of the area fill

# 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.
GetFillShape | Gets the fill shape of the area fill
GetObject | Returns the object currently being edited by this builder.
GetRegionBounds | Gets the region bounds of the area fill
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetFillShape | Sets the fill shape of the area fill
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetRegionBounds | Sets the region bounds of the area fill
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.

# Property Detail

## AngleTolerance

`FillBuilder.``AngleTolerance`

  Returns or sets the angle tolerance of the area fill

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## CopyAndMirror

`FillBuilder.``CopyAndMirror`

  Returns or sets the copy and mirror setting of the area fill

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

  Getter Method

  Signature `CopyAndMirror`

  Returns: | = true - original sheet body will be copied in its current

  position and a copy will also be mirrored. the two sheet bodies will be sewn together on output = false - only mirrored copy will be produced :rtype: bool

  New in version NX4.0.1.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `CopyAndMirror`

  Parameters: | copyAndMirror (bool) – = true - original sheet body will be copied in its current position and a copy will also be mirrored. the two sheet bodies will be sewn together on output = false - only mirrored copy will be produced

  New in version NX4.0.1.

  License requirements: die_engineering (“DIE ENGINEERING”)

## DistanceTolerance

`FillBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance of the area fill

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## FillForAddendum

`FillBuilder.``FillForAddendum`

  Returns or sets the fill for addendum setting of the area fill

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

  Getter Method

  Signature `FillForAddendum`

  Returns: | = true - area fill is for addendum and will be called

  DIE_ADDENDUM_FILL :rtype: bool

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `FillForAddendum`

  Parameters: | fillForAddendum (bool) – = true - area fill is for addendum and will be called DIE_ADDENDUM_FILL

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## MirrorPlane

`FillBuilder.``MirrorPlane`

  Returns or sets the plane to mirror the area fill about

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

  Getter Method

  Signature `MirrorPlane`

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

  New in version NX4.0.1.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `MirrorPlane`

  Parameters: | mirrorPlane (`NXOpen.ISurface`) –

  New in version NX4.0.1.

  License requirements: die_engineering (“DIE ENGINEERING”)

## PointInRegion

`FillBuilder.``PointInRegion`

  Returns or sets the point in region of the area fill

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

  Getter Method

  Signature `PointInRegion`

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

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `PointInRegion`

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

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## TippedProduct

`FillBuilder.``TippedProduct`

  Returns or sets the tipped product of the area fill

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

  Getter Method

  Signature `TippedProduct`

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

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `TippedProduct`

  Parameters: | tippedProduct (`NXOpen.Features.Feature`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

# Method Detail

## GetFillShape

`FillBuilder.``GetFillShape`

  Gets the fill shape of the area fill

  Signature `GetFillShape()`

  Returns: | bodies
  Return type: | list of `NXOpen.Body`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetRegionBounds

`FillBuilder.``GetRegionBounds`

  Gets the region bounds of the area fill

  Signature `GetRegionBounds()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. profile entries direction is a `NXOpen.Die.DirectionOption`. Profile direction

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetFillShape

`FillBuilder.``SetFillShape`

  Sets the fill shape of the area fill

  Signature `SetFillShape(bodies)`

  Parameters: | bodies (list of `NXOpen.Body`) – bodies

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetRegionBounds

`FillBuilder.``SetRegionBounds`

  Sets the region bounds of the area fill

  Signature `SetRegionBounds(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction
  - profileEntries (list of `NXOpen.IProfile`) – profile entries

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## Validate

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