Mouse In CHOP

From TouchDesigner 099 Wiki

Summary

The Mouse In CHOP outputs X and Y screen values for the mouse device and monitors the up/down state of the three mouse buttons.

When the Active flag is on, the Mouse X and Y positions are output through the channels named in the Position X and Y parameters and the button states are output through the channels named in the Left, Right and Middle Button parameters.

The button values are 0 for Button Up and 1 for Button Down.

The Mouse In CHOP and Keyboard In CHOPs are sometimes connected to the Position and Active inputs respectively of the Record CHOP to enable the recording of channels.

PythonIcon.png mouseinCHOP_Class

Parameters - Control Page

Active - While On, the mouse movement will be output from and the CHOP will cook every frame. When set to Off it will not cook and the current mouse X or Y values will not be output. While Playing will capture mouse events only when the Timeline is playing forward.

Output Coordinates - controls the range of the mouse Position X and Position Y.

  • Normalized - X and Y mouse positions are normalized to a range of 2 units per monitor. The primary monitor will be -1 to 1 with X=0 and Y=0 at the center of the monitor. Other monitors will be relative to these values. For example a monitor directly to the left of the primary monitor would have values in the range -1 on the right to -3 on the left of it.
  • Normalized Aspect - Following the same rules as Normalized, but normalized and adjusted to aspect ratio.
  • Absolute - raw screen coordinates in pixel units. (0,0) is the bottom left of the primary monitor.

Position X - The name of the channel that returns the horizontal movement of the mouse.

Position Y - The name of the channel that returns the vertical movement of the mouse.

Left Button - The name of the channel that returns the state of the left button.

Right Button - The name of the channel that returns the state of the right button.

Middle Button - The name of the channel that returns the state of the middle button.

Wheel - This channel goes up when the wheel is rolled away from the user and goes down when it is rolled the other way.

Wheel Increment - The amount that is added or subtracted to the current value of the Wheel channel when the wheel is moved.

Monitor - This channel returns which monitor the mouse cursor is currently on.

Parameters - Channel Page

This sets the Sample Rate and the Extend Conditions.

Standard Options and Local Variables

None.