PatternFaceFeatureBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PatternFaceFeatureBuilder Class

class `NXOpen.Features.``PatternFaceFeatureBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a builder for a pattern face feature, post NX9.

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

  Default values.

  Property | Value
  --- | ---
  CopyChamferLabels | false
  PatternDefinition.AlongPathDefinition.XOnPathSpacing.NCopies.Value | 2
  PatternDefinition.AlongPathDefinition.XOnPathSpacing.SpaceType | Offset
  PatternDefinition.AlongPathDefinition.XPathOption | Offset
  PatternDefinition.AlongPathDefinition.YDirectionOption | Section
  PatternDefinition.AlongPathDefinition.YOnPathSpacing.NCopies.Value | 1
  PatternDefinition.AlongPathDefinition.YPathOption | Offset
  PatternDefinition.AlongPathDefinition.YSpacing.NCopies.Value | 1
  PatternDefinition.AlongPathDefinition.YSpacing.PitchDistance.Value | 10 (millimeters part), 1 (inches part)
  PatternDefinition.AlongPathDefinition.YSpacing.SpaceType | Offset
  PatternDefinition.AlongPathDefinition.YSpacing.SpanDistance.Value | 100 (millimeters part), 10 (inches part)
  PatternDefinition.CircularDefinition.AngularSpacing.NCopies.Value | 12
  PatternDefinition.CircularDefinition.AngularSpacing.PitchAngle.Value | 30
  PatternDefinition.CircularDefinition.AngularSpacing.PitchDistance.Value | 10 (millimeters part), 1 (inches part)
  PatternDefinition.CircularDefinition.AngularSpacing.SpaceType | Offset
  PatternDefinition.CircularDefinition.AngularSpacing.SpanAngle.Value | 360 (millimeters part), 360 (inches part)
  PatternDefinition.CircularDefinition.AngularSpacing.UsePitchOption | Angle
  PatternDefinition.CircularDefinition.CreateLastStaggered | true
  PatternDefinition.CircularDefinition.HorizontalRef.RotationAngle.Value | 0 (millimeters part), 0 (inches part)
  PatternDefinition.CircularDefinition.IncludeSeedToggle | true
  PatternDefinition.CircularDefinition.RadialSpacing.NCopies.Value | 1
  PatternDefinition.CircularDefinition.StaggerType | None
  PatternDefinition.HelixDefinition.AnglePitch.Value | 30
  PatternDefinition.HelixDefinition.CountOfInstances.Value | 6
  PatternDefinition.HelixDefinition.DirectionType | Righthand
  PatternDefinition.HelixDefinition.DistancePitch.Value | 10 (millimeters part), 0.4 (inches part)
  PatternDefinition.HelixDefinition.HelixPitch.Value | 50 (millimeters part), 2 (inches part)
  PatternDefinition.HelixDefinition.HelixSpan.Value | 100 (millimeters part), 4 (inches part)
  PatternDefinition.HelixDefinition.NumberOfTurns.Value | 2
  PatternDefinition.HelixDefinition.SizeOption | CountAngleDistance
  PatternDefinition.PatternFill.FillMargin.Value | 0 (millimeters part), 0 (inches part)
  PatternDefinition.PatternFill.FillOptions | None
  PatternDefinition.PatternFill.SimplifiedBoundaryToggle | False
  PatternDefinition.PatternOrientation.AlongOrientationOption | NormalToPath
  PatternDefinition.PatternOrientation.CircularOrientationOption | FollowPattern
  PatternDefinition.PatternOrientation.FollowFaceProjDirOption | PatternPlaneNormal
  PatternDefinition.PatternOrientation.GeneralOrientationOption | Fixed
  PatternDefinition.PatternOrientation.HelixOrientationOption | FollowPattern
  PatternDefinition.PatternOrientation.LinearOrientationOption | Fixed
  PatternDefinition.PatternOrientation.MirrorOrientationOption | FollowPattern
  PatternDefinition.PatternOrientation.OrientationOption | Fixed
  PatternDefinition.PatternOrientation.PolygonOrientationOption | FollowPattern
  PatternDefinition.PatternOrientation.SpiralOrientationOption | FollowPattern
  PatternDefinition.PatternType | Linear
  PatternDefinition.PolygonDefinition.NumberOfSides.Value | 6
  PatternDefinition.PolygonDefinition.PolygonSizeOption | Inscribed
  PatternDefinition.PolygonDefinition.PolygonSpacing.NCopies.Value | 4
  PatternDefinition.PolygonDefinition.PolygonSpacing.PitchDistance.Value | 25 (millimeters part), 1 (inches part)
  PatternDefinition.PolygonDefinition.PolygonSpacing.SpaceType | Offset
  PatternDefinition.PolygonDefinition.PolygonSpacing.SpanAngle.Value | 360
  PatternDefinition.PolygonDefinition.RadialSpacing.NCopies.Value | 1
  PatternDefinition.PolygonDefinition.RadialSpacing.PitchDistance.Value | 25 (millimeters part), 1 (inches part)
  PatternDefinition.PolygonDefinition.RadialSpacing.SpanDistance.Value | 100 (millimeters part), 4 (inches part)
  PatternDefinition.RectangularDefinition.CreateLastStaggered | true
  PatternDefinition.RectangularDefinition.SimplifiedLayoutType | Square
  PatternDefinition.RectangularDefinition.StaggerType | None
  PatternDefinition.RectangularDefinition.XSpacing.NCopies.Value | 2
  PatternDefinition.RectangularDefinition.YSpacing.NCopies.Value | 1
  PatternDefinition.SpiralDefinition.DirectionType | Lefthand
  PatternDefinition.SpiralDefinition.NumberOfTurns.Value | 1 (millimeters part), 1 (inches part)
  PatternDefinition.SpiralDefinition.RadialPitch.Value | 50 (millimeters part), 2 (inches part)
  PatternDefinition.SpiralDefinition.SizeSpiralType | NumberOfTurns
  PatternDefinition.SpiralDefinition.TotalAngle.Value | 360 (millimeters part), 360 (inches part)

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CopyChamferLabels | Returns or sets the chamfer label options .
FaceCollector | Returns the face collector.
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
PatternDefinition | Returns the pattern definition service.
ReferencePoint | Returns the reference point service.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# 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.

# Property Detail

## CopyChamferLabels

`PatternFaceFeatureBuilder.``CopyChamferLabels`

  Returns or sets the chamfer label options .

  ‘true’ if the chamfer faces should be labeled automatically ‘false’ if the chamfer faces should not be labeled automatically

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

  Getter Method

  Signature `CopyChamferLabels`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CopyChamferLabels`

  Parameters: | shouldLabelChamfer (bool) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## FaceCollector

`PatternFaceFeatureBuilder.``FaceCollector`

  Returns the face collector.

  Collects the input faces to pattern

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

  Getter Method

  Signature `FaceCollector`

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

  New in version NX9.0.0.

  License requirements: None.

## PatternDefinition

`PatternFaceFeatureBuilder.``PatternDefinition`

  Returns the pattern definition service.

  This is the object that determines the type of pattern and holds the associated data that comes with it.

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

  Getter Method

  Signature `PatternDefinition`

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

  New in version NX9.0.0.

  License requirements: None.

## ReferencePoint

`PatternFaceFeatureBuilder.``ReferencePoint`

  Returns the reference point service.

  This contains the origin for creating pattern based transformations

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

  Getter Method

  Signature `ReferencePoint`

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

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

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