Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

leUnregisterUseGravity

leUnregisterUseGravity( 
t_cmdName
) 
=> t / nil

Description

Prevents a user-defined SKILL enter function to use gravity. By default, gravity is available only for SKILL enter functions for which gravity has been enabled using the leRegisterUseGravity function.

Arguments

t_cmdName

The name of the command for which you want to stop gravity during entering of points.

Value Returned

t

function name was registering for using gravity and has now been unregistered

nil

the named function was not registered for using gravity.

Example

For the following user-defined SKILL enter function:

(defun MyStretchSpecial (...)
  ...
  (enterPoint ?cmdName "StretchSpecial" ...)
  ) ; defun

If you want to use the gravity feature for the function StretchSpecial when the command runs, use the following function:

(leRegisterUseGravity "StretchSpecial") ; Gravity now works for StretchSpecial
(MyStretchSpecial ...)

For as long as MyStretchSpecial function runs, the entered points will use gravity as per the Editor Options values. When the function no longer needs to use gravity, use the following function:

(leUnregisterUseGravity "StretchSpecial") ; Gravity will not work for StretchSpecial

Return to top
 ⠀
X