Difference between revisions of "Transform XYZ CHOP"

From TouchDesigner Documentation
Jump to: navigation, search
Line 525: Line 525:
 
|opFamily=CHOP
 
|opFamily=CHOP
 
|inputIndex=0
 
|inputIndex=0
|inputName=
+
|inputName=Position/Vectors
|inputSummary=
+
|inputSummary=One or more sets of channels with 'x', 'y' and 'z' as the last character in their names, to be transformed.
 
}}<!--
 
}}<!--
 
-->{{OPInput
 
-->{{OPInput
 
|opFamily=CHOP
 
|opFamily=CHOP
 
|inputIndex=1
 
|inputIndex=1
|inputName=
+
|inputName=Transform
|inputSummary=
+
|inputSummary=An optional additional transform that can be applied. Valid formats are the same as the [[Transform CHOP]].
 
}}
 
}}
 
}}
 
}}

Revision as of 11:47, 11 May 2020

Summary
[edit]

The Transform XYZ CHOP is used to transform positions and vector. The difference between transforming a position vs. a vector is that a vector won't have the translation portion of the transformation applied to it.

The Transform XYZ CHOP first groups the channels from the first input by looking for 'x', 'y' and 'z' as the last character in the channel names. Then it treats each of the sets created as either a Position or a Vector depending on the paremeter choice. The second input can be given a transform in the same channel that the Transform CHOP supports. The second input is combined with the 'Transform' page parameters, and those are applied to the input positions and vectors.

Multiple sample CHOPs can be provided, which allows for larges amount of positional data to be transformed in a single operation.

PythonIcon.pngtransformxyzCHOP_Class


Parameters - Input Page

This page defines how the inputs are treated.

Input 0 Type input0type - - Choose if the input 0 values should be treated as a position or a vectors. Vectors will not have the translation portion of the transform applied to them, and can be normalized before and/or after the transformation is applied.

  • Position position - Treat the input 0 values a positions.
  • Vector vector - Treat the input 0 values a vectors.

Normalize innormalize - If the input is vectors, they can be normalized before the transformation is applied.  

Custom Input Order custinputorder - This allows the input order for input 1, if provided, to be ignored and overridden by a custom order chosen by the following two parameters.  

Transform Order inxord - - Changing the Transform order will change where things go much the same way as going a block and turning east gets you to a different place than turning east and then going a block. In matrix math terms, if we use the 'multiply vector on the right' (column vector) convention, a transform order of Scale, Rotate, Translate would be written as T * R * S * Position

  • Scale Rotate Translate srt -
  • Scale Translate Rotate str -
  • Rotate Scale Translate rst -
  • Rotate Translate Scale rts -
  • Translate Scale Rotate tsr -
  • Translate Rotate Scale trs -

Rotate Order inrord - - As with transform order (above), changing the order in which the rotations take place will alter the final position and orientation. A Rotation order of Rx Ry Rz would create the final rotation matrix as follows R = Rz * Ry * Rx

  • Rx Ry Rz xyz -
  • Rx Rz Ry xzy -
  • Ry Rx Rz yxz -
  • Ry Rz Rx yzx -
  • Rz Rx Ry zxy -
  • Rz Ry Rx zyx -

Input 1 Pre Operation input1preop - - Operation(s) to apply on the transforms on Input 1, before they are combined with other transforms.

  • None none - No operation is applied.
  • Invert invert - Invert the transform.
  • Transpose transpose - Transpose the transform. This only has an effect for matrix format transforms.
  • Invert Transpose inverttranspose - Invert and Transpose the transform. The transpose will only be done if the input is a matrix format transform.


Parameters - Transform Page

This page defines the transform that is applied to the input positions or vectors.

Transform Order xord - - See description from earlier Transform Order parameter.

  • Scale Rotate Translate srt -
  • Scale Translate Rotate str -
  • Rotate Scale Translate rst -
  • Rotate Translate Scale rts -
  • Translate Scale Rotate tsr -
  • Translate Rotate Scale trs -

Rotate Order rord - - See description from earlier Rotate Order parameter.

  • Rx Ry Rz xyz -
  • Rx Rz Ry xzy -
  • Ry Rx Rz yxz -
  • Ry Rz Rx yzx -
  • Rz Rx Ry zxy -
  • Rz Ry Rx zyx -

Translate t - - XYZ translation values.

  • X tx -
  • Y ty -
  • Z tz -

Rotate r - - XYZ rotation, in degrees.

  • X rx -
  • Y ry -
  • Z rz -

Scale s - - XYZ scale to shrink or enlarge the transform.

  • X sx -
  • Y sy -
  • Z sz -

Pivot p - - XYZ pivot to apply the above operations around.

  • X px -
  • Y py -
  • Z pz -

Pre Operation preop - Turn this on to invert the transform generated by this page before combining it with the other terms.  

Multiply Order multiplyorder - - Controls how the input transform(s) are combined with the transform specified on this page. The below two descriptions use a multiply "vector on the right" convention (column vectors).

  • Input, then Transform Page inputxformpage - The transforms will be combined as Transform Page * Input.
  • Transform Page, then Input xformpageinput - The transforms will be combined as Input * Transform Page.


Parameters - Output Page

Un-matched Channels unmatchedchans - - Controls how channels that don't match the naming convention for the various transform format are treated.

  • Warn warn - Give a warning if transform channels that don't match any of the naming convenstions are found.
  • Ignore ignore - Ignore (give no warning) if channels that don't match the naming convention are found.
  • Delete delete - Delete all channels that don't match any of the naming conventions.

Normalize normalize - If the input data is being treated as vectors, they can be re-normalized after the transform by turning this on.  


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


Operator Inputs

  • Input 0 - One or more sets of channels with 'x', 'y' and 'z' as the last character in their names, to be transformed.
  • Input 1 - An optional additional transform that can be applied. Valid formats are the same as the Transform CHOP.


CHOPs
Ableton Link • Analyze • Angle • Attribute • Audio Band EQ • Audio Device In • Audio Device Out • Audio Dynamics • Audio File In • Audio File Out • Audio Filter • Audio Movie • Audio NDI • Audio Oscillator • Audio Para EQ • Audio Play • Audio Render • Audio Spectrum • Audio Stream In • Experimental:Audio Stream In • Audio Stream Out • Beat • Bind • BlackTrax • Blend • Blob Track • Bullet Solver • Clip Blender • Clip • Clock • Composite • Constant • Copy • Count • CPlusPlus • Cross • Cycle • DAT to • Delay • Delete • DMX In • Experimental:DMX In • DMX Out • Envelope • EtherDream • Event • Expression • Extend • Fan • Feedback • File In • File Out • Filter • Experimental:Filter • Experimental:FreeD • Function • Gesture • Handle • Helios DAC • Hog • Hokuyo • Hold • Import Select • In • Info • Interpolate • Introduction To CHOPs id • Inverse Curve • Inverse Kin • Join • Joystick • Keyboard In • Keyframe • Kinect Azure • Kinect • Lag • Laser • Leap Motion • Leuze ROD4 • LFO • Limit • Logic • Lookup • LTC In • LTC Out • Math • Experimental: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 • Pangolin • Parameter • Pattern • Perform • Experimental:Phaser • 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 • Stype • Switch • Sync In • Sync Out • Tablet • Time Slice • Timeline • Timer • TOP to • Touch In • Touch Out • Trail • Transform • Transform XYZ • Trigger • Trim • Warp • Wave • Experimental:WrnchAI • ZED

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.

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.

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.

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.

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.