Project description
ThreeDWorld (TDW)
A Platform for Interactive Multi-Modal Physical Simulation
ThreeDWorld (TDW) is a platform for interactive multi-modal physical simulation. With TDW, users can simulate high-fidelity sensory data and physical interactions between mobile agents and objects in a wide variety of rich 3D environments.
API
Commands and Output Data
Document |
Description |
Command API |
API for every command a controller can send to the build. |
Command API Guide |
Overview of how to send commands to the build. |
Output Data |
API for all output data a controller can receive from the build. |
Python tdw
module
Frontend
Document |
Description |
tdw module |
Overview of the Python tdw module. |
Controller |
Base class for all controllers. |
TDWUtils |
Utility class. |
AssetBundleCreator |
Covert 3D models into TDW-compatible asset bundles. |
PyImpact |
Generate impact sounds at runtime. |
DebugController |
Child class of Controller that has useful debug features. |
Librarian |
"Librarians" hold asset bundle metadata records. |
BinaryManager |
Manage multiple instances of TDW builds on a remote server. |
FluidTypes |
Access different NVIDIA Flex fluid types. |
Backend
Document |
Description |
Build |
Helper functions for downloading the build. |
PyPi |
Helper functions for checking the version of the tdw module on PyPi. |
Audio and Video
Avatars (Agents)
Benchmarks and Speed
Examples
Document |
Description |
Example Controllers |
Index of all example controllers in the repo. |
Use Cases (see below) |
The "use cases" section showcases "advanced" usage of TDW. |
Misc.
Document |
Description |
VR |
VR in TDW. |
Humanoids |
Add "humanoids" and play animations. |
Releases |
Release versioning in TDW. |
Physics (PhysX and Flex)
Document |
Description |
Physics |
Common physics problems and solutions. |
NVIDIA Flex |
Add soft bodies, cloth, and fluids to TDW. |
FluidTypes |
Access different NVIDIA Flex fluid types. |
Remote Server
Rendering and Photorealism
Document |
Description |
Asset Bundle Librarians |
Overview of what asset bundles are, how to add objects, scenes, materials, HDRI skyboxes, and humanoids, and how to access each asset bundle's metadata. |
Model Screenshotter |
Generate images of every model in TDW. |
Material Screenshotter |
Generate images of every material in TDW. |
Materials, textures, and colors |
Defines materials, textures, and colors. |
Depth of Field |
Prevent blurry images and increase realism. |
Remote rendering |
How to render using xpra. |
Observation Data |
Different means of determining what an agent is observing. |
Scene Setup
Document |
Description |
Scene Setup |
Overview of how to set up a scene. |
Asset Bundle Librarians |
Overview of what asset bundles are, how to add objects, scenes, materials, HDRI skyboxes, and humanoids, and how to access each asset bundle's metadata. |
Model Librarian |
Overview of how to add objects and access metadata. |
Rotation |
Different means of rotating objects and agents in a scene. |
Scene Reset |
How to reset a scene. |
TDW and 3D Objects
Troubleshooting TDW
Use Cases
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution