hiDynamicPanInteractive

hiDynamicPanInteractive(
[ w_window ]
[ n_scope ]
[ g_noAnimation { t | nil } ]
)
=> t / nil

Description

Pans a design continuously when you place the cursor near the edge of a graphics window. You can control the speed at which the design is panned by varying the distance between the cursor and the edge of the window—the closer the cursor is to the edge of the window, the faster the speed.

You can also use an anchor box to pan the design instead of moving the cursor on the window edges. Click the left mouse button on the window to display the anchor box. You can then move the cursor along the edges of the anchor box to pan the design. The distance between the cursor and the anchor box determines the speed.

To exit the panning mode, press the Esc key or any other key, or select any command in your graphics application.

If you create your own graphics windows, you need to register a displayProc callback for the window for this function to work.

On UNIX platforms, your window setting should be "Point in Window to Make Active" instead of "Click in Window to Make Active" for this function to work correctly. You can set this from the style manager on your machine. This setting is not required when you use this function with a bindkey.

Arguments

w_window	The window that you want to pan. If not specified, the current window is used. Note: w_window cannot be a session window or a dockable window.
n_scope	Defines the panning range. For example, if a full bounding box in a design is set at (-1000:-1000 1000:1000) and n_scope=1.2, then you get a panning range of (-1100:-1100 1100:1100) which is 20% greater than the bounding box setting. If the n_scope argument is not specified, the default value of the argument is 0. This means there are no limits on the range making it possible to pan well beyond the design bounding box.
g_noAnimation	Specifies whether to skip the animation affect during dynamic panning. The default is nil, which means that the animation affect is not skipped.

Values Returned

t	Returns t when you exit the panning mode.
nil	There was an error.

Examples

hiDynamicPanInteractive( hiGetCurrentWindow() 1.2 )

Related Topics

hiDynamicPanAbsolute

hiDynamicPanRelative

hiPan

hiVectorPan

hiDeltaPan

hiAbsolutePan

hiUnregZoomPanProc

Return to top