OpenKatana · Check scene3d:
OpenKatana_check_scene3d checks an OpenKatana 3D scene for structural and asset-related problems before you render it. It serves as a preparation step for the scene3d workflow, helping you catch issues such as unsupported object types, properties placed on the wrong kind of object, incorrectly written visibility settings, or problems with referenced models and materials. The provided validation code distinguishes between mesh objects, groups, and imported models, applies different property rules to each, checks mesh geometry, and inspects referenced models. This makes the node useful for checking scenes you have created or edited before spending time rendering previews or animation frames. Treat it as a scene validation step rather than a visual review: a scene that passes these checks can still need adjustments to its composition, lighting, camera placement, or animation.
OpenKatana · Check scene3d Input Parameters:
project_id
A required STRING identifying the OpenKatana project in which the check should run. Use the same project identifier used when creating the project and preparing its scene, so the tool operates in the intended project context. The supplied integration test creates a project with the identifier proof and then uses that identifier when checking its scene. This is particularly important when your scene references project assets, because validation resolves referenced assets against a root location. The provided node interface does not specify a default value, a list of allowed identifiers, or minimum and maximum string lengths.
arguments
A required STRING containing the tool arguments as JSON text. For this node, the supplied integration test demonstrates that the underlying check_scene3d tool is called with a scene argument, alongside the project identifier. Supply that scene argument through this field; scene is not a separate input socket on this node. Reuse the scene reference or value returned by your scene-creation step rather than guessing its representation, because the provided excerpts do not establish whether every supported scene value must be a path or an embedded scene definition. The wrapper prepares these arguments and passes them to the underlying tool. The provided interface does not show a default JSON value, a complete argument schema, string-length limits, or selectable options.
after
An optional STRING that you can use as a workflow connection when arranging operations in sequence. The execution method accepts this parameter with a default of None, but the shown method does not read it or forward it to the tool arguments. Consequently, it is not a scene-checking option and should not be used to supply a scene, asset location, or validation setting. Connecting an upstream result can establish a graph dependency when you need a preceding operation to finish first, but the provided code does not show any interpretation of the string’s contents. No minimum, maximum, selectable options, or interface-level default string is provided.
OpenKatana · Check scene3d Output Parameters:
result_json
A STRING containing the response produced by the OpenKatana tool call through the node’s response-conversion helper. Use it to review the returned check information and to carry the operation’s response into later workflow steps when appropriate. This output is a textual tool response, not rendered frames, a model, or an image preview. The provided excerpts do not expose the response helper’s implementation or the exact successful-check payload, so no particular JSON keys, success flag, warning list, or error-report structure can be guaranteed. Inspect the actual response rather than assuming it contains a specific field; failures may also interrupt execution instead of appearing as a normal output value.
OpenKatana · Check scene3d Usage Tips:
- Place the check after creating or modifying your scene and before rendering it. The supplied integration test follows this order: create the scene, check it, and then render preview frames or the complete clip.
- Keep
project_idconsistent across your project-creation, scene-creation, validation, and rendering steps. For example, if your project was created asproof, useproofthroughout that sequence. - In
arguments, provide valid JSON containing thesceneargument expected by the tool. Use the scene value returned by your preceding scene-creation operation, preserving its representation rather than manually inventing a path or rebuilding the scene unnecessarily. - Match each object’s properties to its type. Groups accept organizational properties such as parent, position, rotation, scale, and visibility; meshes use geometry; imported models use a model reference and may include animation or morph-weight settings. Moving properties between these object types without adjusting the scene can cause validation failures.
- Write visibility and shadow switches as JSON booleans:
trueorfalse, without quotation marks. Values such as"true",1, or0do not satisfy the explicit boolean checks shown in the validator. - Recheck after changing geometry, materials, imported-model references, or object types. These are explicitly involved in the supplied validation code, so an earlier successful check does not establish that your edited scene is still valid.
- Follow a successful check with a small render preview to assess appearance. The integration example requests preview frames 0 and 2 through the rendering tool; preview selection belongs to the rendering step, not to this node.
OpenKatana · Check scene3d Common Errors and Solutions:
Object type must be mesh, model or group
- Explanation: An object has a type other than the three values accepted by the supplied validator. For example, a descriptive label such as
characteris not a supported object type. - Solution: Set the object type to
mesh,model, orgroupas appropriate. Usemeshfor geometry defined in the scene,modelfor a referenced model asset, andgroupfor an organizational object.
visible must be boolean
- Explanation: An object’s
visiblevalue is not a true boolean. Quoted text such as"false"and numeric substitutes are rejected by the explicit type check. - Solution: Set
visibleto the unquoted JSON valuetrueorfalse, or remove the property if you intend to rely on the scene system’s default behavior.
cast_shadow must be boolean
- Explanation: The
cast_shadowproperty contains text, a number, or another value instead of a boolean. - Solution: Use
trueto enable shadow casting orfalseto disable it. Keep this property on an object type that supports it; the shown group-property rules do not include shadow settings.
receive_shadow must be boolean
- Explanation: The
receive_shadowproperty is present but is not a boolean value. - Solution: Replace the value with unquoted
trueorfalse. If the object is a group, remove this property and apply supported shadow settings to its mesh or model objects instead.
unexpected inputs: ...
- Explanation: The node’s execution method explicitly raises this error when additional field names fall outside its recognized typed inputs. This can occur in programmatic calls that attempt to pass undeclared fields as node inputs.
- Solution: Use only the exposed inputs:
project_id,arguments, and optionallyafter. Put the underlying tool’s scene argument inside the JSON text supplied toargumentsrather than adding a new node input.
Invalid JSON in arguments — exact message may vary
- Explanation: The arguments field is intended to carry JSON text. Missing quotation marks, trailing commas, or incorrectly escaped path characters can prevent the tool arguments from being prepared. The supplied excerpts do not show the exact parsing error message.
- Solution: Check the text with a JSON validator. Use double quotes for property names and string values, avoid trailing commas, and preserve the scene value’s original structure when transferring it from an earlier operation.
Unsupported property for an object type — exact message may vary
- Explanation: The validator applies different allowed-property lists to groups, meshes, and models. A property can be valid for one kind of object but invalid for another, such as placing
geometryon a group or model. - Solution: Review the object’s type and remove incompatible properties. Put geometry on mesh objects, model references and model-animation settings on model objects, and keep groups limited to their organizational and transform properties.
Referenced model cannot be resolved or inspected — exact message may vary
- Explanation: For a model object, the supplied validator resolves the
modelreference against the asset root and then inspects the asset. A missing, inaccessible, or unsuitable asset can therefore cause the check to fail; the exact error messages are not included in the excerpts. - Solution: Confirm that the referenced model exists, that the scene uses the intended project context, and that the reference points to the correct asset. Use the separate model-inspection tool to investigate the asset before checking the scene again.
Geometry or material validation failed — exact message may vary
- Explanation: The supplied code validates mesh geometry and any supplied material definitions. An incomplete or incompatible definition may fail even when the object type and visibility settings are correct. The full geometry and material rules are not included in the provided context.
- Solution: Compare the affected definition with a working scene produced by OpenKatana’s scene-creation tools. Restore a known-working geometry or material definition, then reapply your changes incrementally and run the check after each change.
