Interface de programmation

  Première page Page suivante Vous avez besoin de JavaScript pour l'impression!  

Le »Designer de Faces Avant« propose une interface de programmation (API) dans le cadre de sa version beta grâce à laquelle les utilisateurs puvent créer des séquences de fraisage et de gravure pour la face actuelle ou une nouvelle plaque. Ces séquences sont alors formulées sous forme d’un script JavaScript exécutable.

Fenêtre de script

Toutes les actions décrites ci-après sont exécutées dans la fenêtre de script. Vous y accédez depuis Édition  > Scripts. Une vue simplifiée est ouverte afin de toujours voir la face actuelle (qui est éventuellement préparée via un script). Pour la même raison, la fenêtre de script revient à sa version simplifiée après l’exécution du script.

Vous ouvrez l’affichage complet de l’éditeur de script en cliquant sur le bouton «  >> » que vous trouvez au-dessus de l’affichage des scripts disponibles. Cet éditeur est automatiquement ouvert lorsque vous cliquez sur le bouton « Nouveau » afin de commencer un nouveau script.

Les fonctions accessibles depuis la fenêtre de script sont décrites ci-après à l’aide de différentes actions.

Vous trouvez le PDF sur l’interface de programmation à télécharger dans la section correspondante ci-dessous.

Organiser les scripts

Après l’ouverture de la fenêtre de script (voir ci-dessus), vous voyez dans la partie supérieure tous les scripts que vous avez créés (« Scripts utilisateur ») ainsi que ceux qui ont été fournis avec le  »Designer de Faces Avant« (« scripts FPD »). Les scripts utilisateur sont enregistrés comme suit :

Windows : %APPDATA%\FrontDesign\Scripts
Mac : $HOME/.FrontDesign/Scripts
Linux : $HOME/.FrontDesign/Scripts

Si vous avez modifié le chemin d’accès par ex. depuis le gestionnaire de fichiers, mettez la fenêtre de script simplement à jour en cliquant à gauche du bouton « PastePad » en haut de la liste des scripts.

Cliquez sur « Renommer… » afin d’accéder au dialogue pour renommer le nom d’un script utilisateur.

Lorsque le script concerne des gravures HPGL ou des contours libres (respectivement les fichiers PLT ou DXF), vous pouvez regrouper tous les fichiers sous un même dossier qui vous enregistrez sous le chemin d’accès correspondant. Vous trouverez des détails dans la section « »Frontplatten Designer« ».

La description d’un script (à l’aide du champ d’affichage de la vue simplifiée) est reprise de la ligne de commande du script qui commence par « #de# : », « #en#: » ou « #fr#: ». La chaîne de caractères qui suit est alors interprétée comme la description du script (voir la figure ci-dessous).

Exécuter un script

Pour démarrer un script de la liste, sélectionnez-le puis appuyez sur le bouton « Start ». Afin de démarrer un script externe, copiez le code depuis votre éditeur puis ajoutez-le à l’aide de la fonction « PastePad » (appel depuis le bouton au-dessus de la liste des scripts) et exécutez-le ensuite comme un script interne.

Pendant l’exécution du script dans le »Designer de Faces Avant«,

les sorties obtenues par la fonction Print()
les résultats du script
les messages d’erreur

sont affichés dans la partie « Sortie ».

Une fois le script exécuté, la face avant modifiée/créée est affichée dans la zone de travail du »Designer de Faces Avant«.

Modifier un script

Pour modifier le script sélectionné, activez l’éditeur de script intégré avec le bouton «  >> » au dessus de l’affichage des scripts disponibles (cet éditeur est automatiquement ouvert lorsque vous commencez un nouveau script en cliquant sur « Nouveau »).

Vous pouvez à tout moment exécuter le script modifié (bouton « Démarrer »), l’enregistrer avec le bouton « Enregistrer » ou le sauvegarder sous un autre nom comme script complémentaire (bouton « Enregistrer sous »).

Utilisez l’invite de commande JavaScript pour tester séparément les lignes ajoutées ou créées (par exemple pour essayer plusieurs variantes de fraisage en sachant que vous pouvez toujours supprimer les objets créés sur une face).

Vous trouvez la documentation sur l’interface de programmation à télécharger dans la section correspondante ci-dessous.

Ajouter un script externe

Vous ajoutez un script externe (extension « fpjs ») que vous auriez par ex. reçu d’un autre utilisateur, à l’aide du bouton du même nom (en bas à gauche). Il sera automatiquement enregistré comme suit :

Windows: %APPDATA%\FrontDesign\Scripts
Mac: $HOME/.FrontDesign/Scripts
Linux: $HOME/.FrontDesign/Scripts

Vous pouvez également copier ou déplacer le script externe dans le dossier correspondant.

Pour tester d’abord un script externe, il vous suffit de le copier depuis l’application que vous utilisez puis de l’ajouter à l’aide de la fonction « PastePad » (voir la section « Tester directement un code externe » ci-après) pour enfin le démarrer directement depuis l’éditeur intégré.

Créer un nouveau script

Vous créez un nouveau script (vide) en cliquant sur le bouton « Nouveau ». Vous voyez ensuite sous « Scripts utilisateur » le script « Sans nom?.fpjs » (« ? » correspond à l’index séquentiel »). Les étapes suivantes pour le modifier et l’exécuter sont décrites ci-dessus. Les noms de fichiers générés automatiquement peuvent être modifiés en cliquant sur « Renommer… ».

De même, vous pouvez enregistrer un script existant sous un autre nom.

Tester directement le code externe

Vous pouvez tester les codes d’un script externe sans pour autant créer un nouveau script utilisateur. Pour cela, copiez le code depuis votre application et ajoutez-le dans l’éditeur intégré à l’aide de la fonction « PastePad » (accès depuis la liste des scripts).

La fonction PastePad ouvre une fenêtre afin d’ajouter un code de script externe dans le »Designer de Faces Avant«  à l’aide du Copier&Coller, puis de le tester directement. La fonction PastePad comprend un champ texte où vous copiez votre code, un champ de sortie ainsi que deux boutons pour effacer la sortie et exécuter le code.

Documentation de l’interface de programmation

Le document qui est proposé ici à télécharger décrit l’interface de programmation de scripts du »Designer de Faces Avant«. Le langage de script utilisé est JavaScript. Vous avez cependant besoin de connaissance de base sur JavaScript (nous vous recommandons le livre : « JavaScript : The Good Parts » de Doug Crockford). Des exemples de scripts sont fournis avec le Designer de Faces avant et vous permettent de voir la structure d’un script.

Téléchargez ici la description de l’interface de programmation du »Designer de Faces Avant« :

Button

Enregistrer les fichiers associés pour le script, la gravure et le contour libre comme pack

Si votre script se réfère à une gravure ou des contours libres, nous vous recommandons d’enregistrer tous les fichiers associés dans le même dossier que celui du script. Ainsi tous les fichiers forment un pack et sont affichés sous le nom du dossier dans la liste des scripts. Vous pouvez bien entendu éditer et démarrer le script associé comme décrit ci-dessus.

Attention : Le contenu d’un tel dossier est uniquement considéré comme un pack lorsque le script inclus porte le nom « script.fpjs ».

Vous pouvez également comprimer le dossier et l’ajouter au script utilisateur depuis l’emplacement de votre choix. Cette procédure décomprime définitivement le contenu du fichier dans le dossier du script correspondant.