Slider COMP

From TouchDesigner 099 Wiki

Summary

The Slider Component lets you build sliders in X, Y and XY, and outputs 1 or 2 channels from a Panel CHOP placed in the Slider component.

See Panel Value.

PythonIcon.png sliderCOMP_Class

Parameters - Layout Page

The Layout parameter page controls the size and position of the panel.

X x - Specify the horizontal position in pixels relative to its parent.

Y y - Specify the vertical position in pixels relative to its parent.

Width w - Specify the panel's width in pixels.

Height h - Specify the Panel's height in pixels.

Fixed Aspect fixedaspect - Allows easy creation of panels with a specific aspect set in the Aspect Ratio parameter below. Only requires setting the width or height of the panel and the other dimension is calculated based on the Aspect Ratio parameter.

Aspect Ratio aspect - Specify the ratio when using Fixed Aspect parameter above, the ratio is width/height.

Depth Layer layer - Specifies the order the panel components are drawn in, similar to layers in Photoshop. Higher values will be drawn over any other panel with a lower value (that is at the same level of hierarchy). If two panel components have the same Depth Layer value then they are ordered based on the operator's name.


Horizontal Mode hmode - Select one of 3 modes to determine the horizontal width of the panel.

  • Fixed Width - Uses the Width parameter above to set this panel's width in pixels.
  • Fill - The width of this panel will match (fill) the width of the parent panel.
  • Anchors - The width of this panel is set by the Left Anchor and Right Anchor parameters below which will maintain a relative width to the parent panel as the parent panel changes size. This allows for stretchy panels. These anchor parameters are normalized 0-1 like uv coordinates where 0 is the left edge and 1 is the right edge of the parent panel. For example, Left Anchor = 0.2 and Right Anchor = 0.8 will maintain the width proportionally to the parent panel such that the left edge is 20% (0.2) in from the left and the right edge is 20% (0.8) in from the right.

Left Anchor leftanchor - Position of the left anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the left edge of the parent and 1 is the right edge of the parent.

Left Offset leftoffset - An offset for the left anchor in pixels.

Right Anchor rightanchor - Position of the right anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the left edge of the parent and 1 is the right edge of the parent.

Right Offset rightoffset - An offset for the right anchor in pixels.

Horizontal origin horigin - Sets the position of the panel's origin horizontally. The default origin (0,0) is the bottom-left corner of the panel.

Horizontal Fill Weight hfillweight - When multiple panels are using Horizontal Mode = Fill and being aligned by the parent either Left to Right or Right to Left, this fill weight parameter can be used to bias the fill width of the panels.


Vertical Mode vmode - Select one of 3 modes to determine the vertical height of the panel.

  • Fixed Height - Uses the Height parameter above to set this panel's height in pixels.
  • Fill - The height of this panel will match (fill) the height of the parent panel.
  • Anchors - The height of this panel is set by the Bottom Anchor and Top Anchor parameters below which will maintain a relative and proportionally height to the parent panel as the parent panel changes size. This allows for stretchy panels. These anchor parameters are normalized 0-1 like uv coordinates where 0 is the bottom edge and 1 is the top edge of the parent panel. For example, Bottom Anchor = 0.3 and Right Anchor = 0.5 will maintain the height proportionally to the parent panel such that the bottom edge is 30% (0.3) up from the bottom and the top edge is 50% (0.5) down from the top.

Bottom Anchor bottomanchor - Position of the bottom anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the bottom edge of the parent and 1 is the top edge of the parent.

Bottom Offset bottomoffset - An offset for the bottom anchor in pixels.

Top Anchor topanchor - Position of the top anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the bottom edge of the parent and 1 is the top edge of the parent.

Top Offset topoffset - An offset for the top anchor in pixels.

Vertical origin vorigin - Sets the position of the panel's origin vertically. The default origin (0,0) is the bottom-left corner of the panel.

Vertical Fill Weight vfillweight - When multiple panels are using Vertical Mode = Fill and being aligned by the parent either Top to Bottom or Bottom to Top, this fill weight parameter can be used to bias the fill height of the panels.


Parent Alignment alignallow - When set to Ignore, the Panel will ignore any Align parameter settings from its parent.

  • Allow - Aligns the panel based on settings in parent.
  • Ignore - Does not align the panel but respects margins.
  • Ignore and Margins - Does not align the panel and disregards margins.

Align Order alignorder - This parameter allows you to specify the align position when its parent's Align parameter is set to something other then None or Match Network Nodes. Lower numbers are first.

Post Offset postoffset[xy] - Adds an offset after all other postions and alignment options have been applied to the panel.

Size From Window stufffromwindow - When enabled the panel component's width and height are set by resizing its floating viewer window.


Parameters - Panel Page

The Panel parameter page controls panel attributes such as display on/off, enable on/off, panel help, and interactions with the cursor.

Display display - Specifies if the panel is displayed or hidden.

Enable enable - Allows you to prevent all interaction with this panel.

Help DAT helpdat - Lets you specify the path to a Text DAT whose content will be displayed as a rollover pop-up help for the control panel.

Floating Viewer Aspect vieweraspect - Controls whether the aspect ratio is proportional or unconstrained when resizing a floating viewer ie. dragging the edges of the viewer to resize it.


Cursor cursor - Changes the cursor displayed when cursor is over the panel.

Multi-Touch multitouch - When enabled, this panel will process the first touch it gets in a similar manner to how it processes a mouse click, with updates to u, v, state etc. The touch event must be initiated from the panel. Subsequent touches are ignored. If this panel handles multi-touch events via the Multi Touch In DAT, you may want to disable Built-in Multi-Touch so it won't interfere with script processing.

  • Use Parent's Multi-Touch Settings - Use the parent's Multi-Touch setting. This defaults to enabled in the root component.
  • Use Built-in Multi-Touch - Enable use of first touch as mouse.
  • Do Not Use Built-in Multi-Touch - Disable use of first touch as mouse.

Click Through clickthrough - When enabled all mouse clicks are ignored by this Panel Component.

Use Mouse Wheel mousewheel - Turn on to capture events when the mouse wheel is used over the panel.

Mouse UV Buttons uvbuttons[left,middle,right] - Allows you to specify which mouse buttons update the uv Panel Values.

Relative UV mouserel - When enabled the uv Panel Values will reflect relative mouse movement.


Drag Edges to Resize resize[lrbt] - Four checkboxes allow you to enable resizing a panel by grabbing the corresponding edge or corner: Resize Left, Right, Bottom, Top.

W Range resizewmin resizewmax - Limits the left-right (width) resizing range.

H Range resizehmin resizehmax - Limits the bottom-top (height) resizing range.

Drag to Reposition reposition - Enables repositioning of the panel or window by dragging with the mouse.

Component repocomp - Enabled by choosing the Component option from the Reposition parameter. Specify the path to the panel component you would like to reposition by mouse.

X Range repositionx[min,max] - Enabled by choosing the Component option from the Reposition parameter. Sets the maximum range for repositioning the panel component horizontally.

Y Range repositiony[min,max] - Enabled by choosing the Component option from the Reposition parameter. Sets the maximum range for repositioning the panel component vertically.


Parameters - Look Page

The Color parameter page sets the panel's background, border, and disabled colors.

Background Color bgcolor[rgb] - RGB values for the background. (default: black (0,0,0))

Background Alpha bgcolora - Set the alpha value for the background.

Background TOP top - Allows you to specify a TOP as the background for the panel.

TOP Fill topfill - This menu specifies the way the Background TOP will fill the panel's background.


Border A bordera[rgb] - RGB values for border A color.

Border A Alpha borderaalpha - Alpha value for border A color.

Border B borderb[rgb] borderbalpha - RGBA values for border B color.

Border B Alpha borderbalpha - Alpha value for border B color.

Left Border leftborder leftborderi - What color the 2 left-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).

Right Border rightborder rightborderi - What color the 2 right-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).

Bottom Border bottomborder bottomborderi - What color the 2 bottom-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).

Top Border topborder topborderi - What color the 2 top-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).

Border Over Children borderover - Draws the panel's borders on top of all children panels.


Disable Color dodisablecolor - Enable the use of a unique disable color below when the panel's Enable = Off.

Disable Color disablecolor[rgb] - RGB values for the disable color. (default: black (0,0,0))

Disable Alpha disablealpha - Set the alpha value for the disable color.


Multiply RGB by Alpha multrgb - Multiplies the RGB channels by the alpha channel.

Composite composite - Selects how the panel is composited with its siblings panels. See the Composite TOP for a description of the various composite methods.

Opacity opacity - Allows you to control the transparency of the panel.


Parameters - Children Page

The Children parameter page controls aspects of the Panel's children alignment, size, and position.

Align align - This menu allows you to specify how the children inside the Panel Component will be laid out. The options Layout Grid Rows, Layout Grid Columns and Match Network Nodes will scale the Panel Component's children to fit the Component. They use the Align Order of each of the children to determine the ordering of the children.

Spacing spacing - This is enabled by choosing any Align option other than None or Match Network Nodes. It defines the space between the children when they are being aligned.

Max per Line alignmax - This is enabled by choosing any Align option other than None, Layout Grid Horizontal, Layout Grid Vertical, or Match Network Nodes, and defines the maximum number of children placed in one row or column.


Margin margin[lrbt] - The four fields allow you to specify the space that surrounds the Panel Component. The margin is the space between the Panel Component's border and the outer edge. The Margin is defined in absolute pixels and does not stretch with the window, as a result margin is not reflected in the node's panel viewer but only when the parent is drawn in a floating window.

Justify Horizontal justifyh - This menu specifies if the panel's children are being justified horizontally.

Justify Vertical justifyv - This menu specifies if the panel's children are being justified vertically.

Fit fit - This menu allows you to scale the panel's children. It overrides the Justify Horizontal and Justify Vertical parameters.

Scale scale[xy] - Allows you to uniformly scale the Panel's children.

Offset offset[xy] - Allows you to offset the Panel's children. This parameter is overwritten by the Align, Justify Horizontal, and Justify Vertical parameters above.

Crop crop - This menu determines if any children panels which are positioned partially or completely outside the panel component's dimensions get cropped.


Parameters - Slider Page

Slider Type /slidertype - sets the type of slider.

  • - Slider U - a horizontal slider that tracks movement only in the u Panel Value.
  • - Slider V - a vertical slider that tracks movement only in the v Panel Value.
  • - Slider UV - a slider that tracks movement in both u and v Panel Values.

Zone Left /zonel - sets the left bounding area that the slider will track movement in. 0 is the left edge of the panel, 1 is the right edge of the panel. Values outside the 0-1 range can be used.

Zone Right /zoner - sets the right bounding area that the slider will track movement in.

Zone Bottom /zoneb - sets the bottom bounding area that the slider will track movement in.

Zone Top /zonet - sets the top bounding area that the slider will track movement in.

Clamp U Low /clampul - clamps the minimum output of the panel value u to 0.

Clamp U High /clampuh - clamps the maximum output of the panel value u to 0.

Clamp V Low /clampvl - clamps the minimum output of the panel value v to 0.

Clamp V High /clampvh - lamps the maximum output of the panel value v to 0.


Parameters - Drag Page

The Drag parameter page controls the panel's drag and drop behavior.

See also Drag-and-Drop


Parameters - Common Page

The Common parameter page sets the component's node viewer, clone relationships, Parent Shortcut, and Global OP Shortcut.

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.

Node View - 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 - Displays the default viewer for the component type, a 3D Viewer for Object COMPS and a Control Panel Viewer for Panel COMPs.
  • Operator Viewer - 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.


Enable Cloning enablecloning - Control if the OP should be actively cloned. The Pulse button can be used to 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.

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.