Window COMP

Summary

The Window Component allows you to create and maintain a separate floating window displaying the contents of any Panel or any other Node Viewer. You create a Window component, then point it to a panel or other Operator. You turn on the Open parameter of the Window component and adjust its settings, such as resolution, centering, and which monitor it gets displayed on. You see exactly what you would see in the Node Viewer.

Windows can be fit to a single monitor, span several monitors, or several Window components can occupy one monitor.

Press Esc over a selected window to make it close.

The Window component also is used for Perform Mode, where it is most often called /perform, the default window for Perform Mode. See also Window.

To find out whether a window is actually open, and if so, what its actual position and size are, attach an Info CHOP to the Window component.

Parameters - Window Page

Operator /winop - Specifies the operator the window will display.

Title /title - Specify the window's title.

Area /area - All the positioning parameters below are done relative to the 'Area' that you define here. Your window can span more than the specified 'area', it's just used as the reference for positioning.

• Desktop /desktop - Define area to include the entire area of the primary monitor without the taskbar.
• Single Monitor /smonitor - Define the area to include the entire specified monitor.
• Bounds /bounds - Define the area to include all monitors.

Fill Area /fill - Fills the defined area with the supplied image.

Monitor /monitor - Specify the monitor index when Area is set to Full Screen.

Justify Horizontal /justifyh

• Left /left - Align window so that left edge coincides with left edge of specified area.
• Center /center - Align window so that horizontal center coincides with horizontal center of specified area.
• Right /right - Align window so that right edge coincides with right edge of specified area.
• Mouse /mouse - Align window so it opens horizontally centered on the mouse cursor.

Justify Vertical /justifyv -

• Top /top - Align window so that top edge coincides with top edge of specified area.
• Center /center - Align window so that vertical center coincides with vertical center of specified area.
• Bottom /bottom - Align window so that bottom edge coincides with bottom edge of specified area.
• Mouse /mouse - Align window so it opens vertically centered on the mouse cursor.

X /winx - Horizontal offset applied to window after justifying.

Y /winy - Vertical offset applied to window after justifying.

Specify Size /size - When ‘On’, the size of the window is specified by the W, H parameters below. When ‘Off’ the size of the window is taken from the operator it references. In the case of panels, it is the panel width and height. In the case of TOPs, it is the native image resolution.

W /winw - The default width of the window when not specified.

H /winh - The default height of the window when not specified.

Keep Window Aspect /keepaspect

• Off /off - The window may be resized to any aspect ratio.
• On /on - The window aspect ratio is maintained while resizing.
• Auto /auto - The referenced operator controls whether or not the aspect ratio is maintained.

Borders /borders - Controls whether or not the window contains borders and a title bar.

Always on Top /alwaysontop - Controls whether or not the window always sits atop other floating windows.

Open on Start /onstart - Sets the state of the window when the application is first loaded.

Cursor Visible /cursorvisible - Controls whether or not the cursor remains visible when over this window.

Close on Escape Key /closeescape - When selected, pressing the escape key over this window will close it.

Perform Mode /performmode - When any window component is open and has this option selected, the main editing window will not be drawn or refreshed.

Open /winopen - When this value is greater than zero, the window is opened, otherwise it is closed.

Read Current Settings /readcurrent - When clicked the windows placement parameters will be updated with the window's current position.

Parameters - Common Page

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

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.)

• Geometry Viewer - Shows a 3D geometry viewer displaying the geometry inside the component. This option is only available for Object components.
• Control Panel - Displays the Control Panel, only available for Panel Components.
• 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 is set to Operator Viewer.

Clone /clone - Path to a component used as the Master Clone. If the component specified as Master exists, then this component becomes a clone.

Path Variable /pathvar - Specifies a variable name you can use anywhere inside the component as the path to that component. See Path Variable.

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 content upon start of a .toe. This allows for components to contain networks that can be updated independently of the .toe file. Paths used to locate .tox files should not contain expressions or root variables. Built-in and Environment variables (like $MYDOCUMENTS, $DESKTOP and $HOME) are accepted. If the .tox file can not be found, whatever the .toe file was saved with will be loaded.

Use Backup Copy if External .tox is Missing /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.