Base COMP and COMP Other Common Page: 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
{{ParameterPage
|opLabel=Base
|pageName=Common
|opLicense=Non-Commercial
|opFilter=False
|short=The Base Component has no panel parameters and no 3D object parameters.
|opFamily=COMP
|opFamily=COMP
|long=The Base Component has no panel parameters and no 3D object parameters. You would use it for a component that has no panel associated with it, nor any 3D, such as component that converted RGB channels to HSV channels.
|pageSummary=The Common parameter page sets the component's [[Node Viewer|node viewer]] and [[Clone|clone]] relationships.
|opType=base
|items=
|opClass=baseCOMP_Class
{{Parameter
|opCategories=
|opFamily=COMP
}}
|opType=other
{{ParameterPage
|parName=parentshortcut
|pageName=Base
|parLabel=Parent Shortcut
|parOrder=0
|parSummary=Specifies a name you can use anywhere inside the component as the path to that component. See [[Parent Shortcut]].
|parType=COMP
|parReadOnly=
|parItems=
}}<!--
-->
{{Parameter
|opFamily=COMP
|opType=other
|parName=opshortcut
|parLabel=Global OP Shortcut
|parOrder=0
|parSummary=Specifies a name you can use anywhere at all as the path to that component. See [[Global OP Shortcut]].
|parType=COMP
|parReadOnly=
|parItems=
}}<!--
-->
{{Parameter
|opFamily=COMP
|opType=other
|parName=iop0shortcut
|parLabel=Shortcut
|parOrder=0
|parSummary=Specifies a name you can use anywhere inside the component as a path to "Internal OP" below. See [[Internal Operators]].
|parType=COMP
|parReadOnly=
|parItems=
}}<!--
-->
{{Parameter
|opFamily=COMP
|opType=other
|parName=iop0op
|parLabel=OP
|parOrder=0
|parSummary=The path to the Internal OP inside this component. See [[Internal Operators]].
|parType=COMP
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=opviewer
|parLabel=Operator Viewer
|parOrder=1
|parSummary=Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.
|parType=OP
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opFamily=COMP
|items=
|opType=other
|pageSummary=
|parName=enablecloning
}}
|parLabel=Enable Cloning
{{:COMP Extensions Page}}
|parOrder=3
{{:COMP Other Common Page}}
|parSummary=Control if the OP should be actively cloneing. Turning this off causes this node to stop cloning it's 'Clone Master'.
{{InfoCHOPChannels
|parType=Toggle
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=enablecloningpulse
|parLabel=Enable Cloning Pulse
|parOrder=4
|parSummary=Instantaneously clone the contents.
|parType=Pulse
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=clone
|parLabel=Clone Master
|parOrder=5
|parSummary=Path to a component used as the Master [[Clone]].
|parType=COMP
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=loadondemand
|parLabel=Load on Demand
|parOrder=6
|parSummary=Loads the component into memory only when required. Good to use for components that are not always used in the project.
|parType=Toggle
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=enableexternaltox
|parLabel=Enable External .tox
|parOrder=7
|parSummary=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.
|parType=Toggle
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=enableexternaltoxpulse
|parLabel=Enable External .tox Pulse
|parOrder=7
|parSummary=This button will re-load from the external <code>.tox</code> file (if present).
|parType=Pulse
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=externaltox
|parLabel=External .tox Path
|parOrder=7
|parSummary=Path to a <code>.tox</code> file on disk which will source the component's contents upon start of a <code>.toe</code>. This allows for components to contain networks that can be updated independently. If the <code>.tox</code> file can not be found, whatever the <code>.toe</code> file was saved with will be loaded.
|parType=File
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=reloadcustom
|parLabel=Reload Custom Parameters
|parOrder=9
|parSummary=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]].
|parType=Toggle
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parLabel=Reload Built-In Parameters
|parName=reloadbuiltin
|parType=Toggle
|parReadOnly=
|parOrder=10
|parSummary=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]].
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=savebackup
|parLabel=Save Backup of External
|parOrder=11
|parSummary=When this checkbox is enabled, a backup copy of the component specified by the External <code>.tox</code> parameter is saved in the <code>.toe</code> file.  This backup copy will be used if the External <code>.tox</code> can not be found. This may happen if the <code>.tox</code> was renamed, deleted, or the <code>.toe</code> file is running on another computer that is missing component media.
|parType=Toggle
|parReadOnly=
|parItems=
}}
{{Parameter
|opFamily=COMP
|opType=other
|parName=subcompname
|parLabel=Sub-Component to Load
|parOrder=12
|parSummary=When loading from an External <code>.tox</code> file, this option allows you to reach into the <code>.tox</code> 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 <code>.tox</code> file named <code>project1.tox</code> contains <code>project1/geo1</code>, putting <code>geo1</code> as the Sub-Component to Load, will result in <code>geo1</code> being loaded in place of the current COMP. If this parameter is blank, it just loads the <code>.tox</code> file normally using the top level COMP in the file.
|parType=Str
|parReadOnly=
|parItems=
}}
{{Parameter
|parOrder=0
|parSummary=
|opFamily=COMP
|parName=relpath
|parItems={{ParameterItem
|opFamily=COMP
|parName=relpath
|itemSummary=
|itemName=inherit
|itemLabel=Use Parent's Behavior
}}<!--
-->{{ParameterItem
|opFamily=COMP
|opFamily=COMP
|opLabel=Base
|parName=relpath
|infoChannels=}}
|itemSummary=
{{History
|itemName=project
}}
|itemLabel=Relative to Project File (.toe)
{{COMPNavBox
}}<!--
-->{{ParameterItem
|opFamily=COMP
|opFamily=COMP
}}
|parName=relpath
{{#invoke:Category
|itemSummary=
|list|COMPs}}
|itemName=externaltox
|itemLabel=Relative to External COMP File (.tox)
}}
|opType=other
|parLabel=Relative File Path Behavior
|parType=Menu
|parReadOnly=
}}
}}
<noinclude>[[Category:OP Help Common Pages]]</noinclude>

Revision as of 07:53, 2 January 2024

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 - ⊞ -

  • Use Parent's Behavior inherit -
  • Relative to Project File (.toe) project -
  • Relative to External COMP File (.tox) externaltox -

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.

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.

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.

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

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

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.

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