ComponentPatternBuilder Class

class NXOpen.Assemblies.ComponentPatternBuilder

Bases: NXOpen.Builder

Represents a builder class that performs various NXOpen.Assemblies.ComponentPattern operations.

Input to this class can be PSM facet objects.

To create a new instance of this class, use NXOpen.Assemblies.ComponentAssembly.CreateComponentPatternBuilder()

Default values.

Property	Value
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
Associative	Returns or sets the option to specify whether the NXOpen.Assemblies.ComponentPattern is associative or not.
ComponentPatternSet	Returns the NXOpen.Assemblies.Component for pattern.
CopyConstraintPattern	Returns or sets the copy constraint option.
PatternService	Returns the NXOpen.GeometricUtilities.PatternDefinition.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
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.
GetDynamicPositioning	Returns the dynamic positioning flag.
GetObject	Returns the object currently being edited by this builder.
SetDynamicPositioning	Sets the dynamic positioning flag.
SetObject	Sets the object selected for pattern definition
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Associative

ComponentPatternBuilder.Associative

Returns or sets the option to specify whether the NXOpen.Assemblies.ComponentPattern is associative or not.

-------------------------------------

Getter Method

Signature Associative

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Associative

Parameters:isAssociative (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

ComponentPatternSet

ComponentPatternBuilder.ComponentPatternSet

Returns the NXOpen.Assemblies.Component for pattern.

-------------------------------------

Getter Method

Signature ComponentPatternSet

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX9.0.0.

License requirements: None.

CopyConstraintPattern

ComponentPatternBuilder.CopyConstraintPattern

Returns or sets the copy constraint option.

The copy constraint type of pattern is created when this option is enabled otherwise Pure Reference pattern is created.

-------------------------------------

Getter Method

Signature CopyConstraintPattern

Returns: Return type:bool

New in version NX9.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CopyConstraintPattern

Parameters:isCopyConstraintReferencePattern (bool) –

New in version NX9.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

PatternService

ComponentPatternBuilder.PatternService

Returns the NXOpen.GeometricUtilities.PatternDefinition.

-------------------------------------

Getter Method

Signature PatternService

Returns: Return type:NXOpen.GeometricUtilities.PatternDefinition

New in version NX9.0.0.

License requirements: None.

Method Detail

GetDynamicPositioning

ComponentPatternBuilder.GetDynamicPositioning

Returns the dynamic positioning flag.

Signature GetDynamicPositioning()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

SetDynamicPositioning

ComponentPatternBuilder.SetDynamicPositioning

Sets the dynamic positioning flag.

It will enable or disable the dynamic preview of the components.

Signature SetDynamicPositioning(isDynamicPositioning)

Parameters:isDynamicPositioning (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SetObject

ComponentPatternBuilder.SetObject

Sets the object selected for pattern definition

Signature SetObject(compPattern)

Parameters:compPattern (NXOpen.Assemblies.ComponentPattern) – The pattern definition object

New in version NX11.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Validate

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