SketchMirrorBuilder Class¶
-
class
NXOpen.
SketchMirrorBuilder
¶ Bases:
NXOpen.Builder
This class is used to create a set of mirrored curves from a
SketchMirrorBuilder
.Note that the implementation of the
Builder.Commit()
for this class only returns the first mirror constraint created.To create a new instance of this class, use
NXOpen.SketchCollection.CreateSketchMirrorBuilder()
Default values.
Property Value ConvertToReference True New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
CenterLine | Returns the center line. |
ConvertToReference | Returns or sets the flag to indicate if the centerline needs to be converted to reference |
InputCurves | Returns the input curves. |
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. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
CenterLine¶
-
SketchMirrorBuilder.
CenterLine
¶ Returns the center line.
This must be a straight line, straight edge, datum axis or a datum plane that is not parallel to the plane of the sketch. If an entity is selected that is not part of sketch, it will be projected on the sketch plane and the projection will be used as the center line for mirror.
-------------------------------------
Getter Method
Signature
CenterLine()
Returns: Return type: NXOpen.SelectNXObject
New in version NX5.0.0.
License requirements: None.
ConvertToReference¶
-
SketchMirrorBuilder.
ConvertToReference
¶ Returns or sets the flag to indicate if the centerline needs to be converted to reference
-------------------------------------
Getter Method
Signature
ConvertToReference()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConvertToReference(reference)
Parameters: reference (bool) – New in version NX5.0.0.
License requirements: None.
InputCurves¶
-
SketchMirrorBuilder.
InputCurves
¶ Returns the input curves.
These curves must be a part of the active sketch. Sketch curves and points can be mirrored using the operation. The line being used as center line can not be a part of the input curves.
-------------------------------------
Getter Method
Signature
InputCurves()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SketchMirrorBuilder.
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.