nxopen

Interface SketchPatternBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface SketchPatternBuilder
extends Builder

Represents a SketchPatternBuilder
To create a new instance of this class, use SketchCollection.createSketchPatternBuilder(nxopen.SketchPattern)
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)

Created in NX7.5.0

Method Summary

Modifier and Type	Method and Description
boolean	createSpacingExp() Returns the flag to indicate if a spacing expression needs to be created License requirements: None.
void	evaluatePattern() This function will solve the pattern constraint to update it based on the new data set in the builder License requirements: None.
boolean	lockOrientation() Returns the flag to indicate if a spacing expression needs to be created License requirements: None.
PatternDefinition	patternService() Returns the pattern service License requirements: None.
Section	section() Returns the pattern section License requirements: None.
void	setCreateSpacingExp(boolean createSpacingExp) License requirements: None.
void	setEndConstraint(NXObject parent, int inx, boolean isStart, boolean constraint) This function removes end constraint from the given pattern License requirements: solid_modeling ("SOLIDS MODELING") .
void	setLockOrientation(boolean lockOrientation) License requirements: None.
void	updateCenterPoint() This function updates the pattern constraint after a new center-point is set in the builder for a circular pattern.
void	updateCopies() This function updates the pattern constraint with the number of copies set in the builder License requirements: None.
void	updateFromPoint() This function updates the pattern constraint after a new from-point is set in the builder for a general pattern.
void	updateInputSection() This function updates the pattern constraint according to the data set in pattern section License requirements: None.
void	updateLinearDirectionObject() This function updates the pattern constraint after a new direction object is set in the builder for a linear pattern.
void	updateRectangularDirectionObjects() This function updates the pattern constraint after direction objects are set in the builder for a rectangular pattern.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

section

Section section()
         throws NXException,
                RemoteException

Returns the pattern section
License requirements: None.

Created in NX7.5.0

Returns:

Section object

Throws:

NXException

RemoteException

patternService

PatternDefinition patternService()
                          throws NXException,
                                 RemoteException

Returns the pattern service
License requirements: None.

Created in NX7.5.0

Returns:

Parttern Service object

Throws:

NXException

RemoteException

createSpacingExp

boolean createSpacingExp()
                  throws NXException,
                         RemoteException

Returns the flag to indicate if a spacing expression needs to be created
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setCreateSpacingExp

void setCreateSpacingExp(boolean createSpacingExp)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

createSpacingExp -

Throws:

NXException

RemoteException

setEndConstraint

void setEndConstraint(NXObject parent,
                      int inx,
                      boolean isStart,
                      boolean constraint)
               throws NXException,
                      RemoteException

This function removes end constraint from the given pattern
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX7.5.0

Parameters:

parent - Parent object in base chain

inx - Index of the pattern - starts from 0

isStart - TRUE, if we want to remove the start end con

constraint - TRUE to add the con, false to remove

Throws:

NXException

RemoteException

lockOrientation

boolean lockOrientation()
                 throws NXException,
                        RemoteException

Returns the flag to indicate if a spacing expression needs to be created
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setLockOrientation

void setLockOrientation(boolean lockOrientation)
                 throws NXException,
                        RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

lockOrientation -

Throws:

NXException

RemoteException

updateCopies

void updateCopies()
           throws NXException,
                  RemoteException

This function updates the pattern constraint with the number of copies set in the builder
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

updateInputSection

void updateInputSection()
                 throws NXException,
                        RemoteException

This function updates the pattern constraint according to the data set in pattern section
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

updateLinearDirectionObject

void updateLinearDirectionObject()
                          throws NXException,
                                 RemoteException

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

Created in NX11.0.0

Throws:

NXException

RemoteException

updateCenterPoint

void updateCenterPoint()
                throws NXException,
                       RemoteException

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

Created in NX11.0.0

Throws:

NXException

RemoteException

updateRectangularDirectionObjects

void updateRectangularDirectionObjects()
                                throws NXException,
                                       RemoteException

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

Created in NX11.0.0

Throws:

NXException

RemoteException

updateFromPoint

void updateFromPoint()
              throws NXException,
                     RemoteException

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

Created in NX11.0.0

Throws:

NXException

RemoteException

evaluatePattern

void evaluatePattern()
              throws NXException,
                     RemoteException

This function will solve the pattern constraint to update it based on the new data set in the builder
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException