Close

Keyboard In CHOP

Summary

The Keyboard In CHOP receives ASCII input from the keyboard, and outputs channels for the number of keys specified. It creates a single-frame channel representing the current state of each key.

The channels for keys are created by specifying the first key, the number of keys to follow, and the order with which they are selected. Key channel names are either determined by the name of the key, or the channel number.

NOTE: The Keyboard In CHOP does not handle rapid repeats of characters and does not output channels or all keys. A better way is as follows: Create a Panel Execute DAT, and set the 'Panel' parameter to the panel in which keyboard keys need to be monitored. Set the Panel Value to: key. In this DAT, if you enter print(panelValue) in the onValueChange() callback, you will see a line printed for every keystroke.

PythonIcon.pngkeyboardinCHOP_Class


Parameters - Keys Page

Active active - - While On, the keyboard inputs will be monitored and the CHOP will cook every frame. When set to Off it will not cook and the current keyboard values will not be output. While Playing will capture keyboard events only when the Timeline is playing forward.

  • Off off -
  • On on -
  • While Playing play -

First Key firstkey - - Specifies the key to start generating channels from. Valid keys are the numbers 0-9, letters A-Z, and keypad 0-9.

  • 0 0 -
  • 1 1 -
  • 2 2 -
  • 3 3 -
  • 4 4 -
  • 5 5 -
  • 6 6 -
  • 7 7 -
  • 8 8 -
  • 9 9 -
  • A a -
  • B b -
  • C c -
  • D d -
  • E e -
  • F f -
  • G g -
  • H h -
  • I i -
  • J j -
  • K k -
  • L l -
  • M m -
  • N n -
  • O o -
  • P p -
  • Q q -
  • R r -
  • S s -
  • T t -
  • U u -
  • V v -
  • W w -
  • X x -
  • Y y -
  • Z z -
  • Comma , keycomma -
  • Period . keyperiod -
  • Keypad 0 keypad0 -
  • Keypad 1 keypad1 -
  • Keypad 2 keypad2 -
  • Keypad 3 keypad3 -
  • Keypad 4 keypad4 -
  • Keypad 5 keypad5 -
  • Keypad 6 keypad6 -
  • Keypad 7 keypad7 -
  • Keypad 8 keypad8 -
  • Keypad 9 keypad9 -
  • Keypad Period keypadperiod -

Modifier Keys modifiers - - If it is set to Ctrl, the keys will only go On if you are also pressing the Ctrl key. If it set to Ignore, it doesn't matter if the Ctrl key is down or not. The Keyboard In CHOP does not use the Alt key, which has been reserved for shortcuts.

  • Ignore ignore -
  • None none -
  • Control ctrl -
  • Alt alt -
  • Control and Alt ctrlalt -

Number of Keys number - Specifies the number of keys to generate including the first key.  

Key Order order - - If you ask for 5 keys, they are sequential on the keyboard by three methods:

  • QWERTY qwerty - Where it follows the keyboard rows, and E is followed by R, T, Y and U.
  • Alphabetic alphabetic - Where E is followed by F, G, H and I.
  • 1QAZ 1qaz - Where it follows the keyboard columns, and E is followed by F, V, 4 and R.

The keypad keys are ordered: keypad 0, keypad period, keypad 1, keypad 2, etc.

Channel Names channelnames - - Channel names are generated automatically using one of these criteria.

  • by Key Name key - Keys Q W R will be called kq kw ke, based on the key name (key pad channels are named kp0, kp1...).
  • by Channel Number number - Channels are named k1 k2 k3 k4 based on the order of the channels.


Parameters - Channel Page

This sets the Sample Rate and the Extend Conditions.

Sample Rate rate -  

Extend Left left - -

  • Hold hold -
  • Slope slope -
  • Cycle cycle -
  • Mirror mirror -
  • Default Value default -

Extend Right right - -

  • Hold hold -
  • Slope slope -
  • Cycle cycle -
  • Mirror mirror -
  • Default Value default -

Default Value defval -  


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 has geo1/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: