Feature Map
Use this page when you know what you want to build, but not which RaiSim API or documentation page owns it. For runnable programs, start with Examples. For build, test, benchmark, and documentation commands, use Build, Test, and Benchmark.
World and bodies
Goal |
Main API |
Documentation |
|---|---|---|
Create and step a simulation |
|
|
Add primitive rigid bodies |
|
|
Add a robot from URDF or MJCF |
|
|
Add mesh collision geometry |
|
|
Add terrain |
|
|
Add deformable cloth or meshes |
|
|
Add granular particles |
|
|
Add wires, pins, or custom constraints |
|
Contacts, collision, and materials
Goal |
Main API |
Documentation |
|---|---|---|
Inspect contacts after a step |
|
|
Configure contact material behavior |
|
|
Change collision filtering or contact settings |
object collision and contact-setting APIs |
|
Work with object state and appearance |
|
Sensors and ray queries
Goal |
Main API |
Documentation |
|---|---|---|
Cast a single CPU ray |
|
|
Simulate lidar rays |
|
|
Render RGB or depth sensor images |
|
|
Capture depth without rayrai |
|
|
Read inertial measurements |
|
Visualization and tools
Goal |
Main API or target |
Documentation |
|---|---|---|
View a |
|
|
Render in process |
|
|
Inspect PBR, glTF, HDR, and OpenUSD assets |
|
|
Exercise sensor and rayrai rendering examples |
|
|
Tune simulation performance |
timing examples, collision settings, sleeping islands, solver settings |
Build and repository workflow
Goal |
Documentation |
|---|---|
Build the source tree |
|
Run C++ tests, benchmarks, and docs builds |
|
Find generated executables or source directories |
|
Diagnose missing targets, libraries, activation keys, viewer connections, or documentation warnings |