Annotate COMP

From Derivative
Jump to navigation Jump to search


Summary
[edit]

Annotates are displayed in the Network Editor as colored rectangles containing user-authored text and graphics. It is based on the Annotate COMP and allows you to document your networks with useful information like comments and node grouping.

There are three built-in forms of the Annotate COMP: Comments, Network Boxes, and Annotates that can be easily created:

  • Comments are simple, text-only post-it notes. They can be created via the network RMB menu or with the shortcut Shift-C
  • Network Boxes group nodes together for labeling/dragging. They can be created via the network RMB menu or with the shortcut Shift-B
  • Annotates (Default Setup) do all of the above and incorporate a powerful node-viewing feature. They can be created via the network RMB menu, with the shortcut Shift-A, by holding Alt and left-dragging in the network, or by selecting Annotate from the COMP family in the OP Create Dialog.

PythonIcon.pngannotateCOMP_Class


Default Setup

The default setup of Annotate COMPs is a full-featured comment, network box, and node viewer, designed to be a flexible network organization and documentation tool. The following features are built using internal nodes and an extension and are not inherent parts of the Annotate COMP itself.

The lock icon in the top-right of the box locks and unlocks text editing in the Annotate. In a locked Annotate, you cannot edit text and clicking on the body area clicks through to the network below. Annotates also have a RMB menu for quick access to many features. It is always accessible through the title bar, and accessible through the body when the Annotate is unlocked.

You can size Annotates by dragging the edges and move them by dragging the title bar. In Comment mode, which has no title bar, you can drag the Annotate by the text body. When the Enclose OPs feature is on, dragging an Annotate will drag all enclosed nodes (including other Annotates) with it. To drag an annotate without dragging its contents, you can hold down Alt while dragging.

Annotates have powerful built-in Operator Viewer features, including positioning and interaction, which can be controlled using Parameters - OP Viewer Page. For basic text features see Parameters - Text Page. For deeper text editing and color features including limiting text width, wrapping, and more, see Parameters - Settings Page.

Annotates are layered in the network so that smaller boxes are in front of larger boxes, but you have more control with the Depth Layer parameter. Annotates are positioned behind the grid by default, but you can put them in front of the grid, or even on top of the nodes tiles. For example, put an image with transparency in the Viewer OP and turn Back Color Alpha to 0, then set Layer Zone to be Above Nodes.

Because the Enter shortcut and zoom-to-enter are disabled in Annotates, to get inside an Annotate, use one of the following methods:

  1. Box-pick an Annotate, then right-click on the network and select "Jump Down".
  2. Find the Annotate via the path bar at the top of the network pane.
  3. Box-pick an Annotate, right-click on the "i" icon on the Parameter Dialog and select Enter Annotation from the node menu.

You can switch between the three built-in Annotate modes by using the Mode parameter of the Annotate COMP or the Mode menu in the right-click menu.

Parameters - Text Page

Basic text features including editable/searchable parameters holding the Annotate's text.

Mode Mode - - Switch between Comment, Network Box, and Annotate Modes

  • Annotate annotate - All features available.

Title Text Titletext - Text in the title bar

Title Height Titleheight - Height of the title bar

Title Align Titlealign - - Alignment of title text

  • Left left -
  • Center center -
  • Right right -

Body Text Bodytext - Text in the body area

Body Font Size Bodyfontsize - Size of text in the body area


Parameters - Settings Page

More advanced text control and color parameters.

Mode Mode - - Switch between Comment, Network Box, and Annotate modes. See also Network_Utilities:_Comments,_Network_Boxes,_Annotates.

  • Comment comment -
  • Network Box networkbox -
  • Annotate annotate -

Body Word Wrap Bodywordwrap - Wrap body text when it extends past right bound.

Smart Quote Smartquote - Converts quotes, ellipsis, and dashes to more typographically nice unicode versions.

Limit Body Text Width Bodylimitwidth - Use the Max Body Text Width parameter to define maximum width of text.

Max Body Text Width Bodymaxwidth - Maximum body text width (in panel units)

Back Color Backcolor - - Background color

  • Back Color Backcolorr -
  • Back Color Backcolorg -
  • Back Color Backcolorb -

Back Color Alpha Backcoloralpha - Background color alpha.

Annotate Opacity Opacity - Opacity of the entire Annotate


Parameters - OP Viewer Page

Controls for the embedded Operator viewer.

Viewer Display Opviewerdisplay - Turn the visibility of the viewer specified in the OP parameter below on or off.

OP Opviewer - The operator whose viewer is displayed in the Annotate

OP Viewer Interactive Opviewerinteractive - Allow interaction with the OP viewer

Size/Aspect Override Opvieweroversize - - Use the Size/Aspect Override to control viewer's size in the background.

  • Natural natural -
  • Specify specify -
  • Auto-fit autofit -

Size/Aspect Opviewersize - - Diplay viewer as-if it were being displayed at this resolution. This is particularly useful for zooming into operators that don't have a built-in resolution, like CHOPs, SOPs, and DATs.

  • Size/Aspect Opviewersizew -
  • Size/Aspect Opviewersizeh -

Scale Opviewerscale - Scale the viewer by this factor

Justify X Opviewerjustifyx - Move the border of the viewer towards left edge of Annotate when negative or towards right edge when positive.

Justify Y Opviewerjustifyy - Move the border of the viewer towards bottom edge of Annotate when negative or towards top edge when positive.

Cover Body and Title Opviewerfillbodytitle - When True, allow viewer to display in the Annotate title area as well as body

OP Viewer Zoom Opviewerzoom - Zoom the viewer by this scale factor without increasing the size of its display area in the Annotate.

OP Viewer Offset Opvieweroffset - - Offsets the displayed area within the viewer. Combined with OP Viewer Zoom, this lets you display a specific area of a viewer, such as a CHOP channel or table cell.

  • OP Viewer Offset Opvieweroffsetx -
  • OP Viewer Offset Opvieweroffsety -

Fill Alpha Opviewerfillalpha - Alpha value of the background area in the OP Viewer.


Parameters - About Page

Version Version - Annotate COMP default setup version

Help Help - Click to open this page


Annotate Extension

Members

BodyColor[R, G, B, A] (Read Only):

RGBA of color used for body.

BodyFontColor[R, G, B, A] (Read Only):

RGBA of font color used in body.

BodySelectColor[R, G, B, A] (Read Only):

RGBA of selection color for body text.

BodyText →  :

Text of body.

Color[R, G, B] (Read Only):

RGB of base color set in Back Color parameter

EncloseOPsbool :

If True, Annotate encloses operators in its network area for movement and other features

TitleColor[R, G, B, A] (Read Only):

RGBA background color of title area

TitleFontColor[R, G, B, A] (Read Only):

RGBA font color of title area

TitleSelectColor[R, G, B, A] (Read Only):

RGBA of selection color for title text

TitleText →  :

Text in title area

Methods

OnCreate(Mode):

Called on initial creation of Annotate. Mode can be "annotate", "comment", or "networkbox"

Parameters - Annotate Page

Operator Viewer opviewer - The operator whose view is displayed in the Annotate area. This defines what the entire Annotate looks like and is not to be confused with the OP parameter in the OP Viewer page, which is an integrated viewer _within_ the annotate.

Enable Interaction enable - When False, disables all interaction with the Annotate and passes any clicks through to the network below.

Enclose Operators encloseops - When True, other operators in the Annotate's area will move with it when it is moved.

Include in Order includeinorder - Include this Annotate in the Order of annotateCOMPs in this network.

Order order - Order number of this annotateCOMP

Layer Zone layerzone - - Where this annotateCOMP is layered with regards to other items in the network.

  • Below Grid belowgrid - Behind everything, including the grid.
  • Between Grid and Nodes betweengridnodes - Behind nodes but in front of grid
  • Above Nodes abovenodes - Above everything, including grid and nodes.

Depth Layer layer - Last ditch layering index. AnnotateCOMPs in the same zone will always attempt to display smaller annotateCOMPs they enclose on top.


Parameters - Extensions Page

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

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

Extension Object 1 extension1 - A number of class instances that can be attached to the component.

Extension Name 1 extname1 - Optional name to search by, instead of the instance class name.

Promote Extension 1 promoteextension1 - 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


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 Shortcut opshortcut - Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.

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

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

Node View 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.

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

Keep in Memory keepmemory - Used only for Panel Components this keeps the panel in memory to it doesn't reload every time it is displayed.

Enable Cloning enablecloning - Control if the OP should be actively cloned.

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.

External .tox 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 .tox on Start reloadtoxonstart - 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.

Reload Custom Parameters reloadcustom - When this checkbox is enabled, the values of the component's Custom Parameters are reloaded when the .tox is reloaded.

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.

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.

Re-Init Network reinitnet - This button will re-load from the external .tox file (if present), followed by re-initializing itself from its master, if it's a clone.


Info CHOP Channels

Extra Information for the Annotate 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:

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 • Handle • Impulse Force • Light • List • Nvidia Flex Solver • Nvidia Flow Emitter • OP Viewer • Parameter • Replicator • Select • Shared Mem In • Shared Mem Out • Slider • Table • Text • Time • USD • Widget • Window