Welcome to the Karamba3D API Documentation
This is the API Reference to Karamba3D 3.1.4. which is available at https://www.karamba3d.com/.
Getting Started
There are two main namespaces:
-
[Karamba]: Is used by the Grasshopper-components and provides access to the full range of features. However in the interfaces of the classes there may change in the future.
-
[KarambaCommmon]: Use the class provided in this namespace to create Karamba3D-objects. The interfaces of these classes may change in the future.
The class [KarambaCommon.Toolkit] should be used to create Karamba3D models and their constituents. It gives access to factories for many model-parts. However the interface of Toolkit does not provide access to all features yet. For examples regarding the use of Toolkit take a look at the Karamba3D unit-test project available at https://github.com/karamba3d/K3D_tests.
For further information regarding scripting with Karamba3D see the Karamba3D scripting guide and the accompanying examples available at https://www.karamba3d.com/download/.
Stable releases and work in progress versions of Karamba3D can be found here: https://github.com/karamba3d/K3D_NightlyBuilds. There it is also possible to supply bug reports and feature requests.