Handle COMP
Summary
The Handle Component is a new IK tool designed for manipulating groups of bones. Whereas the previous IK tools only allowed for a single end-affector per bone chain, this new method allows for several end-affectors per bone. Furthermore, the bones need not be a chain. Any setup, including branches, are handled.
One typical example is the use of motion capture data. In higher-end systems, you could have a cloud of marker positions and a skeleton to be driven by it.
This Handle Component works in tandem with the Handle CHOP. The following setup is commonly used: Given a hierarchy of bones, attach one or more Handle Components to specific locations on each Bone Component. Assign each handle a target in space to follow. Create a Handle CHOP which collects this information and calculates the rotation channels for the bones. Export these values back to the bones.
Parameters - Handle Page
target
- Where the Handle will pull the bone towards (like an end-affector).
t
- ⊞ - Displacement tx,ty,tz relative to the origin of the bone where the handle is anchored.
- X
tx
-
- Y
ty
-
- Z
tz
-
weight
- When multiple handles are attached to a bone, higher weighted handles draw closer to their target.
twistonly
- When enabled the handle only contributes the the z rotation of the bone, when disabled it points the bone (rx, ry, and rz).
falloff
- This value affects how much parent bones are affected when the child bone is reaching a target. It affects the flexibility of the chain.
dorxlimit
- These affects how much the bone is allowed to rotate with respect to its parent.
lrx
- ⊞ - Set the minimum and maximum rotation range in X axis.
lrxmin
-
lrxmax
-
dorylimit
- These affects how much the bone is allowed to rotate with respect to its parent.
lry
- ⊞ - Set the minimum and maximum rotation range in Y axis.
lrymin
-
lrymax
-
dorzlimit
- These affects how much the bone is allowed to rotate with respect to its parent.
lrz
- ⊞ - Set the minimum and maximum rotation range in Z axis.
lrzmin
-
lrzmax
-
Parameters - Render Page
The Display parameter page controls the component's material and rendering settings.
render
- Whether the Component's geometry is visible in the Render TOP. This parameter works in conjunction (logical AND) with the Component's Render Flag.
drawpriority
- Determines the order in which the Components are drawn. Smaller values get drawn after larger values. The value is compared with other Components in the same parent Component, or if the Component is the top level one listed in the Render TOP's 'Geometry' parameter, then against other top-level Components listed there. This value is most often used to help with Transparency.
pickpriority
- When using a Render Pick CHOP or a Render Pick DAT, there is an option to have a 'Search Area'. If multiple objects are found within the search area, the pick priority can be used to select one object over another. A higher value will get picked over a lower value. This does not affect draw order, or objects that are drawn over each other on the same pixel. Only one will be visible for a pick per pixel.
wcolor
- ⊞ - Use the R, G, and B fields to set the Component's color when displayed in wireframe shading mode.
- Red
wcolorr
-
- Green
wcolorg
-
- Blue
wcolorb
-
lightmask
- By default all lights used in the Render TOP will affect geometry renderer. This parameter can be used to specify a sub-set of lights to be used for this particular geometry. The lights must be listed in the Render TOP as well as this parameter to be used.
Parameters - Extensions Page
The Extensions parameter page sets the component's python extensions. Please see extensions for more information.
ext
- Sequence of info for creating extensions on this component
ext0object
- A number of class instances that can be attached to the component.
ext0name
- Optional name to search by, instead of the instance class name.
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
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.
parentshortcut
- Specifies a name you can use anywhere inside the component as the path to that component. See Parent Shortcut.
opshortcut
- Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.
iop
- Sequence header for internal operators.
iop0shortcut
- Specifies a name you can use anywhere inside the component as a path to "Internal OP" below. See Internal Operators.
nodeview
- ⊞ - Determines what is displayed in the node viewer, also known as the Node Viewer. Some options will not be available depending on the Component type (Object Component, Panel Component, Misc.)
- Default Viewer
default
- Displays the default viewer for the component type, a 3D Viewer for Object COMPS and a Control Panel Viewer for Panel COMPs.
- Operator Viewer
opviewer
- Displays the node viewer from any operator specified in the Operator Viewer parameter below.
opviewer
- Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.
enablecloning
- Control if the OP should be actively cloneing. Turning this off causes this node to stop cloning it's 'Clone Master'.
enablecloningpulse
- Instantaneously clone the contents.
loadondemand
- Loads the component into memory only when required. Good to use for components that are not always used in the project.
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.
enableexternaltoxpulse
- This button will re-load from the external .tox
file (if present).
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.
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.
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.
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.
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.
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 Handle COMP can be accessed via an Info CHOP.
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: