RefineDisplayBuilder Class¶
-
class
NXOpen.Drawings.RefineDisplayBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Drawings.RefineDisplayBuilder.This class is used to refine regions of lightweight drawing views.
To create a new instance of this class, use
NXOpen.Drawings.DraftingViewCollection.CreateRefineDisplayBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| BoundaryPoint1 | Returns or sets the boundary point1 in drawing coordinates. |
| BoundaryPoint2 | Returns or sets the boundary point2 in drawing coordinates. |
| Tag | Returns the Tag for this object. |
| View | Returns the view to refine. |
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¶
BoundaryPoint1¶
-
RefineDisplayBuilder.BoundaryPoint1¶ Returns or sets the boundary point1 in drawing coordinates.
This represents one of the points which defines the region to to be refined. If both boundary point1 and point2, are outside the view boundary, the view will not be refined
-------------------------------------Getter Method
Signature
BoundaryPoint1Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BoundaryPoint1Parameters: boundaryPoint1 ( NXOpen.Point) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
BoundaryPoint2¶
-
RefineDisplayBuilder.BoundaryPoint2¶ Returns or sets the boundary point2 in drawing coordinates.
This represents one of the points which defines the region to to be refined. If both boundary point1 and point2, are outside the view boundary, the view will not be refined
-------------------------------------Getter Method
Signature
BoundaryPoint2Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BoundaryPoint2Parameters: boundaryPoint2 ( NXOpen.Point) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
View¶
-
RefineDisplayBuilder.View¶ Returns the view to refine.
This must be a lightweight drawing view
-------------------------------------Getter Method
Signature
ViewReturns: Return type: NXOpen.Drawings.SelectDraftingViewNew in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RefineDisplayBuilder.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.