NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Display::NonProportionalZoom Class Reference

Provides non-proportional zoom capability
To create a new instance of this class, use NXOpen::ViewCollection::CreateNonProportionalZoom
Default values. More...

Inheritance diagram for NXOpen::Display::NonProportionalZoom:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MethodType { MethodTypeRectangle, MethodTypeDynamic }
 Sets the kind of mouse interaction that will define the non-proportional zoom. More...
 

Public Member Functions

bool AnchorCenter ()
 Returns a value indicating if the display will be recentered on the initial line endpoint
Created in NX7.0.0. More...
 
void Enable (bool enable)
 Enables non-proportional zoom. More...
 
void Finish (NXOpen::View *view)
 Signals the completion of a non-proportional zoom defined by one or more pairs of points defined by a mouse gesture. More...
 
void FirstPoint (const NXOpen::Point3d &point1, NXOpen::View *view)
 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. More...
 
NXOpen::Display::NonProportionalZoom::MethodType Method ()
 Returns the type of mouse interaction used to define the non-proportional zoom. More...
 
void SecondPoint (const NXOpen::Point3d &point2, NXOpen::View *view)
 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. More...
 
void SetAnchorCenter (bool anchorCenter)
 Sets a value indicating if the display will be recentered on the initial line endpoint
Created in NX7.0.0. More...
 
void SetMethod (NXOpen::Display::NonProportionalZoom::MethodType method)
 Sets the type of mouse interaction used to define the non-proportional zoom. More...
 
void SetZoomSensitivity (int sensitivity)
 Sets the sensitivity of the zoom relative to the length of the drawn line
Created in NX7.0.0. More...
 
void Start (NXOpen::View *view)
 Prepares NX to receive one or more gestures delimited by pairs of points which define a non-proportional zoom. More...
 
int ZoomSensitivity ()
 Returns the sensitivity of the zoom relative to the length of the drawn line
Created in NX7.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Provides 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


Created in NX7.0.0.

Member Enumeration Documentation

Sets the kind of mouse interaction that will define the non-proportional zoom.

Enumerator
MethodTypeRectangle 

Uses a rectangular region to be zoomed.

MethodTypeDynamic 

Defines a line to define aspect ratio of non-proportional zoom.

Member Function Documentation

bool NXOpen::Display::NonProportionalZoom::AnchorCenter ( )

Returns a value indicating if the display will be recentered on the initial line endpoint
Created in NX7.0.0.



License requirements : None

void NXOpen::Display::NonProportionalZoom::Enable ( bool  enable)

Enables non-proportional zoom.


In batch mode, the the aspect ratio, scale and center of the view are modified, but no display occurs.

Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
enableTrue if using the previously defined non-proportional zoom
void NXOpen::Display::NonProportionalZoom::Finish ( NXOpen::View view)

Signals the completion of a non-proportional zoom defined by one or more pairs of points defined by a mouse gesture.


Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
viewthe view to receive gestures
void NXOpen::Display::NonProportionalZoom::FirstPoint ( const NXOpen::Point3d point1,
NXOpen::View view 
)

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::NonProportionalZoom::MethodType setting, 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.

Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
point1First point in a mouse gesture to define a non-proportional zoom
viewApply pan (if any) and scale in this view only, if it still exists
NXOpen::Display::NonProportionalZoom::MethodType NXOpen::Display::NonProportionalZoom::Method ( )

Returns the type of mouse interaction used to define the non-proportional zoom.


Created in NX7.0.0.

License requirements : None

void NXOpen::Display::NonProportionalZoom::SecondPoint ( const NXOpen::Point3d point2,
NXOpen::View view 
)

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.

Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
point2Second point in a mouse gesture to define a non-proportional zoom
viewApply pan (if any) and scale in this view only, if it still exists
void NXOpen::Display::NonProportionalZoom::SetAnchorCenter ( bool  anchorCenter)

Sets a value indicating if the display will be recentered on the initial line endpoint
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
anchorCenteranchorcenter
void NXOpen::Display::NonProportionalZoom::SetMethod ( NXOpen::Display::NonProportionalZoom::MethodType  method)

Sets the type of mouse interaction used to define the non-proportional zoom.


Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
methodmethod
void NXOpen::Display::NonProportionalZoom::SetZoomSensitivity ( int  sensitivity)

Sets the sensitivity of the zoom relative to the length of the drawn line
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
sensitivitysensitivity
void NXOpen::Display::NonProportionalZoom::Start ( NXOpen::View view)

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.
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
viewthe view to receive gestures
int NXOpen::Display::NonProportionalZoom::ZoomSensitivity ( )

Returns the sensitivity of the zoom relative to the length of the drawn line
Created in NX7.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.