PatternFill Class — NXOpen Python API Reference 12.0.0 documentation

# PatternFill Class

class `NXOpen.GeometricUtilities.``PatternFill`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  the pattern fill definition.

  Allows to speicify a section boundary with an offset margin. .. versionadded:: NX7.5.0

# Properties

Property | Description
--- | ---
ApplyMarginToInnerBoundToggle | Returns or sets the applyMarginToInnerBoundToggle, a logical flag to indicate if we need to apply the margin value to internal bounday.
FaceBoundary | Returns the face boundary
FillBoundary | Returns the fill boundary
FillMargin | Returns the fill margin
FillOptions | Returns or sets the fill options
InternalBoundary | Returns the fill boundary
SimplifiedBoundaryToggle | Returns or sets the simplifiedBoundaryToggle, a logical flag to indicate a special case for Linear, Circular, Spiral, or Polygon.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

PatternFillPatternFillOptions Enumeration | This defines Fill Types

# Property Detail

## ApplyMarginToInnerBoundToggle

`PatternFill.``ApplyMarginToInnerBoundToggle`

  Returns or sets the applyMarginToInnerBoundToggle, a logical flag to indicate if we need to apply the margin value to internal bounday.

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

  Getter Method

  Signature `ApplyMarginToInnerBoundToggle`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ApplyMarginToInnerBoundToggle`

  Parameters: | applyMarginToInnerBoundToggle (bool) –

  New in version NX8.0.0.

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

## FaceBoundary

`PatternFill.``FaceBoundary`

  Returns the face boundary

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

  Getter Method

  Signature `FaceBoundary`

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

  New in version NX7.5.0.

  License requirements: None.

## FillBoundary

`PatternFill.``FillBoundary`

  Returns the fill boundary

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

  Getter Method

  Signature `FillBoundary`

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

  New in version NX7.5.0.

  License requirements: None.

## FillMargin

`PatternFill.``FillMargin`

  Returns the fill margin

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

  Getter Method

  Signature `FillMargin`

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

  New in version NX7.5.0.

  License requirements: None.

## FillOptions

`PatternFill.``FillOptions`

  Returns or sets the fill options

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

  Getter Method

  Signature `FillOptions`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.PatternFillPatternFillOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FillOptions`

  Parameters: | fillOptions (`NXOpen.GeometricUtilities.PatternFillPatternFillOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## InternalBoundary

`PatternFill.``InternalBoundary`

  Returns the fill boundary

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

  Getter Method

  Signature `InternalBoundary`

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

  New in version NX8.0.0.

  License requirements: None.

## SimplifiedBoundaryToggle

`PatternFill.``SimplifiedBoundaryToggle`

  Returns or sets the simplifiedBoundaryToggle, a logical flag to indicate a special case for Linear, Circular, Spiral, or Polygon.

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

  Getter Method

  Signature `SimplifiedBoundaryToggle`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SimplifiedBoundaryToggle`

  Parameters: | simplifiedBoundaryToggle (bool) –

  New in version NX8.0.0.

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

# Method Detail

## Validate

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