Mouse In CHOP
Summary[edit]
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.
Contents
Parameters - Control Page
Active 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.
- Off
off-
- On
on-
- While Playing
play-
Output Coordinates output - ⊞ - Controls the range of the mouse Position X and Position Y.
- Normalized
normal- 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
aspect- Following the same rules as Normalized, but normalized and adjusted to aspect ratio.
- Absolute
absolute- Raw screen coordinates in pixel units. (0,0) is the bottom left of the primary monitor.
Position X posxname - The name of the channel that returns the horizontal movement of the mouse.
Position Y posyname - The name of the channel that returns the vertical movement of the mouse.
Left Button lbuttonname - The name of the channel that returns the state of the left button.
Right Button rbuttonname - The name of the channel that returns the state of the right button.
Middle Button mbuttonname - The name of the channel that returns the state of the middle button.
Wheel 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 wheelinc - The amount that is added or subtracted to the current value of the Wheel channel when the wheel is moved.
Monitor monitor - This channel returns which monitor the mouse cursor is currently on.
Panels panels - Events are only triggered when the specified panel has focus.
Parameters - Channel Page
This sets the Sample Rate and the Extend Conditions.
Sample Rate rate - The sample rate of the channels, in samples per second.
Extend Left left - ⊞ - The left extend conditions (before/after range).
- Hold
hold- Hold the current value of the channel.
- Slope
slope- Continue the slope before the start of the channel.
- Cycle
cycle- Cycle the channel repeatedly.
- Mirror
mirror- Cycle the channel repeatedly, mirroring every other cycle.
- Default Value
default- Use the constant value specified in the Default Value parameter
Extend Right right - ⊞ - The right extend conditions (before/after range).
- Hold
hold- Hold the current value of the channel.
- Slope
slope- Continue the slope after the end of the channel.
- Cycle
cycle- Cycle the channel repeatedly.
- Mirror
mirror- Cycle the channel repeatedly, mirroring every other cycle.
- Default Value
default- Use the constant value specified in the Default Value parameter
Default Value defval - The value used for the Default Value extend condition.
Parameters - Common Page
Time Slice timeslice - Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.
Scope scope - To determine which channels get affected, some CHOPs use a Scope string on the Common page.
Sample Rate Match srselect - ⊞ - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.
- Resample At First Input's Rate
first- Use rate of first input to resample others.
- Resample At Maximum Rate
max- Resample to the highest sample rate.
- Resample At Minimum Rate
min- Resample to the lowest sample rate.
- Error If Rates Differ
err- Doesn't accept conflicting sample rates.
Export Method exportmethod - ⊞ - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.
- DAT Table by Index
datindex- Uses the docked DAT table and references the channel via the index of the channel in the CHOP.
- DAT Table by Name
datname- Uses the docked DAT table and references the channel via the name of the channel in the CHOP.
- Channel Name is Path:Parameter
autoname- The channel is the full destination of where to export to, such hasgeo1/transform1:tx.
Export Root autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.
Export Table exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).
TouchDesigner Build:
| CHOPs |
|---|
| • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • |
An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.
samples-per-second of a CHOP. Each CHOP in your network has a sample rate, whether it is used or not. The overall timeline has a "frame rate", which is the number of animation frames per second, generally your monitor display frequency.
A Time Slice is the time from the last cook frame to the current cook frame. In CHOPs it is the set of short channels that only contain the CHOP channels' samples between the last and the current cook frame.
A parameter in most CHOPs that restricts which channels of that CHOP will be affected. Normally all channels of a CHOP are affected by the operator.
Exporting is the connection of CHOP channels to parameters of operators. The output of each exporting CHOP is one or more channels, active only while the CHOP Viewer is on. The current value of a channel can be exported to a parameter of any operator, overriding that parameter's value. See Parameter.
An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.
Parameters in TouchDesigner are an operator's settings (numbers, menus, flags, strings, paths) which the user can alter. Parameters for any operator can be opened by right-clicking on the operator and selecting "Parameters..." A currently selected operator's parameters can be viewed in a Network Editor by pressing the keyboard shortcut 'p'.
TouchDesigner is a hierarchy of components. "root" is the top-most network in the hierarchy. The Path is simply /. A typical path is /project1/moviein1.
