Timer CHOP

From Derivative
Jump to: navigation, search


Summary

The Timer CHOP is an engine for running timed processes. It outputs channels such as timing fractions, counters, pulses and timer states, and it calls python functions (callbacks) when various timing events occur.

Examples using the Timer CHOP include triggering multiple timed cues, running playlists, timelines, state machines, and driving pre-animated animation components in 3D scenes. See Help -> Operator Snippets for numerous examples.

You set a timer to a number of seconds, frames or samples, and trigger it to start via the Start parameter or the second input CHOP. The Timer CHOP outputs in seconds, frames, samples, fraction and on-off states as it’s counting, including a done channel that goes on when it is complete. When it reaches certain states like end-of-cycles or when it’s done, various python callbacks are called allowing you to customize its behavior.

The Timer CHOP gets triggered by events (via pulsing its parameters or driving its two inputs). It takes events in, counts time, changes state. Via its python callback functions, you can send events out to other nodes, set parameters, get/set values in DATs, CHOPs and storage, restart itself, or trigger other nodes. As such, it can operate as a state machine.

It has play/pause, plus a speed control to slow down or speed up the timer.

It can also cycle indefinitely and then can be signaled to end immediately or at the end of the current cycle.

One Timer CHOP can also have multiple timers within it. By attaching a Table DAT you can define one timer (segment) per row. In Serial Timers mode it allows for one time segment followed by another. In Parallel Timers mode, the timers all run in parallel, each with its own begin time and length, and its own set of output channels.

Timer CHOP.2.png

The Timer CHOP can be Locked to Timeline in a deterministic way, or run more freely in Sequential Mode. When run independently from the timeline, you can jump ahead, break out of cycles, pause, goTo() exact position or timecode in the timer, and dynamically adjust the speed.

The Timer CHOPs can be chained together, so that when one ends, the next can begin. They just need to all be Initialized together, where the ready_pulse channel of one Timer CHOP is exported to the Initialize parameter of the next Timer CHOP. Then they can be run in sequence, where the output of one Timer CHOP’s done_pulse channel is wired to the Start input (or exported to the Start parameter) of the next Timer CHOP. You start the chain of timers by starting the first Timer CHOP. By using some Timer CHOPs to loop awaiting input or response, or by adding logic to decide which CHOP to start next, state machines can be implemented.

Before a cycle or segment ends, an onCycleEndAlert() callback based on the Cycle End Alert parameter can be called to allow you to prepare for the next cycle, segment or Timer CHOP.

Attach an Info DAT to see the timecodes, or use the .timecode members. Custom text strings can be placed in the Info DAT for each segment, and custom animated channels can be created.

To make the entire CHOP loop after the last segment, set the On Done menu to Re-Start.

Recommended: the OP Snippets for Timer CHOP

See also: Trigger CHOP, Event CHOP, Speed CHOP, Count CHOP, Beat CHOP, Event CHOP, Clock CHOP, Delay CHOP, CHOP Execute DAT, LFO CHOP.

PythonIcon.pngtimerCHOP_Class


Parameters - Timer Page

Active active -

Play Mode playmode - - Sequential (timeline-independent) or Locked to Timeline. In Locked to Timeline, non-deterministic features are disabled.

  • Lock To Timeline lock -
  • Sequential sequential -

Initialize initialize - (pulse parameter) Initialize is the signal to get the timer ready: sets the counters to zero (delay, timer, cycle, segment), set the output channels in the proper state, done to be off, the onInitialize() callback is run, and when initialize is complete, it indicates it’s ready by turning on the ready channel, awaiting a Start pulse.

Start start - (pulse) Start is the signal to commence the timers counting. It will count through the delay first, then the timer length. It does an Initialize if it is not already initialized, and then starts counting.

Length length - (float) the time-length of the timer. Set the Units menu to Seconds, Frames or Samples.  

Length Units lengthunits - -

Delay delay - (float) after Start, the delay before the timer begins counting.  

Delay Units delayunits - -

Play play - (onoff) Pauses the timer. It is basically a 0 or 1 multiplier on the Speed.

Speed speed - (default 1) Slows down or speeds up the timer.  

Cue cue - Freezes playing at the Cue Point.

Cue Pulse cuepulse -

Cue Point cuepoint - Time (Seconds, Frames or Fraction) which the cue point is frozen to.  

Cue Units cueunits - -

Cycle cycle - (default Off) causes the timer to loop back to 0 when it reaches the end of the cycle.

Cycle Limit cyclelimit - When the Cycle parameter is On, this determines if it will cycle indefinitely or cycle some maximum number of cycles.

Maximum Cycles maxcycles - When Cycle is on and Cycle Limit is on, this sets the maximum number of cycles.

Cycle End Alert cycleendalert - The number of seconds, frames or samples before a cycle, segment or done state is reached that the onCycleEndAlert() callback is called. This allows you to prepare for the next cycle, segment or timer.  

Notify Units notifyunits - -

Exit Segment at End of Cycle exitendcycle - When pulsed, it will exit the cycle (and segment) at the end of the currently-playing cycle.

Go to End of Cycle gotoendcycle - When pulsed, it will exit the cycle (and segment) immediately.

Go to Done gotodone - Will immediately go to the Done state.

On Done ondone - -

  • Do Nothing donothing -
  • Re-Initialize reinit -
  • Re-Start restart -

Callbacks DAT callbacks -


Parameters - Segments Page

You can specify multiple timers in one Timer CHOP. A "segment" acts as one timer, with its own length, delay time, number of cycles to repeat and other conditions.

Segments DAT segdat - A table DAT that contains one row per timer (segment). The column headings can be delay or begin, length, cycle, cyclelimit, maxcycles and cycleendalert, which override the equivalent parameters. (These are the internal names for the corresponding parameters.) begin is unique as it replaces delay, and it represents the time from Start that the timer will begin counting, whether the CHOP is set to Serial Timers or Parallel Timers (see Segment Method).

The Segments DAT also can include any number of custom columns. See Columns to Custom Channels and Columns to Info DAT below.

Segment Method segmethod - - If the Segment Method is Serial Timers, the timers will be played back-to-back. If the Segment Method is Parallel Timers, the timers can be played at the same time, and a set of channels will be output for each timer.

  • Serial Timers serial -
  • Parallel Timers parallel -

Segment Units segunits - - For the columns delay, begin, length and cycleendalert, you specify whether it’s seconds, frames or samples with this menu.

  • Samples samples -
  • Frames frames -
  • Seconds seconds -

Columns to Custom Channels channelcolumns - Optional extra columns (any name) in the segments DAT can be output as extra channels (the columns must contain numbers). Specify their names in the Columns to Channels parameter. The channel name will be the column name. You can also output the length, delay, etc columns as channels.

Custom Channel Interpolation interpolation - - By default, custom channels step to their new value at the begin of the segment. This menu lets you interpolate to the new value linearly, or any combination of ease-in and ease-out.

  • Step to Value steptovalue -
  • Linear to Value lineartovalue -
  • Ease In to Value easeintovalue -
  • Ease Out to Value easeouttovalue -
  • Ease In-Out to Value easeinouttovalue -

Columns to Info DAT infocolumns - Optional extra columns (any name) in the segments DAT can be output to the Info DAT (attach an Info DAT to the Timer CHOP) if you specify their names in this parameter.

Info DAT Output During Delay datoutput - During the Delay periods and the Initialize/Ready states, the custom rows in the Info DAT will be blank by default. This option will put the custom strings in the Info DAT all the time, incuding when the CHOP is Initialized.

Go to Previous Segment gotoprevseg - (pulse) Jump to Previous Segment.

Go to Next Segment gotonextseg - (pulse) Jump to Next Segment.

Lingo

  • Segment – each segment acts as one timer, with delay time, length, number of cycles to repeat and other conditions.
  • Begin – in Parallel Timers, the number of seconds after a Start (frames or samples) after which each timer starts counting up from zero.
  • Done – The state it goes into when all the timers has finished counting, whether they are in Parallel or Serial, Segments or not.
  • End – Cycle End is the end of each cycle, Segment End is the end of the segment.
  • Cumulative Time – Zero at Start, a count that is affected by speed and rises while timers are active (not during delays).
  • Running Time – Zero at Start, the wall-clock time since Start was called no matter what are the delays, speeds, cycles or premature clicking of Go To Segment End. It stops counting when Done has been reached.


Parameters - Outputs Page

Timer Fraction outfraction - Outputs channel timer_fraction for each segment.

Timer Count outtimercount - - Outputs the elapsed Seconds channel as timer_seconds, Frames outputs channel as timer_frames, or Samples outputs channel as timer_samples. Because this is elapsed time, timer_frames starts at 0, as do the others.

  • Off off -
  • Samples samples -
  • Frames frames -
  • Seconds seconds -

Timer Active outtimeractive - Outputs channel timer_active which is on only while the timer fraction is counting (is non-zero).

Timer Pulse outtimerpulse - Outputs channel timer_pulse when the timer reaches its length.

Delay Fraction outdelayfraction - Outputs a 0-1 fraction in delay_fraction while the delay occurs.

Delay Count outdelaycount - - Outputs the delay count in seconds, frames or samples.

  • Off off -
  • Samples samples -
  • Frames frames -
  • Seconds seconds -

Initializing outinit - Outputs channel initializing = 1 while the timer is initalizing (i.e. while the callback onInitialize() returns non-zero).

Ready outready - Outputs channel ready which is 1 after an Initialize and before a Start.

Ready Pulse outreadypulse - Outputs a pulse when initialization has finished and the timer is ready to start. It pulses even when the timer starts rights away after an initialization.

Running outrunning - Outputs channel running which is 1 after a Start and before the Done.

Done outdone - Outputs channel done when done or complete.

Done Pulse outdonepulse - Outputs channel done when the all timers have reached their completion.

Cycles outcycle - Outputs channel cycles, which is the number of cycles completed (In a segment), starting with 0 during the entire first cycle. If you jump to Done, cycle is incremented as if it played normally to the done state.

Cycle Pulse outcyclepulse - Outputs a pulse at the end of every cycle, even on the first and only cycle.

Cycles + Fraction outcycleplusfraction - Outputs channel cycle_plus_fraction, starting with 0 for entire first cycle.

Segment outseg - Outputs channel segment, starting with 0 for first segment.

Segment Pulse outsegpulse - Outputs channel segment_pulse which is a pulse at the end of each segment.

Segment + Fraction outsegplusfraction - Outputs channel segment_plus_fraction, starting with 0 for first segment ending at #segments at end.

Cumulative Timer Count outcumulativecount - - Outputs cumulative_seconds, cumulative_frames or cumulative_samples. It is a time count that adds up all the Timer Active times for all segments since Start: it is affected by "Speed", and counts up only while timer_active is on.

  • Off off -
  • Samples samples -
  • Frames frames -
  • Seconds seconds -

Running Time Count outrunningcount - - Outputs the "wall-clock" time since Start occurred, no matter what are the delays, speeds, cycles or pre-mature clicking of Go To Segment End, etc. It stops counting when Done has been reached. running_seconds, running_frames, or running_samples. When CHOP is set to Parallel Timers, this will output a channel per segment plus one global running time channel.

  • Off off -
  • Samples samples -
  • Frames frames -
  • Seconds seconds -


Parameters - Channel Page

Sample Rate rate - The sample rate that the CHOP outputs at, which is also used when the units of Length, Delay and Cycle End Alert time are set to Samples. The default sample rate is 60 samples per second.  


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).


CHOPs
Ableton Link • Analyze • Angle • Attribute • Audio Band EQ • Audio Device In • Audio Device Out • Audio Dynamics • Audio File In • Audio Filter • Audio Movie • Audio Oscillator • Audio Para EQ • Audio Play • Audio Render • Audio Spectrum • Audio Stream In • Audio Stream Out • Beat • BlackTrax • Blend • Clip Blender • Clip • Clock • Composite • Constant • Copy • Count • CPlusPlus • Cross • Cycle • DAT to • Delay • Delete • DMX In • DMX Out • Envelope • EtherDream • Event • Expression • Extend • Fan • Feedback • File In • File Out • Filter • Function • Gesture • Handle • Helios DAC • Hog • Hokuyo • Hold • In • Info • Interpolate • Introduction To CHOPs id• Inverse Curve • Inverse Kin • Join • Joystick • Keyboard In • Keyframe • Kinect • Lag • Leap Motion • Leuze ROD4 • LFO • Limit • Logic • Lookup • LTC In • LTC Out • Math • Merge • MIDI In • MIDI In Map • MIDI Out • Mouse In • Mouse Out • NatNet In • Noise • Null • Object • Oculus Audio • Oculus Rift • OpenVR • OSC In • OSC Out • Out • Override • Panel • Parameter • Pattern • Perform • Pipe In • Pipe Out • PosiStageNet • Pulse • RealSense • Record • Rename • Render Pick • Reorder • Replace • Resample • S Curve • Scan • Script • Select • Sequencer • Serial • Shared Mem In • Shared Mem Out • Shift • Shuffle • Slope • SOP to • Sort • Speed • Splice • Spring • Stretch • Switch • Sync In • Sync Out • Tablet • Time Slice • Timeline • Timer • TOP to • Touch In • Touch Out • Trail • Transform • Trigger • Trim • Warp • Wave

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.

OP Snippets is a set of numerous examples of TouchDesigner operators, which you access via the Help menu. These can be copied/pasted into your projects.

A form of DATs (Data Operators) that is structured as rows and columns of text strings.

The panel at the bottom of TouchDesigner, it controls the current Time of the full system or just one component.

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.

Each SOP has a list of Points. Each point has an XYZ 3D position value plus other optional attributes. Each polygon Primitive is defined by a vertex list, which is list of point numbers.

To pulse a parameter is to send it a signal from a CHOP or python or a mouse click that causes a new action to occur immediately. A pulse from a CHOP is typically a 0 to 1 to 0 signal in a channel, and a pulse via python is via a .pulse() call on a pulse-type parameter, such as Reset in a Speed CHOP.

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 between the last cook frame and the current cook frame. In CHOPs it is a 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.

The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called Root. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

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.