SketchPatternBuilder Class

class NXOpen.SketchPatternBuilder

Bases: NXOpen.Builder

Represents a NXOpen.SketchPatternBuilder

To create a new instance of this class, use NXOpen.SketchCollection.CreateSketchPatternBuilder()

Default values.

Property	Value
CreateSpacingExp	True
LockOrientation	True
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 NX7.5.0.

Properties

Property	Description
CreateSpacingExp	Returns or sets the flag to indicate if a spacing expression needs to be created
LockOrientation	Returns or sets the flag to indicate if a spacing expression needs to be created
PatternService	Returns the pattern service
Section	Returns the pattern section
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.
EvaluatePattern	This function will solve the pattern constraint to update it based on the new data set in the builder
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
SetEndConstraint	This function removes end constraint from the given pattern
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateCenterPoint	This function updates the pattern constraint after a new center-point is set in the builder for a circular pattern.
UpdateCopies	This function updates the pattern constraint with the number of copies set in the builder
UpdateFromPoint	This function updates the pattern constraint after a new from-point is set in the builder for a general pattern.
UpdateInputSection	This function updates the pattern constraint according to the data set in pattern section
UpdateLinearDirectionObject	This function updates the pattern constraint after a new direction object is set in the builder for a linear pattern.
UpdateRectangularDirectionObjects	This function updates the pattern constraint after direction objects are set in the builder for a rectangular pattern.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

CreateSpacingExp

SketchPatternBuilder.CreateSpacingExp

Returns or sets the flag to indicate if a spacing expression needs to be created

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

Getter Method

Signature CreateSpacingExp

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CreateSpacingExp

Parameters:createSpacingExp (bool) –

New in version NX7.5.0.

License requirements: None.

LockOrientation

SketchPatternBuilder.LockOrientation

Returns or sets the flag to indicate if a spacing expression needs to be created

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

Getter Method

Signature LockOrientation

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LockOrientation

Parameters:lockOrientation (bool) –

New in version NX7.5.0.

License requirements: None.

PatternService

SketchPatternBuilder.PatternService

Returns the pattern service

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

Getter Method

Signature PatternService

Returns:Parttern Service object Return type:NXOpen.GeometricUtilities.PatternDefinition

New in version NX7.5.0.

License requirements: None.

Section

SketchPatternBuilder.Section

Returns the pattern section

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

Getter Method

Signature Section

Returns:Section object Return type:NXOpen.Section

New in version NX7.5.0.

License requirements: None.

Method Detail

EvaluatePattern

SketchPatternBuilder.EvaluatePattern

This function will solve the pattern constraint to update it based on the new data set in the builder

Signature EvaluatePattern()

New in version NX11.0.0.

License requirements: None.

SetEndConstraint

SketchPatternBuilder.SetEndConstraint

This function removes end constraint from the given pattern

Signature SetEndConstraint(parent, inx, isStart, constraint)

Parameters:

• parent (NXOpen.NXObject) – Parent object in base chain
• inx (int) – Index of the pattern - starts from 0
• isStart (bool) – TRUE, if we want to remove the start end con
• constraint (bool) – TRUE to add the con, false to remove

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UpdateCenterPoint

SketchPatternBuilder.UpdateCenterPoint

This function updates the pattern constraint after a new center-point is set in the builder for a circular pattern.

Signature UpdateCenterPoint()

New in version NX11.0.0.

License requirements: None.

UpdateCopies

SketchPatternBuilder.UpdateCopies

This function updates the pattern constraint with the number of copies set in the builder

Signature UpdateCopies()

New in version NX8.5.0.

License requirements: None.

UpdateFromPoint

SketchPatternBuilder.UpdateFromPoint

This function updates the pattern constraint after a new from-point is set in the builder for a general pattern.

Signature UpdateFromPoint()

New in version NX11.0.0.

License requirements: None.

UpdateInputSection

SketchPatternBuilder.UpdateInputSection

This function updates the pattern constraint according to the data set in pattern section

Signature UpdateInputSection()

New in version NX8.5.0.

License requirements: None.

UpdateLinearDirectionObject

SketchPatternBuilder.UpdateLinearDirectionObject

This function updates the pattern constraint after a new direction object is set in the builder for a linear pattern.

Signature UpdateLinearDirectionObject()

New in version NX11.0.0.

License requirements: None.

UpdateRectangularDirectionObjects

SketchPatternBuilder.UpdateRectangularDirectionObjects

This function updates the pattern constraint after direction objects are set in the builder for a rectangular pattern.

Signature UpdateRectangularDirectionObjects()

New in version NX11.0.0.

License requirements: None.

Validate

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