Skip to content

dops

dops

MCP tool definitions for DOP (dynamics/simulation) operations.

Functions:

Name Description
get_dop_field

Read a specific field value from a DOP record.
get_dop_object

Get detailed data for a specific DOP object.
get_dop_relationships

List all relationships between DOP objects.
get_sim_memory_usage

Get detailed memory breakdown for the simulation.
get_simulation_info

Get DOP network simulation state, cooked at the current frame.
list_dop_objects

List all DOP objects in a simulation.
reset_simulation

Reset the simulation to its initial state.
step_simulation

Advance the simulation by a number of frames.

Functions:

get_dop_field async 

get_dop_field(
    ctx: Context,
    node_path: str,
    object_name: str,
    data_path: str,
    field_name: str,
) -> dict

Read a specific field value from a DOP record.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required
object_name
str

DOP object name.

 required
data_path
str

Dot-separated subdata path (e.g. "Geometry", "Forces/Gravity").

 required
field_name
str

Field name to read.

 required

get_dop_object async 

get_dop_object(ctx: Context, node_path: str, object_name: str) -> dict

Get detailed data for a specific DOP object.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required
object_name
str

DOP object name.

 required

get_dop_relationships async 

get_dop_relationships(ctx: Context, node_path: str) -> dict

List all relationships between DOP objects.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required

get_sim_memory_usage async 

get_sim_memory_usage(ctx: Context, node_path: str) -> dict

Get detailed memory breakdown for the simulation.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required

get_simulation_info async 

get_simulation_info(ctx: Context, node_path: str) -> dict

Get DOP network simulation state, cooked at the current frame.

simulation_frame is the frame the simulation actually holds. Going back to a frame the memory cache no longer keeps, Houdini gives the frame it kept instead of simulating again; note then says so, and what the nodes reading the network get: that frame's state, or no geometry when the simulation holds no objects. Check this before measuring or rendering a frame reached backwards. A scene ahead of the simulation is simulated up to its frame first, under Houdini's interrupt dialog and with no deadline: wait for the reply. Stopped there, it says so (interrupted) with the frame reached.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required

list_dop_objects async 

list_dop_objects(ctx: Context, node_path: str) -> dict

List all DOP objects in a simulation.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required

reset_simulation async 

reset_simulation(ctx: Context, node_path: str) -> dict

Reset the simulation to its initial state.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required

step_simulation async 

step_simulation(ctx: Context, node_path: str, steps: int = 1) -> dict

Advance the simulation by a number of frames.

Parameters:

Name Type Description Default
node_path
str

DOP network node path.

 required
steps
int

Number of frames to advance.

 1