nxopen.features

Interface PatternFeatureBuilder

All Superinterfaces:

Builder, FeatureBuilder, IComponentBuilder, Remote, TaggedObject

public interface PatternFeatureBuilder
extends FeatureBuilder

Represents a PatternFeature builder
To create a new instance of this class, use FeatureCollection.createPatternFeatureBuilder(nxopen.features.Feature)
Default values.

Property	Value
CreateReferencePattern	True
ExpressionOption	CreateNew
OutputOption	PatternFeature
PatternMethod	Variational
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)
UseInferredReferencePoint (deprecated)	True

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PatternFeatureBuilder.ExpressionTransferOptions the Expression transfer options.
static class	PatternFeatureBuilder.OutputOptions the Output options.
static class	PatternFeatureBuilder.PatternMethodOptions the Pattern method options.

Method Summary

Modifier and Type	Method and Description
void	clearReferencesToReuse() Clears all the existing references to reuse so that new references can be added License requirements: solid_modeling ("SOLIDS MODELING") .
boolean	createReferencePattern() Returns the Create Reference Pattern option License requirements: None.
PatternFeatureBuilder.ExpressionTransferOptions	expressionOption() Returns the expression transfer option License requirements: None.
SelectFeatureList	featureList() Returns the Features License requirements: solid_modeling ("SOLIDS MODELING") .
PatternFeatureBuilder.OutputOptions	outputOption() Returns the output option License requirements: None.
PatternFeatureBuilder.PatternMethodOptions	patternMethod() Returns the Pattern method License requirements: None.
PatternDefinition	patternService() Returns the Pattern definition service License requirements: None.
Point	referencePoint() Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.point() instead.
PatternReferencePointServiceBuilder	referencePointService() Returns the reference point service License requirements: None.
void	removeAllClocking() Removes clocking from (unclocks) all instances of the PatternFeature .
void	setCreateReferencePattern(boolean createReferencePattern) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setExpressionOption(PatternFeatureBuilder.ExpressionTransferOptions expressionOption) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOutputOption(PatternFeatureBuilder.OutputOptions outputOption) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setPatternMethod(PatternFeatureBuilder.PatternMethodOptions methodOption) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setReferencePoint(Point referencePoint) Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.setPoint(nxopen.Point) instead.
void	setReferencesToReuse(Feature inputFeature, NXObject[] referencesFromInputFeatures) Sets the references or selections from the input features which are to be reused for all instances.
void	setUseInferredReferencePoint(boolean useInferredReferencePoint) Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.setReferencePointInferred(boolean) instead.
boolean	useInferredReferencePoint() Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.isReferencePointInferred() instead.

Methods inherited from interface nxopen.features.FeatureBuilder

commitFeature, getFeature, hideInternalParentFeatureAfterEdit, parentFeatureInternal, patchSolutionFlag, patchSurfaceFilename, setParentFeatureInternal, setParentFeatureInternal, setPatchSolutionFlag, setPatchSurfaceFilename, setSurroundingPatchSurfaceFilename, showInternalParentFeatureForEdit, surroundingPatchSurfaceFilename, unsetParentFeatureInternal

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

patternMethod

PatternFeatureBuilder.PatternMethodOptions patternMethod()
                                                  throws NXException,
                                                         RemoteException

Returns the Pattern method
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setPatternMethod

void setPatternMethod(PatternFeatureBuilder.PatternMethodOptions methodOption)
               throws NXException,
                      RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX7.5.0

Parameters:

methodOption -

Throws:

NXException

RemoteException

featureList

SelectFeatureList featureList()
                       throws NXException,
                              RemoteException

Returns the Features
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

referencePointService

PatternReferencePointServiceBuilder referencePointService()
                                                   throws NXException,
                                                          RemoteException

Returns the reference point service
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

referencePoint

Point referencePoint()
              throws NXException,
                     RemoteException

Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.point() instead.

Returns the reference point
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setReferencePoint

void setReferencePoint(Point referencePoint)
                throws NXException,
                       RemoteException

Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.setPoint(nxopen.Point) instead.

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX7.5.0

Parameters:

referencePoint -

Throws:

NXException

RemoteException

useInferredReferencePoint

boolean useInferredReferencePoint()
                           throws NXException,
                                  RemoteException

Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.isReferencePointInferred() instead.

Returns a flag to indicate whether to use reference point inferred from selected feature(s) or not. If 'true', the reference point will be inferred every time the selected feature(s) get modified or updates. If 'false, the reference point provided will be independent of the selected feature(s) but will be associative to the rule by which it was created (e.g. End of Line, Center of Arc).
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setUseInferredReferencePoint

void setUseInferredReferencePoint(boolean useInferredReferencePoint)
                           throws NXException,
                                  RemoteException

Deprecated. Deprecated in NX9.0.0. Use PatternReferencePointServiceBuilder.setReferencePointInferred(boolean) instead.

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.0.0

Parameters:

useInferredReferencePoint -

Throws:

NXException

RemoteException

patternService

PatternDefinition patternService()
                          throws NXException,
                                 RemoteException

Returns the Pattern definition service
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setReferencesToReuse

void setReferencesToReuse(Feature inputFeature,
                          NXObject[] referencesFromInputFeatures)
                   throws NXException,
                          RemoteException

Sets the references or selections from the input features which are to be reused for all instances. The references for reuse should belong to some input feature which needs to be specified while calling this API.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX8.0.0

Parameters:

inputFeature -

referencesFromInputFeatures -

Throws:

NXException

RemoteException

clearReferencesToReuse

void clearReferencesToReuse()
                     throws NXException,
                            RemoteException

Clears all the existing references to reuse so that new references can be added
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.0.0

Throws:

NXException

RemoteException

outputOption

PatternFeatureBuilder.OutputOptions outputOption()
                                          throws NXException,
                                                 RemoteException

Returns the output option
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setOutputOption

void setOutputOption(PatternFeatureBuilder.OutputOptions outputOption)
              throws NXException,
                     RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.0.0

Parameters:

outputOption -

Throws:

NXException

RemoteException

expressionOption

PatternFeatureBuilder.ExpressionTransferOptions expressionOption()
                                                          throws NXException,
                                                                 RemoteException

Returns the expression transfer option
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setExpressionOption

void setExpressionOption(PatternFeatureBuilder.ExpressionTransferOptions expressionOption)
                  throws NXException,
                         RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX7.5.0

Parameters:

expressionOption -

Throws:

NXException

RemoteException

createReferencePattern

boolean createReferencePattern()
                        throws NXException,
                               RemoteException

Returns the Create Reference Pattern option
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setCreateReferencePattern

void setCreateReferencePattern(boolean createReferencePattern)
                        throws NXException,
                               RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.0.0

Parameters:

createReferencePattern -

Throws:

NXException

RemoteException

removeAllClocking

void removeAllClocking()
                throws NXException,
                       RemoteException

Removes clocking from (unclocks) all instances of the PatternFeature .
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX8.0.0

Throws:

NXException

RemoteException