HiCAD-API (Application Programming)

C#

HiCAD kann verschiedene Programmiersprachen verarbeiten, in denen API-Scripte geschrieben sind, zum Beispiel Visual Basic, Delphi und C#.

Um eine gute Unterstützung gewährleisten zu können, hat sich ISD für die Programmiersprache C# entschieden (englische Aussprache: "C sharp"). Dies bedeutet, dass die ISD ihre Scripte in dieser Sprache programmiert. In der Schulung wird das Schreiben von API-Scripten in der C#-Programmiersprache behandelt.

 

Beispiel

Nachstehend ist das Beispiel eines kurzen Scripts aufgeführt, das in C# geschrieben wurde:

// <debug />

// <assembly>API/System.Data.dll</assembly>

using System;

using ISD.Scripting;

using ISD.CAD.Data;

using ISD.BaseTypes;

using ISD.CAD.Contexts;

using ISD.CAD.Creators;

namespace Api_Scripts

{

    class Script : ScriptBase

    {

        [Context(typeof(UnconstrainedContext))]

        public static void Main()

        {

            // Create Cuboid

            BlockCreator bc = new BlockCreator();

            bc.Length = 100;

            bc.Width = 150;

            bc.Height = 50;

            bc.Name = "Block";

            Part prt = Context.CreatePart(bc);

        }

        public static UnconstrainedContext Context

        {

            get { return BaseContext as UnconstrainedContext; }

       } 

    }

}

Eine Quelldatei von C# wird mit der Dateierweiterung "cs" gespeichert, zum Beispiel 'Example script.cs'. Dieses Script, das direkt in HiCAD aufgerufen werden kann, erstellt einen neuen Quader mit der Bezeichnung "Block" und den Abmessungen 100x150x50.

 

API in HiCAD

In HiCAD kann API auf verschiedene Arten angewendet werden, zum Beispiel als einzelnes Script, als Hilfsmittel oder gar als eigenständige Anwendung. In welcher Weise API eingesetzt wird, hängt ausschließlich vom Verwendungszweck ab.

Ein einzelnes Script kann manuell in HiCAD aufgerufen werden (STRG+J) und dann einen oder mehrere Arbeitsschritte ausführen. Gegebenenfalls kann in einem Script ein Menü programmiert werden, das den Benutzer zur Eingabe bestimmter Daten auffordert.

Beispiel für ein einzelnes Script: Automatisch alle Farboberflächen aller in der Zeichnung aufgeführten Bauteile zählen und unter den Attributen eines auswählbaren Elements speichern. Wenn das Script häufig verwendet wird, kann hierfür eine Schaltfläche in der Toolbar erstellt werden.

API-Scripte können in das Feature-Protokoll eines Bauteils eingefügt werden.

Ein Plug-in ist ein Zusatz zu einem Computerprogramm. Im Allgemeinen werden Plug-ins entwickelt, um die Funktionalität eines Programms zu erweitern oder dieses mit mehr Möglichkeiten auszustatten. Plug-ins benötigen eine Host-Anwendung, um funktionieren zu können; sie können nicht im Einzelbetrieb betrieben werden. In HiCAD können Plug-ins mit Hilfe von API generiert werden. Plug-ins tragen die Erweiterung .dll und nicht .cs. In HiCAD werden Plug-ins über die Einstellungen aktiviert und deaktiviert.

API

Ein Beispiel für ein Plug-in ist das standardmäßig verfügbare "Metall Konstruktions Plug-in". Hiermit können Skizzen für den Metall- oder Stahlbau angefertigt werden, die später für die Platzierung der Profile in der Konstruktion verwendet werden können. Plug-ins werden in HiCAD wie ein so genanntes Docking Window behandelt, das heißt, das man dieses Fenster in HiCAD lose auf dem Bildschirm "schweben" lassen oder "andocken" (ankoppeln) kann. Gegebenenfalls können Plug-ins auch als "Fly-out" definiert werden. Dies bedeutet, dass das Plug-in erscheint, wenn der Benutzer den Mauszeiger über das eingeklappte Menü belegt.

API

APIFUNC-ObjekteMakrotechnik