PatternFaceBuilder Class¶
-
class
NXOpen.Features.
PatternFaceBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a builder for a pattern face feature, don’t use it until nx502.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreatePatternFaceBuilder()
Default values.
Property Value Angle.Value 90.0 CircularCount.Value 2 RestoreOption False XCount.Value 2 XDistance.Value 10.0 (millimeters part), 0.5 (inches part) YCount.Value 2 YDistance.Value 10.0 (millimeters part), 0.5 (inches part) New in version NX5.0.2.
Properties¶
Property | Description |
---|---|
Angle | Returns the angle between circular pattern, don’t use it until nx502 |
Axis | Returns or sets the axis of circular pattern, don’t use it until nx502 |
CircularCount | Returns the count of circular pattern, don’t use it until nx502 |
Face | Returns the faces to pattern, don’t use it until nx502 |
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 |
Plane | Returns the mirror plane of mirror pattern, don’t use it until nx502 |
RestoreOption | Returns or sets the restore option for absent members. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Type | Returns or sets the pattern face type, don’t use it until nx502 |
XCount | Returns the count of rectangular pattern along X direction, don’t use it until nx502 |
XDistance | Returns the distance between rectangular pattern along X direction, don’t use it until nx502 |
XVector | Returns or sets the X direction of rectangular pattern, don’t use it until nx502 |
YCount | Returns the count of rectangular pattern along Y direction, don’t use it until nx502 |
YDistance | Returns the distance between rectangular pattern along Y direction, don’t use it until nx502 |
YVector | Returns or sets the Y direction of rectangular pattern, don’t use it until nx502 |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
Enumerations¶
PatternFaceBuilderPatternTypes Enumeration | Enumeration of pattern type, don’t use it until nx502 |
Property Detail¶
Angle¶
-
PatternFaceBuilder.
Angle
¶ Returns the angle between circular pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
Angle()
Returns: the angle expression Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
Axis¶
-
PatternFaceBuilder.
Axis
¶ Returns or sets the axis of circular pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
Axis()
Returns: the circular axis Return type: NXOpen.Axis
New in version NX5.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Axis(axis)
Parameters: axis ( NXOpen.Axis
) – the circular axisNew in version NX5.0.2.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
CircularCount¶
-
PatternFaceBuilder.
CircularCount
¶ Returns the count of circular pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
CircularCount()
Returns: the circular count expression, its value should be an interger Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
Face¶
-
PatternFaceBuilder.
Face
¶ Returns the faces to pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
Face()
Returns: the face collector of pattern face Return type: NXOpen.ScCollector
New in version NX5.0.2.
License requirements: None.
Plane¶
-
PatternFaceBuilder.
Plane
¶ Returns the mirror plane of mirror pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
Plane()
Returns: the mirror plane Return type: NXOpen.SelectTaggedObject
New in version NX5.0.2.
License requirements: None.
RestoreOption¶
-
PatternFaceBuilder.
RestoreOption
¶ Returns or sets the restore option for absent members.
-------------------------------------
Getter Method
Signature
RestoreOption()
Returns: the restore option Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RestoreOption(restoreOption)
Parameters: restoreOption (bool) – the restore option New in version NX7.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Type¶
-
PatternFaceBuilder.
Type
¶ Returns or sets the pattern face type, don’t use it until nx502
-------------------------------------
Getter Method
Signature
Type()
Returns: the pattern face type Return type: NXOpen.Features.PatternFaceBuilderPatternTypes
New in version NX5.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(patternType)
Parameters: patternType ( NXOpen.Features.PatternFaceBuilderPatternTypes
) – the pattern face typeNew in version NX5.0.2.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
XCount¶
-
PatternFaceBuilder.
XCount
¶ Returns the count of rectangular pattern along X direction, don’t use it until nx502
-------------------------------------
Getter Method
Signature
XCount()
Returns: the x count expression, its value should be an interger Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
XDistance¶
-
PatternFaceBuilder.
XDistance
¶ Returns the distance between rectangular pattern along X direction, don’t use it until nx502
-------------------------------------
Getter Method
Signature
XDistance()
Returns: the x distance expression Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
XVector¶
-
PatternFaceBuilder.
XVector
¶ Returns or sets the X direction of rectangular pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
XVector()
Returns: the x direction Return type: NXOpen.Direction
New in version NX5.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
XVector(xVector)
Parameters: xVector ( NXOpen.Direction
) – the x directionNew in version NX5.0.2.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
YCount¶
-
PatternFaceBuilder.
YCount
¶ Returns the count of rectangular pattern along Y direction, don’t use it until nx502
-------------------------------------
Getter Method
Signature
YCount()
Returns: the y count expression, its value should be an interger Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
YDistance¶
-
PatternFaceBuilder.
YDistance
¶ Returns the distance between rectangular pattern along Y direction, don’t use it until nx502
-------------------------------------
Getter Method
Signature
YDistance()
Returns: the y distance expression Return type: NXOpen.Expression
New in version NX5.0.2.
License requirements: None.
YVector¶
-
PatternFaceBuilder.
YVector
¶ Returns or sets the Y direction of rectangular pattern, don’t use it until nx502
-------------------------------------
Getter Method
Signature
YVector()
Returns: the y direction Return type: NXOpen.Direction
New in version NX5.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
YVector(yVector)
Parameters: yVector ( NXOpen.Direction
) – the y directionNew in version NX5.0.2.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
Validate¶
-
PatternFaceBuilder.
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.