hiDynamicPanRelative
hiDynamicPanRelative(
[ w_window ]
[ n_percentX ]
[ n_percentY ]
[ g_noAnimation { t | nil } ]
)
=> t / nil
Description
Pans a design in the direction and distance specified in n_percentX and n_percentY. The distance is a percentage of the window size.
For example, if you want to pan to the right for a distance that is equal to 10% of the window width, you would specify:
hiDynamicPanRelative(window(2) 10)
The image shifts to the left by 10% of the width of the window, displaying more of the design on the right.
To pan vertically, set the n_percentX argument to 0; to pan horizontally, either set the n_percentY argument to 0 or do not specify it.
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_percentX
|
The distance that you want to pan to the right or left, specified as a percentage of the window’s width. To pan to the right, specify n_percentX as a positive number. To pan to the left, specify n_percentX as a negative number.
|
|
n_percentY
|
The distance that you want to pan up or down, specified as a percentage of the window’s height. To pan down, specify n_percentY as a positive number. To pan up, specify n_percentY as a negative number.
If you want to use this argument and do not want to use n_percentX, specify 0 for n_percentX.
|
|
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.
|
Value Returned
|
t
|
The design can be panned.
|
|
nil
|
There was an error.
|
Example
hiDynamicPanRelative( window(2) 10 20 )
Related Topics
hiDynamicPanAbsolute
hiDynamicPanInteractive
hiPan
hiVectorPan
hiDeltaPan
hiAbsolutePan
hiRegZoomPanProc
hiUnregZoomPanProc
Return to top
