PatternGeometryBuilder Class¶
-
class
NXOpen.Features.PatternGeometryBuilder¶ Bases:
NXOpen.Features.FeatureBuilderThis class represents the builder to be used to create Pattern Geometry features.
Inputs to this class can be convergent objects.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreatePatternGeometryBuilder()Default values.
Property Value CopyThreads 1 HideOriginal 0 IsAssociative 1 PatternService.AlongPathDefinition.XOnPathSpacing.NCopies.Value 2 PatternService.AlongPathDefinition.XOnPathSpacing.SpaceType Offset PatternService.AlongPathDefinition.XPathOption Offset PatternService.AlongPathDefinition.YDirectionOption Section PatternService.AlongPathDefinition.YOnPathSpacing.NCopies.Value 1 PatternService.AlongPathDefinition.YPathOption Offset PatternService.AlongPathDefinition.YSpacing.NCopies.Value 1 PatternService.AlongPathDefinition.YSpacing.PitchDistance.Value 10 (millimeters part), 1 (inches part) PatternService.AlongPathDefinition.YSpacing.SpaceType Offset PatternService.AlongPathDefinition.YSpacing.SpanDistance.Value 100 (millimeters part), 10 (inches part) PatternService.CircularDefinition.AngularSpacing.NCopies.Value 12 PatternService.CircularDefinition.AngularSpacing.PitchAngle.Value 30 PatternService.CircularDefinition.AngularSpacing.PitchDistance.Value 10 (millimeters part), 1 (inches part) PatternService.CircularDefinition.AngularSpacing.SpaceType Offset PatternService.CircularDefinition.AngularSpacing.SpanAngle.Value 360 (millimeters part), 360 (inches part) PatternService.CircularDefinition.AngularSpacing.UsePitchOption Angle PatternService.CircularDefinition.CreateLastStaggered true PatternService.CircularDefinition.HorizontalRef.RotationAngle.Value 0 (millimeters part), 0 (inches part) PatternService.CircularDefinition.IncludeSeedToggle true PatternService.CircularDefinition.RadialSpacing.NCopies.Value 1 PatternService.CircularDefinition.StaggerType None PatternService.HelixDefinition.AnglePitch.Value 30 PatternService.HelixDefinition.CountOfInstances.Value 6 PatternService.HelixDefinition.DirectionType Righthand PatternService.HelixDefinition.DistancePitch.Value 10 (millimeters part), 0.4 (inches part) PatternService.HelixDefinition.HelixPitch.Value 50 (millimeters part), 2 (inches part) PatternService.HelixDefinition.HelixSpan.Value 100 (millimeters part), 4 (inches part) PatternService.HelixDefinition.NumberOfTurns.Value 2 PatternService.HelixDefinition.SizeOption CountAngleDistance PatternService.PatternFill.FillMargin.Value 0 (millimeters part), 0 (inches part) PatternService.PatternFill.FillOptions None PatternService.PatternFill.SimplifiedBoundaryToggle False PatternService.PatternOrientation.AlongOrientationOption NormalToPath PatternService.PatternOrientation.CircularOrientationOption FollowPattern PatternService.PatternOrientation.FollowFaceProjDirOption PatternPlaneNormal PatternService.PatternOrientation.GeneralOrientationOption Fixed PatternService.PatternOrientation.HelixOrientationOption FollowPattern PatternService.PatternOrientation.LinearOrientationOption Fixed PatternService.PatternOrientation.MirrorOrientationOption FollowPattern PatternService.PatternOrientation.OrientationOption Fixed PatternService.PatternOrientation.PolygonOrientationOption FollowPattern PatternService.PatternOrientation.SpiralOrientationOption FollowPattern PatternService.PatternType Linear PatternService.PolygonDefinition.NumberOfSides.Value 6 PatternService.PolygonDefinition.PolygonSizeOption Inscribed PatternService.PolygonDefinition.PolygonSpacing.NCopies.Value 4 PatternService.PolygonDefinition.PolygonSpacing.PitchDistance.Value 25 (millimeters part), 1 (inches part) PatternService.PolygonDefinition.PolygonSpacing.SpaceType Offset PatternService.PolygonDefinition.PolygonSpacing.SpanAngle.Value 360 PatternService.PolygonDefinition.RadialSpacing.NCopies.Value 1 PatternService.PolygonDefinition.RadialSpacing.PitchDistance.Value 25 (millimeters part), 1 (inches part) PatternService.PolygonDefinition.RadialSpacing.SpanDistance.Value 100 (millimeters part), 4 (inches part) PatternService.RectangularDefinition.CreateLastStaggered true PatternService.RectangularDefinition.SimplifiedLayoutType Square PatternService.RectangularDefinition.StaggerType None PatternService.RectangularDefinition.XSpacing.NCopies.Value 2 PatternService.RectangularDefinition.YSpacing.NCopies.Value 1 PatternService.SpiralDefinition.DirectionType Lefthand PatternService.SpiralDefinition.NumberOfTurns.Value 1 (millimeters part), 1 (inches part) PatternService.SpiralDefinition.RadialPitch.Value 50 (millimeters part), 2 (inches part) PatternService.SpiralDefinition.SizeSpiralType NumberOfTurns PatternService.SpiralDefinition.TotalAngle.Value 360 (millimeters part), 360 (inches part) New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| CopyThreads | Returns or sets the copy threads option. |
| GeometryToPattern | Returns the inputs for geometry to pattern such as bodies, faces, curves, datum planes, datum axes, points, datum coordinate systems etc. |
| HideOriginal | Returns or sets the hide original option. |
| IsAssociative | Returns or sets the associative option. |
| 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 |
| PatternService | Returns the Pattern Defintion 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¶
CopyThreads¶
-
PatternGeometryBuilder.CopyThreads¶ Returns or sets the copy threads option.
‘true’ if the threads on the input body also need to be patterned ‘false’ if the threads need not be patterned along with the input body Note: the copy threads option can be ‘true’ only when the associative option is also set to ‘true’
-------------------------------------Getter Method
Signature
CopyThreadsReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CopyThreadsParameters: isCopyThreads (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
GeometryToPattern¶
-
PatternGeometryBuilder.GeometryToPattern¶ Returns the inputs for geometry to pattern such as bodies, faces, curves, datum planes, datum axes, points, datum coordinate systems etc.
-------------------------------------Getter Method
Signature
GeometryToPatternReturns: Return type: NXOpen.SelectDisplayableObjectListNew in version NX9.0.0.
License requirements: None.
HideOriginal¶
-
PatternGeometryBuilder.HideOriginal¶ Returns or sets the hide original option.
‘true’ if the input to the pattern geometry needs to be hidden ‘false’ if the input to pattern geometry need not be hidden Note: false does not indicate the inputs that were hidden will be unhidden.
-------------------------------------Getter Method
Signature
HideOriginalReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HideOriginalParameters: isHideOriginal (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IsAssociative¶
-
PatternGeometryBuilder.IsAssociative¶ Returns or sets the associative option.
‘true’ if pattern geometry feature needs to be created ‘false’ if only the outputs of the pattern geometry feature is required.
-------------------------------------Getter Method
Signature
IsAssociativeReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsAssociativeParameters: isAssociative (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PatternService¶
-
PatternGeometryBuilder.PatternService¶ Returns the Pattern Defintion service.
Inputs for different transformation types
-------------------------------------Getter Method
Signature
PatternServiceReturns: Return type: NXOpen.GeometricUtilities.PatternDefinitionNew in version NX9.0.0.
License requirements: None.
ReferencePoint¶
-
PatternGeometryBuilder.ReferencePoint¶ Returns the reference point service.
It contains the point of reference that will be used as the origin for creating pattern based transformations.
-------------------------------------Getter Method
Signature
ReferencePointReturns: Return type: NXOpen.GeometricUtilities.PatternReferencePointServiceBuilderNew in version NX9.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PatternGeometryBuilder.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.