SketchMirrorPatternBuilder Class¶
-
class
NXOpen.SketchMirrorPatternBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.SketchMirrorPatternBuilderTo create a new instance of this class, use
NXOpen.SketchCollection.CreateSketchMirrorPatternBuilder()Default values.
Property Value ConvertToReference True New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| ConvertToReference | Returns or sets the flag to indicate if the centerline needs to be converted to reference |
| DirectionObject | Returns the direction object. |
| 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. |
| 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 mirror pattern |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateDirectionObject | This function updates the mirror constraint with the new direction in the builder |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ConvertToReference¶
-
SketchMirrorPatternBuilder.ConvertToReference¶ Returns or sets the flag to indicate if the centerline needs to be converted to reference
-------------------------------------Getter Method
Signature
ConvertToReferenceReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ConvertToReferenceParameters: reference (bool) – New in version NX7.5.0.
License requirements: None.
DirectionObject¶
-
SketchMirrorPatternBuilder.DirectionObject¶ Returns the direction object.
This function gets direction object of the pattern constraint
-------------------------------------Getter Method
Signature
DirectionObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Section¶
-
SketchMirrorPatternBuilder.Section¶ Returns the pattern section
-------------------------------------Getter Method
Signature
SectionReturns: Section object Return type: NXOpen.SectionNew in version NX7.5.0.
License requirements: None.
Method Detail¶
SetEndConstraint¶
-
SketchMirrorPatternBuilder.SetEndConstraint¶ This function removes end constraint from the given mirror pattern
Signature
SetEndConstraint(parent, isStart, constraint)Parameters: - parent (
NXOpen.NXObject) – Parent object in base chain - 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”) OR geometric_tol (“GDT”)
- parent (
UpdateDirectionObject¶
-
SketchMirrorPatternBuilder.UpdateDirectionObject¶ This function updates the mirror constraint with the new direction in the builder
Signature
UpdateDirectionObject()New in version NX10.0.0.
License requirements: None.
Validate¶
-
SketchMirrorPatternBuilder.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.