ComfyUI Node: H3 Drawn Plan (alpha)

H3 Drawn Plan (alpha):

The H3DrawnPlan node is designed to transform a drawn plan document into hold-map ranges, which are essential for driving the H3 Manual Hold Map. This node acts as a thin loader, parsing the plan and delegating the compilation to the H3 backend, ensuring that the output ranges are consistent with the compiler's results. The primary benefit of using this node is its ability to seamlessly integrate a plan document into the workflow without requiring manual re-entry of frame numbers. By exporting a plan from a web editor and pointing this node to the file, the drawing is automatically incorporated into the graph. This node is particularly useful for artists who want to maintain the integrity of their timeline without manually adjusting frame numbers, as it ensures that the ranges are accurately compiled and ready for further processing.

H3 Drawn Plan (alpha) Input Parameters:

plan_path

The plan_path parameter specifies the file path to the plan document that you want to load. This parameter is crucial as it directs the node to the correct file containing the timeline surface's JSON data. The plan document outlines what the shot should do in terms of seconds and densities. There is no explicit minimum or maximum value for this parameter, but it must be a valid file path. If both plan_path and plan_json are provided, plan_json takes precedence.

plan_json

The plan_json parameter allows you to input the plan document as a JSON string directly. This is particularly useful if you have the plan data available in a text format, such as from a chat or another source, and do not want to save it as a file. This parameter overrides plan_path if both are provided. It should be a valid JSON string representing the plan document.

ignore_uncompiled_lanes

The ignore_uncompiled_lanes parameter is a boolean that determines whether to ignore lanes in the plan that cannot be compiled. By default, this is set to False, meaning that any uncompiled lanes will result in an error. Setting this to True allows the node to proceed with compiling the rest of the plan, skipping over any problematic lanes.

port

The port parameter specifies the port number used for communication with the H3 backend. The default value is 8188. This parameter is generally used for advanced configurations and is not typically adjusted by most users.

recorder_path

The recorder_path parameter provides the file path to a recorder file, if applicable. This is used to store additional context or metadata related to the plan. If the file exists, it will be used; otherwise, this parameter can be left empty.

H3 Drawn Plan (alpha) Output Parameters:

ranges

The ranges output parameter provides the hold-map ranges derived from the compiled plan. These ranges are crucial for driving the H3 Manual Hold Map and are expressed in a format that aligns with the world clock. This output ensures that the timeline is accurately represented and can be further processed or edited as needed.

hold_map

The hold_map output parameter is a JSON string representing the compiler's map verbatim. This map is intended for direct wiring into the H3 Temporal Insert, ensuring that the hold-map is accurately reproduced without additional reshaping.

splice_map

The splice_map output parameter is a JSON string that drives the H3 Segment Splice. It specifies the window's placement within the clip, ensuring that the recovered window is accurately reintegrated into the untouched clip.

H3 Drawn Plan (alpha) Usage Tips:

• Ensure that your plan document is correctly formatted and contains all necessary information before loading it into the node. This will help prevent errors and ensure accurate compilation.
• Use the plan_json parameter to quickly test or integrate plans from text sources without needing to save them as files. This can streamline your workflow and make it easier to iterate on plan designs.
• If you encounter issues with uncompiled lanes, consider setting ignore_uncompiled_lanes to True to bypass these problems and focus on the parts of the plan that can be compiled.

H3 Drawn Plan (alpha) Common Errors and Solutions:

ValueError: H3 Drawn Plan: <specific error message>

• Explanation: This error occurs when there is an issue with the plan document, such as malformed JSON or missing required fields.
• Solution: Check the plan document for syntax errors or missing information. Ensure that the JSON is correctly formatted and contains all necessary fields.

ValueError: H3 Plan Estimate: <specific error message>

• Explanation: This error indicates a problem with estimating the plan, possibly due to incorrect settings or an incompatible plan structure.
• Solution: Review the plan settings and ensure they are compatible with the H3 backend. Adjust any parameters that may be causing conflicts.

ValueError: cannot be compiled

• Explanation: This error suggests that the plan contains elements that the backend cannot compile, such as unsupported lanes or configurations.
• Solution: Simplify the plan by removing or modifying unsupported elements. Consider using the ignore_uncompiled_lanes option to bypass problematic lanes.