Skip to main content

Python API Overview

What this reference covers​

The rpts module gives Python scripts access to RapidPipeline Studio. It covers the loaded asset and its scene tree (selection, visibility, deletion and renaming of nodes), processing actions, reimporting the asset, offscreen rendering, and the material library.

Scene objects such as Asset, Node, Mesh and Material belong to the separate rpd module. They are documented on the objects page.

How the module is reached​

  • External Python: import rpts.
  • RPTS Python console: the globals rpts, rpd and get_asset() are available directly, without an import.

Conventions​

  • Node paths are /-separated strings that identify a node's position in the scene tree, for example group/part_003.
  • Most functions that take nodes accept a path string (str), an rpd.Node object, or an iterable of either. Where a function accepts only a list of path strings, the function's page says so.

Sub-areas​

  • Top-level functions: getting and setting the selection, visibility, deletion and cleanup, processing actions, and reimport.
  • Materials: the rpts.materials functions for the material library and per-mesh assignments.
  • Rendering: the rpts.render functions for offscreen images and turntables.
  • Utilities: the rpts.utils helper functions. These have no docstrings yet.
  • Objects: the rpd classes and enums used by the functions above.
Intentionally not listed

The following names exist in the module but are not part of the public API, so they are not documented in this reference: rpts.unwrap, rpts.process, rpts.add_from_library, rpts.get_model, rpts.set_global_instance, and rpts.process_asset.