NonProportionalZoom Class¶
-
class
NXOpen.Display.NonProportionalZoom¶ Bases:
NXOpen.BuilderProvides non-proportional zoom capability
To create a new instance of this class, use
NXOpen.ViewCollection.CreateNonProportionalZoom()Default values.
Property Value AnchorCenter 0 Method Dynamic ZoomSensitivity 5 New in version NX7.0.0.
Properties¶
| Property | Description |
|---|---|
| AnchorCenter | Returns or sets a value indicating if the display will be recentered on the initial line endpoint |
| Method | Returns or sets the type of mouse interaction used to define the non-proportional zoom. |
| Tag | Returns the Tag for this object. |
| ZoomSensitivity | Returns or sets the sensitivity of the zoom relative to the length of the drawn line |
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. |
| Enable | Enables non-proportional zoom. |
| Finish | Signals the completion of a non-proportional zoom defined by one or more pairs of points defined by a mouse gesture. |
| FirstPoint | Scales the specified view non-proportionally in the horizontal (X) and vertical (Y) dimensions, based on a mouse gesture defined by two points in a view. |
| 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. |
| SecondPoint | Scales the specified view non-proportionally in the horizontal (X) and vertical (Y) dimensions, based on a mouse gesture defined by two points in a view. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Start | Prepares NX to receive one or more gestures delimited by pairs of points which define a non-proportional zoom. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| NonProportionalZoomMethodType Enumeration | Sets the kind of mouse interaction that will define the non-proportional zoom. |
Property Detail¶
AnchorCenter¶
-
NonProportionalZoom.AnchorCenter¶ Returns or sets a value indicating if the display will be recentered on the initial line endpoint
-------------------------------------Getter Method
Signature
AnchorCenterReturns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AnchorCenterParameters: anchorCenter (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method¶
-
NonProportionalZoom.Method¶ Returns or sets the type of mouse interaction used to define the non-proportional zoom.
-------------------------------------Getter Method
Signature
MethodReturns: Return type: NXOpen.Display.NonProportionalZoomMethodTypeNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MethodParameters: method ( NXOpen.Display.NonProportionalZoomMethodType) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ZoomSensitivity¶
-
NonProportionalZoom.ZoomSensitivity¶ Returns or sets the sensitivity of the zoom relative to the length of the drawn line
-------------------------------------Getter Method
Signature
ZoomSensitivityReturns: Return type: int New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ZoomSensitivityParameters: sensitivity (int) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
Enable¶
-
NonProportionalZoom.Enable¶ Enables non-proportional zoom.
In batch mode, the the aspect ratio, scale and center of the view are modified, but no display occurs.
Signature
Enable(enable)Parameters: enable (bool) – True if using the previously defined non-proportional zoom New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Finish¶
-
NonProportionalZoom.Finish¶ Signals the completion of a non-proportional zoom defined by one or more pairs of points defined by a mouse gesture.
Signature
Finish(view)Parameters: view ( NXOpen.View) – the view to receive gesturesNew in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
FirstPoint¶
-
NonProportionalZoom.FirstPoint¶ Scales the specified view non-proportionally in the horizontal (X) and vertical (Y) dimensions, based on a mouse gesture defined by two points in a view.
Based on
NXOpen.Display.NonProportionalZoomMethodTypesetting, the gesture may be interpreted as a bounding box or a line, but will determine the XY aspect ratio and the zoom.In batch mode, the the aspect ratio, scale and center of the view are modified, but no display occurs.
Signature
FirstPoint(point1, view)Parameters: - point1 (
NXOpen.Point3d) – First point in a mouse gesture to define a non-proportional zoom - view (
NXOpen.View) – Apply pan (if any) and scale in this view only, if it still exists
New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
- point1 (
SecondPoint¶
-
NonProportionalZoom.SecondPoint¶ Scales the specified view non-proportionally in the horizontal (X) and vertical (Y) dimensions, based on a mouse gesture defined by two points in a view.
Call this once for every call to first point, to redefine a non-proportional zoom.
In batch mode, the the aspect ratio, scale and center of the view are modified, but no display occurs.
Signature
SecondPoint(point2, view)Parameters: - point2 (
NXOpen.Point3d) – Second point in a mouse gesture to define a non-proportional zoom - view (
NXOpen.View) – Apply pan (if any) and scale in this view only, if it still exists
New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
- point2 (
Start¶
-
NonProportionalZoom.Start¶ Prepares NX to receive one or more gestures delimited by pairs of points which define a non-proportional zoom.
This function records the display state to which the view will return when non-proportional zoom is disabled. In a typical scenario, call start. Then call first point accompanied by one or more calls to second point, followed by a call to finish, followed optionaly by further first point/second point/finish combinations of calls.
Signature
Start(view)Parameters: view ( NXOpen.View) – the view to receive gesturesNew in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Validate¶
-
NonProportionalZoom.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.