Vorwort

Das KKP bietet eine API mit sich die Konstruktion aus dem 3D Raum manipulieren oder auch abfragen lässt. Ferner ist die API dazu in der Lage Daten, die aus der 3D Konstruktion generiert werden, wie beispielsweise Material- und Zuschnittsdaten, sowie Angebotsinformationen und Bilder zu generieren. Zudem kann die API-Schnittstelle genutzt werden, um Druckformulare durch dynamische Inhalte zu ergänzen. Schließlich kann die API-Schnittstelle sogar dazu verwendet ganze 3D Konstruktionen automatisiert zu generieren.

Die API-Schnittstelle wird mittels der Skriptsprache Python bedient. Dabei haben wir die Funktionalität der Sprache nicht eingeschränkt. Sie können also alle Funktionen nutzen, die das Python Ihnen bietet. Daher erlaubt die Schnittstelle selbst die direkte Manipulation von Dateien wie Datenbanken, Konfigurationsdateien, Projektdaten, Adressdaten, usw.

Der Aufruf der API-Schnittstelle erfolgt zu verschiedenen Zeitpunkten, die jeweils zweckgebunden sind.

Einmal kann die Schnittstelle aufgerufen werden, sobald das erste Mal der 3D Raum betreten wird. Dazu muss das KKP mit einer speziellen Konfigurationsdatei gestartet werden. Bei dieser Form des Aufrufes geht es darum eine Konstruktion über Daten aus einer Konfigurationsdatei automatisiert zu generieren.

Die zweite Form des Aufrufes erfolgt, wenn der 3D Bereich verlassen wird. Hier ist die Absicht bestimmte Einstellungen an der Konstruktion zu überprüfen und ggf. zu korrigieren. So wird dieser Abschnitt gerne genutzt um Glasleisten passend zur gewählten Glasstärke und verwendeten Sparren einzustellen.

Die dritte Stelle, an der die API aufgerufen werden kann, ist der Bereich des Texteditors. In jeder Dokumentvorlage kann man beliebig viele Skripte einsetzen, die über die API-Schnittstelle verfügen. So ist es möglich, bestimmte Informationen aus der Konstruktion zu erhalten und diese in das Dokument einzubringen.

Abhängig vom verwendeten System kann es sein, dass auch noch bestimmte Sonderfunktionen von uns in die Software integriert wurden an denen die API-Schnittstelle aufgerufen wird. Diese sind aber hochgradig systemspezifisch und werden daher nicht in dieser allgemeinen Dokumentation berücksichtigt. So können Skripte für die Erstellung von CNC-Daten erstellt und aufgerufen werden, oder Skripte, die auf die Erzeugung von Materialien und Stücklisten Einfluss nehmen.