Scripting Guide v2
  • Welcome to Karamba3D Scripting Guide
  • Go to Scripting Guide 1.3.3
  • Go to Manual
  • 1. Introduction
    • 1.1: Scripting with Karamba3D
    • 1.2: What's New in Karamba3D 1.3.3 Regarding Scripting
  • 2. Scripting with Karamba3D inside Grasshopper
    • 2.1: Hello Karamba3D
    • 2.2: Data Retrieval from Models
    • 2.3: How to Create Structural Models
    • 2.4: How to Modify Structural Models
      • 2.4.1: Cross section Optimization
      • 2.4.2: Activation and Deactivation of Elements
    • 2.5: Data Export from Karamba3D
    • 2.6: The VB Script Component
    • 2.7: The IronPython Component
      • 2.7.1: Results Retrieval on Shells
      • 2.7.2: A Simplified ESO-Procedure on Shells
  • 3. How to create your own Karamba3D Grasshopper-component
    • 3.1: Setting up a Visual Studio Project for GH Plug-ins
    • 3.2: Basic Component Setup
    • 3.3: How to Reference Karamba3D Assemblies
    • 3.4: Input- and Output-Plugs
    • 3.5: Adding Functionality to a GH Component
  • Bibliography
Powered by GitBook
On this page
  • Citing Karamba3D
  • Disclaimer

Was this helpful?

Welcome to Karamba3D Scripting Guide

The official scripting guide using Karamba3D 2.2.0

Next1.1: Scripting with Karamba3D

Last updated 3 years ago

Was this helpful?

This manual describes how to use Karamba3D inside C#-scripts. Since C# is a member of the .NET family everything said also applies to code in IronPython, F#, Visual Basic or any other scripting language being based on the Common Language Infrastructure (CLI).

This manual is not an introduction to C#. For introductional material see e.g. or . More advanced topics – useful yet not necessary for reading this manual – can be found in the fantastic book “C# in Depth” see .

The previous version of this guide contained sections on how to integrate Karamba3D (K3D) in Java, C++ and native Python. Judging from user feedback these options are not widely used. This is why those chapters where left out in this manual. Instead this manual dwells more on the C#-interface of Karamba3D.

Examples detailed in this guide can be found in the ""-collection.

The help files (“Karamba3D_2_2_0_SDKDoc.chm”) can be found inside this archive, which is also accessible online: .

.

Navigate through the following chapters below or in the menu on the left.

Citing Karamba3D

In case you use Karamba3D for your scientific work, please cite the following paper:

Preisinger, C. (2013), Linking Structure and Parametric Geometry. Architectural Design, 83: 110-113 DOI: 10.1002/ad.1564.

Disclaimer

Although being tested thoroughly Karamba3D probably contains errors – therefore no guarantee can be given that Karamba3D computes correct results. Use of Karamba3D is entirely at your own risk. Please read the that comes with Karamba3D in case of further questions.

This manual is written by Clemens Preisinger. Editing by Georg Lobe.

[1]
[3]
[4]
Karamba3D Scripting Examples Github
Karamba3D 2.2.0 SDK Documentation
Karamba3D 1.3.3 SDK Documentation
license agreement