home *** CD-ROM | disk | FTP | other *** search
/ APDL Eductation Resources / APDL Eductation Resources.iso / programs / mouse / mousectrl / !MouseCtrl / UserGuide / Module next >
Encoding:
Text File  |  1992-02-15  |  3.0 KB  |  94 lines
  1. MouseCtrl Module version 1.01 (15-Feb-1992)
  2. ===========================================
  3.  
  4. This module provides a flexible mouse speed controller for general use.
  5. Unlike most similar modules, MouseCtrl uses a rather more complex mechanism
  6. for determining the current actual mouse speed and when to change the mouse
  7. step multiplier from the slow to the fast setting and visa versa to get
  8. round most of the problems associtiated with most mouse speed controllers.
  9.  
  10. When enabled, the module maintains a record of the average mouse speed over
  11. the previous 1/5th second or so, based on taking a speed sample every 1/20th
  12. second and using a system of continous averaging to prevent spurious step
  13. rate changes due to speed spikes that tend to occure due to uneven mouse mats,
  14. friction, slipping etc.
  15.  
  16. As a further aid to preventing spurious step rate changes, two threshold
  17. levels are used to determin when the step multiplier should be changed. One
  18. for transitions between slow and fast modes, the other for transitions
  19. between fast and slow modes.
  20.  
  21. Normally the slow to fast threshold is set much higher than the fast to slow
  22. threshold to provide hysterisis, and thus far more predictable speed
  23. switching from the user's point of view.
  24.  
  25. Commands
  26.  
  27. *MouseCtrl_Setup <slow> <fast> <stof> <ftos> [<state>]
  28. (defaults are 8 2 2 4 0)
  29. This command is used to set the mouse step multiplers and thresholds used.
  30. <slow> is the step multiplier used for slow mouse movement.
  31. <fast> is the step multiplier used for fast mouse movement.
  32. <stof> is the slow to fast speed switch threshold level. Values in the range
  33. 8 to 24 are most suitable.
  34. <ftos> is the fast to slow speed switch threshold level. Values in the range
  35. 1 to 8 ae most suitable.
  36. <state> is the MouseCtrl on/off state. 0 for off, 1 for on.
  37.  
  38. *MouseCtrl_On
  39. (default is off)
  40. This command is used to switch the speed controller on.
  41.  
  42. *MouseCtrl_Off
  43. This command is used to switch the speed controller off.
  44.  
  45.  
  46. SWI calls
  47. As there is a wimp utility to aid setting up MouseCtrl, a number of SWI
  48. calls have been implemented primarily to provide the wimp utility with a
  49. control and status interface to MouseCtrl.
  50.  
  51. MouseCtrl_State (&C1000)
  52. Switch MouseCtrl on or off.
  53.  
  54. On entry:
  55.   R0 = 0 to switch MouseCtrl off, 1 to switch it on.
  56. On exit:
  57.   All registers preserved.
  58.  
  59.  
  60. MouseCtrl_Setup (&C1001)
  61. Set step multipliers and threshold levels.
  62.  
  63. On entry:
  64.   R0 = slow step multiplier.
  65.   R1 = fast step multiplier.
  66.   R2 = slow to fast threshold level.
  67.   R3 = fast to slow threshold level.
  68.   R4 = new state: 0 for off, 1 for on
  69. On exit:
  70.   All registers preserved.
  71.  
  72. MouseCtrl_Info (&C1002)
  73. Read current MouseCtrl setup.
  74.  
  75. On entry:
  76.   No parameters.
  77. On exit:
  78.   R0 = slow step multiplier.
  79.   R1 = fast step multiplier.
  80.   R2 = slow to fast threshold level.
  81.   R3 = fast to slow threshold level.
  82.   R4 = Current state: 0 for off, 1 for on.
  83.  
  84. MouseCtrl_Speed (&C1003)
  85. Read average mouse speed and speed flag.
  86.  
  87. On entry:
  88.   No paramters.
  89. On exit:
  90.   R0 = Average mouse speed
  91.   R1 = Current speed flag value: 0 for slow, 1 for fast
  92.  
  93. This call is only valid when the MouseCtrl is switched on.
  94.