π§ API Reference Guideο
Welcome to the low-level API reference for ManipulaPy.
This section contains auto-generated documentation for all key modules, classes, and functions in the library, based on the actual Python source code using Sphinx autodoc.
Note
This section is not a tutorial β itβs for precise function/class definitions.
For interactive examples and walkthroughs, see The Python Tutorial.
For explanations, workflows, and configuration, see the User Guide.
π¦ Module Overviewο
π© Core Manipulator Stack
Core Modules
π§ Planning, Simulation & Optimization
Planning & Simulation
- Simulation API Reference
- Quick Navigation
- Simulation Class
- Simulation Management
- Robot Control and State
- Interactive Controls
- Visualization and Analysis
- Safety and Monitoring
- Main Execution
- Logging and Utilities
- Usage Examples
- Configuration Options
- Performance Considerations
- Error Handling
- Integration with Other Modules
- See Also
- External References
- Potential Field API Reference
- Quick Navigation
- PotentialField Class
- Potential Field Computations
- CollisionChecker Class
- Collision Detection Methods
- Data Structures and Internal Representation
- Computational Complexity Analysis
- Numerical Implementation Details
- Error Handling and Edge Cases
- Memory Management
- See Also
- External Dependencies
- CUDA Kernels API Reference
ποΈ Perception & Vision
Perception Modules
π§ͺ Advanced Analysis
π How to Use This Referenceο
Module headers show the import path: e.g.,
ManipulaPy.control.ManipulatorControllerFunction signatures are exact and include optional/default parameters
Class attributes and properties are listed, with docstrings if provided
NumPy/CuPy compatibility is noted where applicable
Examples may be included for select methods/classes