// / // @ts-ignore import { app } from "../../scripts/app.js"; import { RgthreeBaseVirtualNode } from "./base_node.js"; import { NodeTypesString } from "./constants.js"; import { type LGraphNode, type LGraph as TLGraph, type LiteGraph as TLiteGraph, LGraphCanvas as TLGraphCanvas, Vector2, SerializedLGraphNode, IWidget, } from "typings/litegraph.js"; import {SERVICE as FAST_GROUPS_SERVICE} from "./fast_groups_service.js"; import { drawNodeWidget, fitString } from "./utils_canvas.js"; import { RgthreeBaseVirtualNodeConstructor } from "typings/rgthree.js"; declare const LGraphCanvas: typeof TLGraphCanvas; declare const LiteGraph: typeof TLiteGraph; const PROPERTY_SORT = "sort"; const PROPERTY_SORT_CUSTOM_ALPHA = "customSortAlphabet"; const PROPERTY_MATCH_COLORS = "matchColors"; const PROPERTY_MATCH_TITLE = "matchTitle"; const PROPERTY_SHOW_NAV = "showNav"; const PROPERTY_RESTRICTION = "toggleRestriction"; /** * Fast Muter implementation that looks for groups in the workflow and adds toggles to mute them. */ export abstract class BaseFastGroupsModeChanger extends RgthreeBaseVirtualNode { static override type = NodeTypesString.FAST_GROUPS_MUTER; static override title = NodeTypesString.FAST_GROUPS_MUTER; static override exposedActions = ["Mute all", "Enable all", "Toggle all"]; readonly modeOn: number = LiteGraph.ALWAYS; readonly modeOff: number = LiteGraph.NEVER; private debouncerTempWidth: number = 0; tempSize: Vector2 | null = null; // We don't need to serizalize since we'll just be checking group data on startup anyway override serialize_widgets = false; protected helpActions = "mute and unmute"; static "@matchColors" = { type: "string" }; static "@matchTitle" = { type: "string" }; static "@showNav" = { type: "boolean" }; static "@sort" = { type: "combo", values: ["position", "alphanumeric", "custom alphabet"], }; static "@customSortAlphabet" = { type: "string" }; static "@toggleRestriction" = { type: "combo", values: ["default", "max one", "always one"], }; constructor(title = FastGroupsMuter.title) { super(title); this.properties[PROPERTY_MATCH_COLORS] = ""; this.properties[PROPERTY_MATCH_TITLE] = ""; this.properties[PROPERTY_SHOW_NAV] = true; this.properties[PROPERTY_SORT] = "position"; this.properties[PROPERTY_SORT_CUSTOM_ALPHA] = ""; this.properties[PROPERTY_RESTRICTION] = "default"; } override onConstructed(): boolean { this.addOutput("OPT_CONNECTION", "*"); return super.onConstructed(); } override configure(info: SerializedLGraphNode): void { // Patch a small issue (~14h) where multiple OPT_CONNECTIONS may have been created. // https://github.com/rgthree/rgthree-comfy/issues/206 // TODO: This can probably be removed within a few weeks. if (info.outputs?.length) { info.outputs.length = 1; } super.configure(info); } override onAdded(graph: TLGraph): void { FAST_GROUPS_SERVICE.addFastGroupNode(this); } override onRemoved(): void { FAST_GROUPS_SERVICE.removeFastGroupNode(this); } refreshWidgets() { const canvas = app.canvas as TLGraphCanvas; let sort = this.properties?.[PROPERTY_SORT] || "position"; let customAlphabet: string[] | null = null; if (sort === "custom alphabet") { const customAlphaStr = this.properties?.[PROPERTY_SORT_CUSTOM_ALPHA]?.replace(/\n/g, ""); if (customAlphaStr && customAlphaStr.trim()) { customAlphabet = customAlphaStr.includes(",") ? customAlphaStr.toLocaleLowerCase().split(",") : customAlphaStr.toLocaleLowerCase().trim().split(""); } if (!customAlphabet?.length) { sort = "alphanumeric"; customAlphabet = null; } } const groups = [...FAST_GROUPS_SERVICE.getGroups(sort)]; // The service will return pre-sorted groups for alphanumeric and position. If this node has a // custom sort, then we need to sort it manually. if (customAlphabet?.length) { groups.sort((a, b) => { let aIndex = -1; let bIndex = -1; // Loop and find indexes. As we're finding multiple, a single for loop is more efficient. for (const [index, alpha] of customAlphabet!.entries()) { aIndex = aIndex < 0 ? (a.title.toLocaleLowerCase().startsWith(alpha) ? index : -1) : aIndex; bIndex = bIndex < 0 ? (b.title.toLocaleLowerCase().startsWith(alpha) ? index : -1) : bIndex; if (aIndex > -1 && bIndex > -1) { break; } } // Now compare. if (aIndex > -1 && bIndex > -1) { const ret = aIndex - bIndex; if (ret === 0) { return a.title.localeCompare(b.title); } return ret; } else if (aIndex > -1) { return -1; } else if (bIndex > -1) { return 1; } return a.title.localeCompare(b.title); }); } // See if we're filtering by colors, and match against the built-in keywords and actuial hex // values. let filterColors = ( (this.properties?.[PROPERTY_MATCH_COLORS] as string)?.split(",") || [] ).filter((c) => c.trim()); if (filterColors.length) { filterColors = filterColors.map((color) => { color = color.trim().toLocaleLowerCase(); if (LGraphCanvas.node_colors[color]) { color = LGraphCanvas.node_colors[color]!.groupcolor; } color = color.replace("#", "").toLocaleLowerCase(); if (color.length === 3) { color = color.replace(/(.)(.)(.)/, "$1$1$2$2$3$3"); } return `#${color}`; }); } // Go over the groups let index = 0; for (const group of groups) { if (filterColors.length) { let groupColor = group.color.replace("#", "").trim().toLocaleLowerCase(); if (groupColor.length === 3) { groupColor = groupColor.replace(/(.)(.)(.)/, "$1$1$2$2$3$3"); } groupColor = `#${groupColor}`; if (!filterColors.includes(groupColor)) { continue; } } if (this.properties?.[PROPERTY_MATCH_TITLE]?.trim()) { try { if (!new RegExp(this.properties[PROPERTY_MATCH_TITLE], "i").exec(group.title)) { continue; } } catch (e) { console.error(e); continue; } } const widgetName = `Enable ${group.title}`; let widget = this.widgets.find((w) => w.name === widgetName); if (!widget) { // When we add a widget, litegraph is going to mess up the size, so we // store it so we can retrieve it in computeSize. Hacky.. this.tempSize = [...this.size]; widget = this.addCustomWidget>({ name: "RGTHREE_TOGGLE_AND_NAV", label: "", value: false, disabled: false, options: { on: "yes", off: "no" }, draw: function ( ctx: CanvasRenderingContext2D, node: LGraphNode, width: number, posY: number, height: number, ) { const widgetData = drawNodeWidget(ctx, { width, height, posY, }); const showNav = node.properties?.[PROPERTY_SHOW_NAV] !== false; // Render from right to left, since the text on left will take available space. // `currentX` markes the current x position moving backwards. let currentX = widgetData.width - widgetData.margin; // The nav arrow if (!widgetData.lowQuality && showNav) { currentX -= 7; // Arrow space margin const midY = widgetData.posY + widgetData.height * 0.5; ctx.fillStyle = ctx.strokeStyle = "#89A"; ctx.lineJoin = "round"; ctx.lineCap = "round"; const arrow = new Path2D(`M${currentX} ${midY} l -7 6 v -3 h -7 v -6 h 7 v -3 z`); ctx.fill(arrow); ctx.stroke(arrow); currentX -= 14; currentX -= 7; ctx.strokeStyle = widgetData.colorOutline; ctx.stroke(new Path2D(`M ${currentX} ${widgetData.posY} v ${widgetData.height}`)); } else if (widgetData.lowQuality && showNav) { currentX -= 28; } // The toggle itself. currentX -= 7; ctx.fillStyle = this.value ? "#89A" : "#333"; ctx.beginPath(); const toggleRadius = height * 0.36; ctx.arc(currentX - toggleRadius, posY + height * 0.5, toggleRadius, 0, Math.PI * 2); ctx.fill(); currentX -= toggleRadius * 2; if (!widgetData.lowQuality) { currentX -= 4; ctx.textAlign = "right"; ctx.fillStyle = this.value ? widgetData.colorText : widgetData.colorTextSecondary; const label = this.label || this.name; const toggleLabelOn = this.options.on || "true"; const toggleLabelOff = this.options.off || "false"; ctx.fillText( this.value ? toggleLabelOn : toggleLabelOff, currentX, posY + height * 0.7, ); currentX -= Math.max( ctx.measureText(toggleLabelOn).width, ctx.measureText(toggleLabelOff).width, ); currentX -= 7; ctx.textAlign = "left"; let maxLabelWidth = widgetData.width - widgetData.margin - 10 - (widgetData.width - currentX); if (label != null) { ctx.fillText(fitString(ctx, label, maxLabelWidth), widgetData.margin + 10, posY + height * 0.7); } } }, serializeValue(serializedNode: SerializedLGraphNode, widgetIndex: number) { return this.value; }, mouse(event: PointerEvent, pos: Vector2, node: LGraphNode) { if (event.type == "pointerdown") { if ( node.properties?.[PROPERTY_SHOW_NAV] !== false && pos[0] >= node.size[0] - 15 - 28 - 1 ) { const canvas = app.canvas as TLGraphCanvas; const lowQuality = (canvas.ds?.scale || 1) <= 0.5; if (!lowQuality) { // Clicked on right half with nav arrow, go to the group, center on group and set // zoom to see it all. canvas.centerOnNode(group); const zoomCurrent = canvas.ds?.scale || 1; const zoomX = canvas.canvas.width / group._size[0] - 0.02; const zoomY = canvas.canvas.height / group._size[1] - 0.02; canvas.setZoom(Math.min(zoomCurrent, zoomX, zoomY), [ canvas.canvas.width / 2, canvas.canvas.height / 2, ]); canvas.setDirty(true, true); } } else { this.value = !this.value; setTimeout(() => { this.callback?.(this.value, app.canvas, node, pos, event); }, 20); } } return true; }, }); (widget as any).doModeChange = (force?: boolean, skipOtherNodeCheck?: boolean) => { group.recomputeInsideNodes(); const hasAnyActiveNodes = group._nodes.some((n) => n.mode === LiteGraph.ALWAYS); let newValue = force != null ? force : !hasAnyActiveNodes; if (skipOtherNodeCheck !== true) { if (newValue && this.properties?.[PROPERTY_RESTRICTION]?.includes(" one")) { for (const widget of this.widgets) { (widget as any).doModeChange(false, true); } } else if (!newValue && this.properties?.[PROPERTY_RESTRICTION] === "always one") { newValue = this.widgets.every((w) => !w.value || w === widget); } } for (const node of group._nodes) { node.mode = (newValue ? this.modeOn : this.modeOff) as 1 | 2 | 3 | 4; } (group as any)._rgthreeHasAnyActiveNode = newValue; widget!.value = newValue; app.graph.setDirtyCanvas(true, false); }; widget.callback = () => { (widget as any).doModeChange(); }; this.setSize(this.computeSize()); } if (widget.name != widgetName) { widget.name = widgetName; this.setDirtyCanvas(true, false); } if (widget.value != (group as any)._rgthreeHasAnyActiveNode) { widget.value = (group as any)._rgthreeHasAnyActiveNode; this.setDirtyCanvas(true, false); } if (this.widgets[index] !== widget) { const oldIndex = this.widgets.findIndex((w) => w === widget); this.widgets.splice(index, 0, this.widgets.splice(oldIndex, 1)[0]!); this.setDirtyCanvas(true, false); } index++; } // Everything should now be in order, so let's remove all remaining widgets. while ((this.widgets || [])[index]) { this.removeWidget(index++); } } override computeSize(out?: Vector2) { let size = super.computeSize(out); if (this.tempSize) { size[0] = Math.max(this.tempSize[0], size[0]); size[1] = Math.max(this.tempSize[1], size[1]); // We sometimes get repeated calls to compute size, so debounce before clearing. this.debouncerTempWidth && clearTimeout(this.debouncerTempWidth); this.debouncerTempWidth = setTimeout(() => { this.tempSize = null; }, 32); } setTimeout(() => { app.graph.setDirtyCanvas(true, true); }, 16); return size; } override async handleAction(action: string) { if (action === "Mute all" || action === "Bypass all") { const alwaysOne = this.properties?.[PROPERTY_RESTRICTION] === "always one"; for (const [index, widget] of this.widgets.entries()) { (widget as any)?.doModeChange(alwaysOne && !index ? true : false, true); } } else if (action === "Enable all") { const onlyOne = this.properties?.[PROPERTY_RESTRICTION].includes(" one"); for (const [index, widget] of this.widgets.entries()) { (widget as any)?.doModeChange(onlyOne && index > 0 ? false : true, true); } } else if (action === "Toggle all") { const onlyOne = this.properties?.[PROPERTY_RESTRICTION].includes(" one"); let foundOne = false; for (const [index, widget] of this.widgets.entries()) { // If you have only one, then we'll stop at the first. let newValue: boolean = onlyOne && foundOne ? false : !widget.value; foundOne = foundOne || newValue; (widget as any)?.doModeChange(newValue, true); } // And if you have always one, then we'll flip the last if (!foundOne && this.properties?.[PROPERTY_RESTRICTION] === "always one") { (this.widgets[this.widgets.length - 1] as any)?.doModeChange(true, true); } } } override getHelp() { return `

The ${this.type!.replace( "(rgthree)", "", )} is an input-less node that automatically collects all groups in your current workflow and allows you to quickly ${this.helpActions} all nodes within the group.

  • Properties. You can change the following properties (by right-clicking on the node, and select "Properties" or "Properties Panel" from the menu):

    • ${PROPERTY_MATCH_COLORS} - Only add groups that match the provided colors. Can be ComfyUI colors (red, pale_blue) or hex codes (#a4d399). Multiple can be added, comma delimited.

    • ${PROPERTY_MATCH_TITLE} - Filter the list of toggles by title match (string match, or regular expression).

    • ${PROPERTY_SHOW_NAV} - Add / remove a quick navigation arrow to take you to the group. (default: true)

    • ${PROPERTY_SORT} - Sort the toggles' order by "alphanumeric", graph "position", or "custom alphabet". (default: "position")

    • ${PROPERTY_SORT_CUSTOM_ALPHA} - When the ${PROPERTY_SORT} property is "custom alphabet" you can define the alphabet to use here, which will match the beginning of each group name and sort against it. If group titles do not match any custom alphabet entry, then they will be put after groups that do, ordered alphanumerically.

      This can be a list of single characters, like "zyxw..." or comma delimited strings for more control, like "sdxl,pro,sd,n,p".

      Note, when two group title match the same custom alphabet entry, the normal alphanumeric alphabet breaks the tie. For instance, a custom alphabet of "e,s,d" will order groups names like "SDXL, SEGS, Detailer" eventhough the custom alphabet has an "e" before "d" (where one may expect "SE" to be before "SD").

      To have "SEGS" appear before "SDXL" you can use longer strings. For instance, the custom alphabet value of "se,s,f" would work here.

    • ${PROPERTY_RESTRICTION} - Optionally, attempt to restrict the number of widgets that can be enabled to a maximum of one, or always one.

      Note: If using "max one" or "always one" then this is only enforced when clicking a toggle on this node; if nodes within groups are changed outside of the initial toggle click, then these restriction will not be enforced, and could result in a state where more than one toggle is enabled. This could also happen if nodes are overlapped with multiple groups.

`; } static override setUp(clazz: RgthreeBaseVirtualNodeConstructor) { LiteGraph.registerNodeType(clazz.type, clazz); clazz.category = clazz._category; } } /** * Fast Bypasser implementation that looks for groups in the workflow and adds toggles to mute them. */ export class FastGroupsMuter extends BaseFastGroupsModeChanger { static override type = NodeTypesString.FAST_GROUPS_MUTER; static override title = NodeTypesString.FAST_GROUPS_MUTER; override comfyClass = NodeTypesString.FAST_GROUPS_MUTER; static override exposedActions = ["Bypass all", "Enable all", "Toggle all"]; protected override helpActions = "mute and unmute"; override readonly modeOn: number = LiteGraph.ALWAYS; override readonly modeOff: number = LiteGraph.NEVER; constructor(title = FastGroupsMuter.title) { super(title); this.onConstructed(); } static override setUp(clazz: RgthreeBaseVirtualNodeConstructor) { LiteGraph.registerNodeType(clazz.type, clazz); clazz.category = clazz._category; } } app.registerExtension({ name: "rgthree.FastGroupsMuter", registerCustomNodes() { FastGroupsMuter.setUp(FastGroupsMuter); }, loadedGraphNode(node: LGraphNode) { if (node.type == FastGroupsMuter.title) { (node as FastGroupsMuter).tempSize = [...node.size]; } }, });