Engine COMP and Time COMP: Difference between pages

From Derivative
(Difference between pages)
Jump to navigation Jump to search
mNo edit summary
 
mNo edit summary
 
Line 1: Line 1:
{{Summary
{{Summary
|opFamily=COMP
|opFilter=False
|opType=engineCOMP
|opLabel=Time
|opLabel=Engine
|opFamily=COMP
|opClass=engineCOMP_Class
|long=The Time Component allows each component to have its own timeline (clock). The Time Component contains a network of operators that can drive a [[Timeline]], drive animations in [[Animation COMP]]s, or be used to drive any custom time-based system. The Time Component's parameters define the speed, range, various options for the time system.
|opFilter=False
|opLicense=TouchDesigner Non-Commercial
The Time Component is often used in TouchDesigner to allow a component to have its own timeline / clock, this is called [[Component Time]]. It is useful for holding some parts of your system stationary while others are allowed to play forward. A Time Component's location must be in the <code>/local</code> network of a [[Component]] for the Time Component to create a '''Component Time'''.
|short=The Engine COMP will run a .tox file (component) in a separate process. It uses [[TouchEngine]] to manage these processes and pass data between the loaded component and the main project.
|long=The Engine COMP will run a .tox file (component) in a separate process. It uses [[TouchEngine]] to manage these processes and pass data between the loaded component and the main project.
To add Component Time to a component, right-click on the component and select '''Add Component Time...''' from the popup menu, this will add the following Time Component <code>/''comppath''/local/time</code>.
 
'''Ins and Outs'''
The Time Component's predefined network is [[Clone|Cloned]] from Master Component <code>/sys/local/time</code>.  The Time Component's network can be modified if the path in the Clone parameter is removed.
 
|opClass=timeCOMP_Class
The chosen component's top-level Ins and Outs are exposed as Ins and Outs on the Engine COMP. Only TOP, CHOP and DAT Ins and Outs are supported.
|short=The Time Component allows each component to have its own timeline (clock).
 
|opType=time
'''Custom Parameters'''
|opLicense=Non-Commercial
 
|opCategories=
Any custom parameters on the top-level component are added to the Engine COMP's parameters.
}}
 
{{ParameterPage
Note that parameters work in one direction only - you cannot set a parameter from within the loaded .tox.
|pageName=Time
 
|pageSummary=
'''External File Paths'''
|opFamily=COMP
 
|items=
Relative paths on OPs or in scripts '''inside''' the loaded component are relative to the .tox file's location. Relative paths as file or folder parameters '''of''' the component - those that show up on the Engine COMP - are relative to the main project.
{{Parameter|parName=play
 
|parLabel=Play
'''Component Lifetime'''
|opFamily=COMP
 
|parSummary=Controls the playback of the Time Component. 0 = stop, 1 = play.
Under TouchEngine, components are loaded into an already-running instance. For this reason, an Execute DAT's onStart() and onExit() method will never be executed under TouchEngine. The onCreate() method will be executed when the component is loaded, and is a good place to do any setup you would normally do in onStart().
|parOrder=0
 
|opType=time
'''TouchEngine Versions'''
|parType=Int
 
|parReadOnly=
TouchEngine is installed as part of TouchDesigner, and the currently running version will be used to load the given .tox. If you wish to use a different version of TouchEngine you can either set the environment variable <code>TOUCHENGINE_APP_PATH</code> to the path to a TouchDesigner installation (an installation directory on Windows, or a TouchDesigner app on macOS) ''or'' install TouchDesigner into a folder named <code>TouchEngine</code> alongside the .tox (on macOS rename an application from TouchDesigner to TouchEngine) ''or'' create a link named <code>TouchEngine</code> alongside the .tox which points to an installation directory or TouchDesigner app.
|parItems=
|opCategories=
}}
}}
{{Parameter|parName=rate
{{ParameterPage
|parLabel=Rate
|opFamily=COMP
|opFamily=COMP
|pageName=Engine
|parSummary=Sets the frame per second for the Time Component.
|pageSummary=
|parOrder=1
|items={{Parameter
|opType=time
|opFamily=COMP
|parType=Float
|opType=engineCOMP
|parReadOnly=
|parLabel=Tox File
|parItems=
|parName=file
}}
|parType=File
{{Parameter|parName=start
|parReadOnly=
|parLabel=Start
|parOrder=0
|opFamily=COMP
|parSummary=Specify the .tox file to load with TouchEngine.
|parSummary=Sets the start frame for the Time Component. The '''Start''' and '''End''' parameters determine the overall length of the Time Component.
|parItems=
|parOrder=2
 
|opType=time
}}
|parType=Int
{{Parameter
|parReadOnly=
|opFamily=COMP
|parItems=
|opType=engineCOMP
}}
|parLabel=Unload
{{Parameter|parName=end
|parName=unload
|parLabel=End
|parType=Pulse
|opFamily=COMP
|parReadOnly=
|parSummary=Sets the end frame for the Time Component. The '''Start''' and '''End''' parameters determine the overall length of the Time Component.
|parOrder=1
|parOrder=3
|parSummary=Unload the currently loaded component.
|opType=time
|parItems=
|parType=Int
}}
|parReadOnly=
{{Parameter
|parItems=
|opFamily=COMP
}}
|opType=engineCOMP
{{Parameter|parName=rangelimit
|parLabel=Keep Alive
|parLabel=Range Limit
|parName=keepalive
|opFamily=COMP
|parType=Toggle
|parSummary=This menu controls how the playback loops:
|parReadOnly=
|parItems=
|parOrder=2
{{ParameterItem|itemLabel=Loop
|parSummary=If the TouchEngine instance quits for any reason, restart it.
|itemSummary=The timeline will loop when it reaches Range End frame.
|parItems=
|itemName=loop
}}
|opFamily=COMP
{{Parameter
|parName=rangelimit
|opFamily=COMP
}}<!--
|opType=engineCOMP
-->{{ParameterItem|itemLabel=Hold
|parLabel=Reload
|itemSummary=The timeline will stop (hold) when it reaches Range End frame.
|parName=reload
|itemName=hold
|parType=Pulse
|opFamily=COMP
|parReadOnly=
|parName=rangelimit
|parOrder=2
}}
|parSummary=
|parItems=
|parOrder=4
}}
|opType=time
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Reload on Crash
|parName=reloadoncrash
|parType=Toggle
|parReadOnly=
|parOrder=3
|parSummary=If the TouchEngine instance quits for any reason, restart it.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Start on Initialize
|parName=startoninit
|parType=Toggle
|parReadOnly=
|parOrder=4
|parSummary=When enabled, playback will start as soon as the component has been loaded.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Asset Paths
|parName=assetpaths
|parType=Menu
|parType=Menu
|parReadOnly=
|parReadOnly=
|parOrder=4
}}
|parSummary=
{{Parameter|parName=rangestart
|parItems={{ParameterItem
|parLabel=Range Start
|opFamily=COMP
|opFamily=COMP
|parName=assetpaths
|parSummary=Sets the start frame of the working range. The working range is a subset of the start/end range which can be used to focus work on a smaller section of time. The playhead will only playback the frames/beats that are inside this working range.
|itemLabel=Relative to Project File (.toe)
|parOrder=5
|itemName=project
|opType=time
|itemSummary=
|parType=Int
}}<!--
|parReadOnly=
-->{{ParameterItem
|parItems=
|opFamily=COMP
}}
|parName=assetpaths
{{Parameter|parName=rangeend
|itemLabel=Relative to COMP File (.tox)
|parLabel=Range End
|itemName=comp
|opFamily=COMP
|itemSummary=
|parSummary=Sets the end frame of the working range. The working range is a subset of the start/end range which can be used to focus work on a smaller section of time. The playhead will only playback the frames/beats that are inside this working range.
}}
|parOrder=6
}}
|opType=time
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Callbacks DAT
|parName=callbacks
|parType=DAT
|parReadOnly=
|parOrder=5
|parSummary=The Callbacks DAT will execute for events related to the TouchEngine instance.
|parItems=
}}
}}
{{ParameterPage
|opFamily=COMP
|pageName=Tune
|pageSummary=
|items={{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Match Component Rate
|parName=matchrate
|parType=Toggle
|parReadOnly=
|parOrder=0
|parSummary=When on, the component will be cooked in TouchEngine at the same rate as the Engine COMP.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Clock
|parName=clock
|parType=Menu
|parReadOnly=
|parOrder=0
|parSummary=Specify the temporal connection to the TouchEngine instance.
|parItems={{ParameterItem
|opFamily=COMP
|parName=clock
|itemLabel=Synchronized
|itemName=synced
|itemSummary=Time is strictly synchronized between the Engine COMP and the TouchEngine instance.
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=clock
|itemLabel=Independent
|itemName=independent
|itemSummary=The TouchEngine instance runs according to its own internal clock.
}}
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Match Local Component Rate
|parName=matchrate
|parType=Toggle
|parReadOnly=
|parOrder=1
|parSummary=When on, the component will be cooked in TouchEngine at the same rate as the Engine COMP.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Frames per Second
|parName=fps
|parType=Float
|parReadOnly=
|parOrder=2
|parSummary=The framerate for cooking the component in TouchEngine.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Wait for Render
|parName=wait
|parType=Toggle
|parReadOnly=
|parOrder=3
|parSummary=When enabled, if a frame takes a long time to cook in TouchEngine the Engine COMP will wait during cooking rather than dropping the late frame.
 
This behaviour is affected by the size of the output buffer: eg if Out Buffer Frames is 4, the Engine COMP will wait for the 4th most recent frame to complete.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Render Timeout
|parName=timeout
|parType=Int
|parType=Int
|parReadOnly=
|parReadOnly=
|parOrder=4
|parItems=
|parSummary=When waiting for a frame, TouchEngine will give up waiting after this many milliseconds.
}}
|parItems=
{{Parameter|parName=resetframe
}}
|parLabel=Reset Frame
{{Parameter
|opFamily=COMP
|opFamily=COMP
|parSummary=Place holder to specify which frame to jump to (Obsolete).
|opType=engineCOMP
|parOrder=7
|parLabel=In Buffer Auto
|opType=time
|parName=inauto
|parType=Toggle
|parReadOnly=
|parOrder=5
|parSummary=Automatically manage the number of input frames queued.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=In Buffer Frames
|parName=inframes
|parType=Int
|parType=Int
|parReadOnly=
|parReadOnly=
|parOrder=6
|parItems=}}
|parSummary=The number of input frames to queue before passing them to the TouchEngine instance.
{{Parameter|parName=signature
 
|parLabel=Signature
To accommodate potential fluctations in time-slice in the TouchEngine instance, CHOP inputs must send a number of frames ahead of time.
|opFamily=COMP
|parItems=
|parSummary=Specifies the time signature. The first number is the number of beats per measure and the second number indicates the type of note that constitutes one beat. See [http://en.wikipedia.org/wiki/Time_signature Time Signature - Wikipedia] for additional information.
}}
|parItems=
{{Parameter
{{ParameterItem|itemLabel=""
|opFamily=COMP
|itemSummary=
|opType=engineCOMP
|itemName=signature1
|parLabel=Out Buffer Auto
|opFamily=COMP
|parName=outauto
|parName=signature
|parType=Toggle
}}<!--
|parReadOnly=
-->{{ParameterItem|itemLabel=""
|parOrder=7
|itemSummary=
|parSummary=Automatically manage the number of output frames queued.
|itemName=signature2
|parItems=
|opFamily=COMP
}}
|parName=signature
{{Parameter
}}
|opFamily=COMP
|opType=engineCOMP
|parOrder=8
|parLabel=Out Buffer Frames
|opType=time
|parName=outframes
|parType=Int
|parType=Int
|parReadOnly=
|parReadOnly=
|parOrder=8
}}
|parSummary=The number of output frames to queue after receiving them from the TouchEngine instance.
{{Parameter|parName=tempo
 
|parLabel=Tempo
To accommodate potential fluctations in time-slice in the Engine COMP, CHOP outputs must send a number of frames ahead of time.
|opFamily=COMP
|parItems=
|parSummary=Sets the bpm for the Time Component.
}}
|parOrder=9
}}
|opType=time
{{ParameterPage
|opFamily=COMP
|pageName=InitStart
|pageSummary=
|items={{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Pre-Roll
|parName=preroll
|parType=Float
|parType=Float
|parReadOnly=
|parReadOnly=
|parOrder=0
|parItems=
|parSummary=
}}
|parItems=
{{Parameter|parName=independent
}}
|parLabel=Run Independently
{{Parameter
|opFamily=COMP
|opFamily=COMP
|parSummary=When checked on, this Time COMP's time will not be dependant on parent Time Components found in the network hierarchy. For example, starting/pausing other Time COMP's higher in the hierarchy will not start/pause a Time COMP whose '''Run Independently''' parameter is on.
|opType=engineCOMP
|parOrder=10
|parLabel=Pre-Roll Units
|opType=time
|parName=prerollunits
|parType=Menu
|parReadOnly=
|parOrder=1
|parSummary=
|parItems={{ParameterItem
|opFamily=COMP
|parName=prerollunits
|itemLabel=F
|itemName=frames
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=prerollunits
|itemLabel=S
|itemName=seconds
|itemSummary=
}}
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Ready when
|parName=readywhen
|parType=Menu
|parReadOnly=
|parOrder=2
|parSummary=
|parItems={{ParameterItem
|opFamily=COMP
|parName=readywhen
|itemLabel=Component Loaded
|itemName=loaded
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=readywhen
|itemLabel=Output Buffered
|itemName=buffered
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=readywhen
|itemLabel=Component Running
|itemName=running
|itemSummary=
}}
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Start when Initialized
|parName=startoninit
|parType=Toggle
|parReadOnly=
|parOrder=3
|parSummary=When enabled, playback will start as soon as the component has been loaded.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Initialize
|parName=initialize
|parType=Pulse
|parReadOnly=
|parOrder=4
|parSummary=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Initialize
|parName=initialize
|parType=Pulse
|parReadOnly=
|parOrder=4
|parSummary=Reload the .tox file, restarting the TouchEngine instance.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Start
|parName=start
|parType=Pulse
|parReadOnly=
|parOrder=5
|parSummary=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Start
|parName=start
|parType=Pulse
|parReadOnly=
|parOrder=5
|parSummary=Starts playback of the component in the TouchEngine instance.
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Play
|parName=play
|parType=Toggle
|parReadOnly=
|parOrder=6
|parSummary=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Play
|parName=play
|parType=Toggle
|parType=Toggle
|parReadOnly=
|parReadOnly=
|parOrder=6
|parItems=
|parSummary=Turn cooking in the TouchEngine instance on or off.
}}
|parItems=
}}
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Go to Done
|parName=gotodone
|parType=Pulse
|parReadOnly=
|parOrder=7
|parSummary=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=On Done
|parName=ondone
|parType=Menu
|parReadOnly=
|parOrder=8
|parSummary=
|parItems={{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Do Nothing
|itemName=donothing
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Pause
|itemName=pause
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Unload
|itemName=unload
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Re-Initialize
|itemName=reinit
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Re-Start
|itemName=restart
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=ondone
|itemLabel=Quit Engine Process
|itemName=quit
|itemSummary=
}}
}}
}}
{{ParameterPage
|opFamily=COMP
|pageName=Advanced
|pageSummary=
|items={{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=On Engine COMP Create
|parName=oncompcreate
|parType=Menu
|parReadOnly=
|parOrder=0
|parSummary=
|parItems={{ParameterItem
|opFamily=COMP
|parName=oncompcreate
|itemLabel=Do Nothing
|itemName=nothing
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=oncompcreate
|itemLabel=Launch Engine
|itemName=launch
|itemSummary=
}}<!--
-->{{ParameterItem
|opFamily=COMP
|parName=oncompcreate
|itemLabel=Load and Initialize
|itemName=initialize
|itemSummary=
}}
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Launch Engine Process
|parName=launch
|parType=Pulse
|parReadOnly=
|parOrder=1
|parSummary=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=engineCOMP
|parLabel=Quit Engine Process
|parName=quit
|parType=Pulse
|parReadOnly=
|parOrder=2
|parSummary=
|parItems=
}}
}}
{{:COMP Extensions Page}}
{{:COMP Extensions Page}}
{{:COMP Other Common Page}}
{{:COMP Other Common Page}}
{{InfoCHOPChannels
{{InfoCHOPChannels
|opFamily=COMP
|opFamily=COMP
|opLabel=Engine
|opLabel=Time
|infoChannels={{InfoChannel
|infoChannels={{InfoChannel
|chanName=initializing
|chanName=fps
|chanSummary=
|chanSummary=}}{{InfoChannel
}}
|chanName=start
{{InfoChannel
|chanSummary=}}{{InfoChannel
|chanName=ready
|chanName=end
|chanSummary=
|chanSummary=}}{{InfoChannel
}}
|chanName=rstart
{{InfoChannel
|chanSummary=}}{{InfoChannel
|chanName=running
|chanName=rend
|chanSummary=
|chanSummary=}}{{InfoChannel
}}
|chanName=bpm
{{InfoChannel
|chanSummary=}}{{InfoChannel
|chanName=timer_seconds
|chanName=sig1
|chanSummary=
|chanSummary=}}{{InfoChannel
}}
|chanName=sig2
{{InfoChannel
|chanSummary=}}{{InfoChannel
|chanName=playing_seconds
|chanName=play
|chanSummary=
|chanSummary=}}}}
}}
{{History
{{InfoChannel
}}
|chanName=running_seconds
{{COMPNavBox
|chanSummary=
|opFamily=COMP
}}
}}
{{InfoChannel
{{#invoke:Category
|chanName=reload_count
|list|COMPs}}
|chanSummary=
}}
{{InfoChannel
|chanName=input_buffer_frames
|chanSummary=
}}
{{InfoChannel
|chanName=output_buffer_frames
|chanSummary=
}}
{{InfoChannel
|chanName=total_frame_time
|chanSummary=
}}
{{InfoChannel
|chanName=frame_did_wait
|chanSummary=
}}
{{InfoChannel
|chanName=te_queue_size
|chanSummary=
}}
{{InfoChannel
|chanName=te_queue_start
|chanSummary=
}}
{{InfoChannel
|chanName=te_queue_end
|chanSummary=
}}
{{InfoChannel
|chanName=te_output_time
|chanSummary=
}}
{{InfoChannel
|chanName=te_render_ahead_time
|chanSummary=
}}
{{InfoChannel
|chanName=engine_fps
|chanSummary=
}}
{{InfoChannel
|chanName=engine_frame_msec
|chanSummary=
}}
{{InfoChannel
|chanName=engine_cook
|chanSummary=
}}
{{InfoChannel
|chanName=engine_dropped_frames
|chanSummary=
}}
{{InfoChannel
|chanName=engine_read_ahead_misses
|chanSummary=
}}
{{InfoChannel
|chanName=engine_gpu_mem_used
|chanSummary=
}}
{{InfoChannel
|chanName=engine_total_gpu_mem
|chanSummary=
}}
{{InfoChannel
|chanName=engine_active_ops
|chanSummary=
}}
{{InfoChannel
|chanName=engine_deactivated_ops
|chanSummary=
}}
{{InfoChannel
|chanName=engine_total_ops
|chanSummary=
}}
{{InfoChannel
|chanName=engine_cpu_mem_used
|chanSummary=
}}
{{InfoChannel
|chanName=engine_cookstate
|chanSummary=
}}
{{InfoChannel
|chanName=engine_cookrealtime
|chanSummary=
}}
{{InfoChannel
|chanName=engine_cookrate
|chanSummary=
}}
{{InfoChannel
|chanName=engine_timeslice_step
|chanSummary=
}}
{{InfoChannel
|chanName=engine_timeslice_msec
|chanSummary=
}}
}}
{{History
}}
{{NavBox
|Category=COMPs
}}
{{#invoke:Category|list|COMPs}}

Latest revision as of 07:55, 2 January 2024

Summary
[edit]

The Time Component allows each component to have its own timeline (clock). The Time Component contains a network of operators that can drive a Timeline, drive animations in Animation COMPs, or be used to drive any custom time-based system. The Time Component's parameters define the speed, range, various options for the time system.

The Time Component is often used in TouchDesigner to allow a component to have its own timeline / clock, this is called Component Time. It is useful for holding some parts of your system stationary while others are allowed to play forward. A Time Component's location must be in the /local network of a Component for the Time Component to create a Component Time.

To add Component Time to a component, right-click on the component and select Add Component Time... from the popup menu, this will add the following Time Component /comppath/local/time.

The Time Component's predefined network is Cloned from Master Component /sys/local/time. The Time Component's network can be modified if the path in the Clone parameter is removed.

PythonIcon.pngtimeCOMP_Class


Parameters - Time Page

Play play - Controls the playback of the Time Component. 0 = stop, 1 = play.

Rate rate - Sets the frame per second for the Time Component.

Start start - Sets the start frame for the Time Component. The Start and End parameters determine the overall length of the Time Component.

End end - Sets the end frame for the Time Component. The Start and End parameters determine the overall length of the Time Component.

Range Limit rangelimit - ⊞ - This menu controls how the playback loops:

  • Loop loop - The timeline will loop when it reaches Range End frame.
  • Hold hold - The timeline will stop (hold) when it reaches Range End frame.

Range Start rangestart - Sets the start frame of the working range. The working range is a subset of the start/end range which can be used to focus work on a smaller section of time. The playhead will only playback the frames/beats that are inside this working range.

Range End rangeend - Sets the end frame of the working range. The working range is a subset of the start/end range which can be used to focus work on a smaller section of time. The playhead will only playback the frames/beats that are inside this working range.

Reset Frame resetframe - Place holder to specify which frame to jump to (Obsolete).

Signature signature - ⊞ - Specifies the time signature. The first number is the number of beats per measure and the second number indicates the type of note that constitutes one beat. See Time Signature - Wikipedia for additional information.

  • signature1 -
  • signature2 -

Tempo tempo - Sets the bpm for the Time Component.

Run Independently independent - When checked on, this Time COMP's time will not be dependant on parent Time Components found in the network hierarchy. For example, starting/pausing other Time COMP's higher in the hierarchy will not start/pause a Time COMP whose Run Independently parameter is on.


Parameters - Extensions Page

The Extensions parameter page sets the component's python extensions. Please see extensions for more information.

Object ext0object - A number of class instances that can be attached to the component.

Name ext0name - Optional name to search by, instead of the instance class name.

Promote ext0promote - Controls whether or not the extensions are visible directly at the component level, or must be accessed through the .ext member. Example: n.Somefunction vs n.ext.Somefunction

Re-Init Extensions reinitextensions - Recompile all extension objects. Normally extension objects are compiled only when they are referenced and their definitions have changed.


Parameters - Common Page

The Common parameter page sets the component's node viewer and clone relationships.

Parent Shortcut parentshortcut - Specifies a name you can use anywhere inside the component as the path to that component. See Parent Shortcut.

Global OP Shortcut opshortcut - Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.

Shortcut iop0shortcut - Specifies a name you can use anywhere inside the component as a path to "Internal OP" below. See Internal Operators.

OP iop0op - The path to the Internal OP inside this component. See Internal Operators.

Operator Viewer opviewer - Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.

Enable Cloning enablecloning - Control if the OP should be actively cloneing. Turning this off causes this node to stop cloning it's 'Clone Master'.

Enable Cloning Pulse enablecloningpulse - Instantaneously clone the contents.

Clone Master clone - Path to a component used as the Master Clone.

Load on Demand loadondemand - Loads the component into memory only when required. Good to use for components that are not always used in the project.

Enable External .tox enableexternaltox - When on (default), the external .tox file will be loaded when the .toe starts and the contents of the COMP will match that of the external .tox. This can be turned off to avoid loading from the referenced external .tox on startup if desired (the contents of the COMP are instead loaded from the .toe file). Useful if you wish to have a COMP reference an external .tox but not always load from it unless you specifically push the Re-Init Network parameter button.

Enable External .tox Pulse enableexternaltoxpulse - This button will re-load from the external .tox file (if present).

External .tox Path externaltox - Path to a .tox file on disk which will source the component's contents upon start of a .toe. This allows for components to contain networks that can be updated independently. If the .tox file can not be found, whatever the .toe file was saved with will be loaded.

Reload Custom Parameters reloadcustom - When this checkbox is enabled, the values of the component's Custom Parameters are reloaded when the .tox is reloaded. This only affects top-level parameters on the component, all parameters on nodes inside the component are always reloaded with the .tox.

Reload Built-In Parameters reloadbuiltin - When this checkbox is enabled, the values of the component's built-in parameters are reloaded when the .tox is reloaded. This only affects top-level parameters on the component, all parameters on nodes inside the component are always reloaded with the .tox.

Save Backup of External savebackup - When this checkbox is enabled, a backup copy of the component specified by the External .tox parameter is saved in the .toe file. This backup copy will be used if the External .tox can not be found. This may happen if the .tox was renamed, deleted, or the .toe file is running on another computer that is missing component media.

Sub-Component to Load subcompname - When loading from an External .tox file, this option allows you to reach into the .tox and pull out a COMP and make that the top-level COMP, ignoring everything else in the file (except for the contents of that COMP). For example if a .tox file named project1.tox contains project1/geo1, putting geo1 as the Sub-Component to Load, will result in geo1 being loaded in place of the current COMP. If this parameter is blank, it just loads the .tox file normally using the top level COMP in the file.

Relative File Path Behavior relpath - ⊞ - Set whether the child file paths within this COMP are relative to the .toe itself or the .tox, or inherit from parent.

  • Use Parent's Behavior inherit - Inherit setting from parent.
  • Relative to Project File (.toe) project - The path, when specified as a relative path, will be relative to the .toe file.
  • Relative to External COMP File (.tox) externaltox - The path, when specified as a relative path, will be relative to the .tox file. When no external COMP file is specified, or when Enable External .tox is not toggled on, this doesn't have any impact.


Info CHOP Channels

Extra Information for the Time COMP can be accessed via an Info CHOP.

Specific Time COMP Info Channels

  • fps -
  • start -
  • end -
  • rstart -
  • rend -
  • bpm -
  • sig1 -
  • sig2 -
  • play -

Common COMP Info Channels

  • num_children - Number of children in this component.

Common Operator Info Channels

  • total_cooks - Number of times the operator has cooked since the process started.
  • cook_time - Duration of the last cook in milliseconds.
  • cook_frame - Frame number when this operator was last cooked relative to the component timeline.
  • cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
  • cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
  • cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
  • cooked_this_frame - 1 if operator was cooked this frame.
  • warnings - Number of warnings in this operator if any.
  • errors - Number of errors in this operator if any.


TouchDesigner Build:

COMPs
Actor • Ambient Light • Animation • Annotate • Base • Blend • Bone • Bullet Solver • Button • Camera Blend • Camera • MediaWiki:Common.js • Component • Constraint • Container • Engine • Environment Light • FBX • Field • Force • Geo Text • Geometry • GLSL • Handle • Impulse Force • Light • List • Null • Nvidia Flex Solver • Nvidia Flow Emitter • OP Viewer • Palette:depthProjection • Parameter • Replicator • Select • Shared Mem In • Shared Mem Out • Slider • Table • Text • Time • USD • Widget • Window

An Operator Family that contains its own Network. There are sixteen 3D Object Component and ten 2D Panel Component types. See also Network Path.

Cloning makes multiple components match the contents of a master component. A Component whose Clone parameter is set will be forced to contain the same nodes, wiring and parameters as its master component. Cloning does not create new components as does the Replicator COMP.

The term "Frame" is a measurement of time used (1) in the Timeline, (2) as a time-unit in CHOPs, and (3) as a time unit in movie files that are read into TOPs and written out from TOPs. The frame rate is the frames per second (FPS).

An Operator Family that contains its own Network. There are sixteen 3D Object Component and ten 2D Panel Component types. See also Network Path.

Any component can be extended with its own Python classes which contain python functions and data.

The sub-Family of Component types that are used to define and render 3D scenes. A Geometry Component is an Object that contains the 3D shapes to render. A Camera COMP and Light COMP are other Object types. Separately, "Objects" also refers to Python objects.

A Parent Shortcut is a parameter on a component that contains a name that you can use anywhere inside the component to refer to that component using the syntax parent.Name, for example parent.Effect.width to obtain panel width.

A name for a component that is accessible from any node in a project, which can be declared in a component's Global Operator Shortcut parameter.

There are four types of shortcuts: Application Shortcuts that are built-in to TouchDesigner's authoring interface, Panel Shortcuts that you create for any custom built panels, Parent Shortcuts for accessing a component from within that component, and Global OP Shortcuts that access a unique component from anywhere in TouchDesigner.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.

The viewer of a node can be (1) the interior of a node (the Node Viewer), (2) a floating window (RMB->View... on node), or (3) a Pane that graphically shows the results of an operator.

To "pulse" a parameter is to send it a signal from (1) an exported CHOP channel or (2) a python command or (3) a mouse click that causes a new action to occur immediately. A pulse via python is via the .pulse() function on a pulse-type parameter, such as Reset parameter in a Speed CHOP. A pulse from a CHOP is typically a 0 to 1 to 0 signal in an exported channel.

The location of an operator within the TouchDesigner environment, for example, /geo1/circle1, a node called circle1 in a component called geo1. The path / is called Root. This path is displayed at the top of every Pane, showing which Component's network you are currently in. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

TouchDesigner Component file, the file type used to save a Component of your TouchDesigner project.

TOuch Environment file, the file type used by TouchDesigner to save your entire project.

There are 2 kinds of parenting. The "parent component" is the component in which a node resides. The metaphor is extended to include grand parents, grand-grand parents, etc. The root / is the ultimate parent to all nodes. See also 3D Parenting and panel Parenting.

An Operator Family which operate on Channels (a sequence of numbers (Samples)) which are used for animation, audio, mathematics, simulation, logic, UI construction, and data streamed from/to devices and protocols.

Retrieved from "https://docs.derivative.ca/index.php?title=Engine_COMP&oldid=30718"