OpenKatana · Render scene3d:
OpenKatana_render_scene3d gives you access to OpenKatana’s 3D scene-rendering tool from a ComfyUI workflow, helping you turn a prepared scene into rendered visual material. The underlying rendering function supports still-frame selection, video rendering, and restricting rendering to a chosen frame range, making it useful for both quick previews and longer animation jobs. The supplied scene-validation code also checks settings such as post-processing effects, motion blur, and camera-path compatibility before accepting a scene. This helps you catch unsupported combinations early instead of troubleshooting unexpected visual results later. The node acts as a bridge to the OpenKatana tool rather than as an interactive scene editor: you prepare the scene and rendering request, then let the tool perform the rendering operation.
OpenKatana · Render scene3d Input Parameters:
project_id
A required STRING that identifies the OpenKatana project associated with your request. The node passes this value to the argument-preparation helper together with the rendering-tool identifier and your argument text, so you should use the identifier for the project you intend to work with. It is not an image, scene file, or render-quality control. The supplied interface does not show how projects are created, how identifiers are validated, or whether project identifiers follow a particular naming format. No default value, length limits, or list of allowed values is provided.
arguments
A required STRING containing the arguments to be prepared for the rendering-tool call. This is the node’s general-purpose channel for supplying the rendering request; the node does not expose separate sockets for scene paths, output destinations, frame selections, or other render settings. The underlying Python function accepts a scene path, an output destination, optional frame samples, a video switch, frame-range boundaries, and a trusted-script switch, but the provided context does not establish the exact argument names or text format accepted by this tool wrapper. Use the registered tool’s documented argument format rather than assuming that Python parameter names or command-line flags can be pasted directly into this field. The interface specifies no default text, minimum or maximum length, or selectable options.
after
An optional STRING accepted by the node’s execution method, with a Python default of None when omitted. In the supplied implementation, this value is not referenced inside the execution body and is not explicitly forwarded to the argument-preparation or tool-invocation calls. Consequently, the shown code does not establish any effect on rendering settings, returned content, or execution sequencing. Do not treat it as a frame offset, output location, or render option. No permitted string format, length limits, or selectable values are provided.
OpenKatana · Render scene3d Output Parameters:
result_json
A STRING containing the response produced by the node’s response helper after it invokes the OpenKatana rendering tool. This is the node’s only output, so it provides a text-based response rather than a directly connectable ComfyUI image, video, or mesh. You can inspect it to understand what the tool returned and, where the actual response includes them, obtain render details or artifact references. The supplied code does not show the response helper’s implementation or the rendering result’s exact structure, so specific JSON keys, file paths, success indicators, and error fields cannot be guaranteed. Inspect the actual response before configuring downstream JSON processing or file-loading steps.
OpenKatana · Render scene3d Usage Tips:
- Confirm your project identifier and the registered rendering tool’s argument format before starting a long render. The node exposes only text inputs, so an incorrectly structured request cannot be corrected through separate render-setting sockets.
- For an initial preview, use the tool’s documented mechanism for requesting selected frames or a short frame range, if exposed. The underlying renderer supports these operations, allowing you to check framing and scene appearance before committing to a full animation.
- Do not interpret the underlying renderer’s
samplesparameter as a render-quality sample count: the command-line integration passes a list of still-frame numbers to that parameter. Motion-blur sampling is a separate scene setting. - In the scene definition,
motion_blur.samplesmust be an integer from 1 to 32 and defaults to 1;motion_blur.shutterranges from 0 to 1 and defaults to 0.5. Start with a low sample count for previews, then test higher counts if your final shot needs more motion-blur sampling. - Keep scene post-processing settings within the validated ranges:
post.bloomfrom 0 to 5,post.focusfrom 0 to 10000, andpost.apertureandpost.max_blurfrom 0 to 0.1. These are settings inside the scene definition, not additional node inputs. - When you need transparent output, disable post effects. The validator rejects transparency when any value in the scene’s
postsettings is truthy; removing the post settings or setting the supported numeric effects to zero avoids that conflict. - When using a scene
camera_path, choose a perspective camera and remove animation tracks that also target the camera. The path must be the sole camera controller under the supplied validation rules. - Connect
result_jsonto a text viewer or another suitable inspection step first. Once you know the actual response structure, you can configure downstream processing without relying on unverified field names.
OpenKatana · Render scene3d Common Errors and Solutions:
Transparent output currently requires post effects disabled
- Explanation: The scene requests transparent output while at least one post-processing value is enabled or nonzero. The validator explicitly rejects this combination.
- Solution: Remove the scene’s post-processing settings or set the supported effects to zero. If those effects are essential, disable transparent output instead.
camera_path currently requires a perspective camera
- Explanation: The scene defines a camera path while its camera type is orthographic. This combination is explicitly rejected by the validator.
- Solution: Change the scene camera to perspective, or remove the camera path if you need to keep the orthographic view.
camera_path owns the camera; remove conflicting camera tracks
- Explanation: The scene includes both a camera path and at least one animation track whose target is
camera. These create competing camera controls. - Solution: Remove camera-targeted animation tracks when using a camera path. Alternatively, remove the camera path and use the camera tracks for animation.
unexpected inputs: …
- Explanation: The node raises a
TypeErrorwhen extra named fields are supplied that are not present in its registered typed inputs. This is most relevant when calling the node programmatically or modifying workflow definitions. - Solution: Use only the exposed inputs:
project_id,arguments, and optionallyafter. Put supported rendering options into the documented argument payload rather than inventing new node inputs.
Scene validation error involving motion_blur.samples or motion_blur.shutter
- Explanation: The validator checks motion-blur sample counts and shutter values before accepting the scene. A sample count outside 1–32, a non-integer sample count, or a shutter value outside 0–1 violates the shown requirements. The exact error message from the numeric-validation helper is not provided.
- Solution: Set
motion_blur.samplesto an integer between 1 and 32 andmotion_blur.shutterto a number between 0 and 1. If you do not need custom settings, omit these fields to use the validator’s defaults of 1 and 0.5.
Scene validation error involving post-processing values
- Explanation: The scene’s post-processing values are checked against numerical limits. Negative values, values above the supported limits, or incompatible value types can fail validation. The exact helper-generated error wording is not shown.
- Solution: Use numeric values within the documented ranges: bloom 0–5, focus 0–10000, aperture 0–0.1, and max_blur 0–0.1. Check that these settings are stored in the scene’s
postsection rather than added as node inputs.
Scene validation error involving unsupported post or motion_blur fields
- Explanation: The supplied validator checks the structure of these scene sections against named fields:
bloom,focus,aperture, andmax_blurfor post-processing, andsamplesandshutterfor motion blur. The object-validation helper’s exact error wording is not provided. - Solution: Check the section names and field spelling against the supported scene format. Remove unrelated settings from these sections and place other options only where the tool’s scene documentation supports them.
