scene_overview
List what the scene holds. Start here, before you touch a node.
Instructions
List what the scene holds. Start here, before you touch a node.
Modes: scene, network, children, search, node_types, errors, materials, lights, takes, caches, render_nodes, viewports, changes.
Use it to find a node path, to see the shape of a network, or to learn
which node types this Houdini has.
Do not use it to read one node in detail: node_inspect does that. Do not
use it to read geometry: geometry_inspect does that.
mode:
"scene" — file, frame range, counts, and the top of the tree.
"network" — the children of one network by name, with their
wires, flags and dots. Each input names the dot it
comes through, then the node behind the dot.
`pattern` and `node_type` keep some nodes;
compact=True gives only the wires.
"children" — the children of `path`. recursive=True walks down.
"search" — nodes whose name matches `pattern`, under `path`.
node_type filters by type name.
"node_types" — the node types this Houdini has, for one `category`
such as "Sop", "Object", "Lop", "Driver". `pattern`
keeps the names or labels that match.
"errors" — every node under `path` that has a cook error.
"materials" — the materials in `path` (default /mat) and the types.
"lights" — the lights on the USD stage of the LOP node `path`.
"takes" — the takes, and which take is current.
"caches" — file caches under `path` and their state on disk.
"render_nodes" — the ROP nodes in /out.
"viewports" — the panes, and what the scene viewer shows.
"changes" — what the user changed in the network `path` since
your last call: nodes added, deleted, renamed or
moved, wires, flags and parameter values. Your own
changes are not listed. The first call starts to
watch the network; call it at the start of each
turn, before you change anything there.
Returns JSON. A path that does not exist comes back as an error, not as an
empty list.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "scene_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | One of "scene", "network", "children", "search", "node_types", "errors", "materials", "lights", "takes", "caches", "render_nodes", "viewports", "changes". | scene |
| path | No | A node path such as "/obj" or "/obj/geo1": the network to list or to search. | |
| compact | No | network: return only the wires, one line each. | |
| pattern | No | search: the name to match, with * and ? as wildcards. network, node_types: keep the names that match; "|" separates alternatives, for example "*retarget*|*ik*". | |
| category | No | node_types: the context, for example "Sop", "Object", "Lop" or "Driver". | |
| node_type | No | search, network: keep the nodes of this type, for example "null". | |
| recursive | No | children: also list the children of the children. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |