Définition d’un plug-in

Les paramètres qui définissent l’aspect d’une commande scriptée, d'un outil, ou d'un plug-in sont enregistrés dans une base de données de paramètres, liée à tout objet placé dans le document. Ces enregistrements stockent les données persistantes entre les usages, et fournissent les valeurs des paramètres par défaut. Une commande qui affiche une boîte de dialogue, par exemple, peut nécessiter d'enregistrer des valeurs entrées par un utilisateur pour un usage ultérieur. Un outil peut proposer plusieurs options dans une liste déroulante. Si l’utilisateur souhaite sélectionner une option différente pour cet outil, le nouveau paramètre peut être enregistré et réutilisé au prochain usage de l'outil. Ces valeurs sont stockées dans l'enregistrement des paramètres de la commande de menu ou de l’outil, et récupérées ultérieurement lorsque la commande ou l’outil est à nouveau sélectionné. Lorsque vous alternez entre plusieurs fichiers, les valeurs enregistrées associées à ces fichiers sont affichées, ou, s’il n’existe pas d’enregistrement, les valeurs créées par le plug-in sont affichées comme paramètres par défaut .

Vous pouvez modifier les paramètres de chaque instance d'objet via la palette Info Objet, grâce à laquelle vous accédez aux valeurs des paramètres de l'objet dans l'enregistrement. Un enregistrement des paramètres par défaut est également créé lorsque l’objet (ou l’outil) est placé pour la première fois dans le fichier. Cet enregistrement sauvegarde les préférences par défaut de l’objet avec le fichier. Il est utilisé pour chaque nouvel objet placé.

Pour définir le plug-in sur mesure:

Sélectionnez dans la boîte de dialogue « Gestionnaire des plug-ins » l’onglet Plug-ins sur mesure.

Cliquez sur le bouton Éditer définition.

La boîte de dialogue « Éditer la définition du plug-in » s’ouvre.

Cliquez pour afficher/masquer les paramètres.

Paramètre	Description
Général
Méthode de rendu	Indique le type de plug-in (commande, outil, objet ou fichier include).
Langage	Vous voyez apparaître ici le langage script utilisé pour le script du plug-in (voir Écrire des scripts pour des plug-ins).
Nom	Saisissez le nom du nouveau plug-in (qui deviendra également le nom de fichier du plug-in accompagné automatiquement de l'extension adéquate: .px, .vsm, .vst, ou .vso. Si vous renommez un plug-in, n’oubliez pas, ensuite, de mettre à jour votre configuration.
Catégorie	Attribuez le plug-in à une catégorie pour le retrouver facilement lorsque vous éditez la configuration.
Paramètres	Déterminez les paramètres par défaut pour le plug-in. Les paramètres par défaut sont appliqués au moment où vous utilisez le plug-in. Ils sont affichés dans l’ordre donné du plug-in. Vous pouvez modifier l’ordre des paramètres en les faisant glisser dans la colonne #.
Liste des paramètres	Dans cette fenêtre, vous trouvez une liste des paramètres par défaut des objets, éventuellement un alias (localisé), le format et la valeur par défaut. Pour les objets linéaires, le paramètre LineLength est affiché, désignant la longueur à l’axe de l’objet linéaire. Pour les objets rectangulaires, les paramètres LineLength (longueur d’origine de l’objet) et BoxWidth (largeur d’origine de l’objet) sont affichés. Vous pouvez donner de nouvelles valeurs par défaut pour ces paramètres, mais vous ne pouvez pas les supprimer.
Nouveau	Cliquez pour ouvrir la boîte de dialogue « Éditer paramètre » et créer un nouveau paramètre pour le plug-in. Indiquez le nom, le nom auxiliaire si nécessaire, le type et la valeur par défaut. Pour créer une liste d’options prédéfinies, sélectionnez comme Type l’option Liste déroulante. La boîte de dialogue « Valeurs disponibles » s’ouvre. Saisissez la liste des options. Chaque ligne de la liste représente un choix d’option. Ne laissez pas de ligne vide. Pour éditer les choix de la liste par la suite, cliquez sur Valeurs.
Éditer	Cliquez pour ouvrir la boîte de dialogue « Éditer paramètre » et éditer le paramètre sélectionné. Vous pouvez également éditer les paramètres de certains plug-ins tiers et plug-ins intégrés.
Supprimer	Cliquez pour supprimer le plug-in sélectionné.
Textes	Déterminez les chaînes de caractères utilisées par le plug-in.
Liste des catégories de textes	Cette liste reprend les catégories de textes utilisées par le plug-in (par exemple, les noms de paramètres et de boutons pour une boîte de dialogue, ou les textes d’aide). Dans chaque catégorie, spécifiez les textes (par exemple, des valeurs de sélection d’une couleur qui indiquent quelle couleur doit être utilisée par le plug-in).
Ajouter	Cliquez pour ouvrir la boîte de dialogue « Ajouter catégorie » et ajouter une catégorie de texte à la définition du plug-in. Le prochain ID disponible est attribué automatiquement. Saisissez le nom de la catégorie. Après l’ajout d'une catégorie, sélectionnez-la et cliquez sur Éditer pour ajouter du texte.
Éditer	Cliquez pour ouvrir la boîte de dialogue et éditer la catégorie de texte sélectionnée. Cliquez sur Ajouter pour ajouter une nouvelle chaîne de caractères ou sélectionnez un texte et cliquez sur Éditer ou Supprimer. La valeur dépend de la catégorie. Pour plus d’informations, voir developer.vectorworks.net.
Supprimer	Cliquez pour supprimer la catégorie sélectionnée et tous ses textes.
Préférences	Grâce à ces préférences, les plug-ins peuvent se comporter comme des outils, objets et commandes standard dans Vectorworks. Elles vous permettent de déterminer le comportement du plug-in concernant l’état du fichier (état de sélection, affichage), ainsi que le texte d’aide affiché. Les préférences disponibles dépendent du type de plug-in. Vous pouvez uniquement définir les préférences des plug-ins sur mesure.
Commande
Disponibilité	Pour chaque situation dans le dessin, indiquez si la condition est exigée (la condition est nécessaire pour que la commande soit exécutée), non autorisée (la commande est désactivée dans cette situation) ou si elle peut être ignorée (la situation n’a pas d’influence sur l’activation de la commande).
Message d’aide	Saisissez le texte qui apparaîtra comme texte d’aide lorsque vous placerez votre curseur sur une commande (actuellement, cette option est uniquement disponible sur Macintosh).
Écraser aide contextuelle	Saisissez une URL (commençant par http:) pour définir une page web contenant l’aide relative au plug-in. Pour définir un fichier par rapport au dossier de programme Vectoworks, indiquez l’emplacement du fichier en commençant par. / (point et barre oblique).
Créé dans la version	Déterminez dans quelle version de Vectorworks le plug-in a été créé. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Modifié dans la version	Indiquez dans quelle version de Vectorworks le plug-in a été modifié pour la dernière fois. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Fin de support dans la version	Indiquez depuis quelle version de Vectorworks le plug-in n’est plus pris en charge. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Outil
Message de la Barre des modes	Déterminez le texte de description devant apparaître dans la Barre des modes. Il s’agit souvent du nom de l’objet et éventuellement de l’action que l’utilisateur doit exécuter.
Icône	Vous pouvez remplacer le pictogramme standard par une icône sur mesure. S’il s’agit d’un éditeur d’icône tiers, créez deux versions de l’icône: une pour une résolution d’affichage standard et une autre pour une résolution élevée: Résolution standard: une image centrée dans une zone de 26 pixels de large sur 20 pixels de haut. Enregistrez l’image au format .png. Résolution élevée: réalisez une image de 8 bits centrée dans une zone de 52 pixels de large sur 40 pixels de haut. Enregistrez l’image au format .png sous le même nom que l’icône de résolution standard avec la mention « @2x » ajoutée au nom du fichier. Par exemple, si l’icône de résolution standard s’appelle TrousseModelisation3D.png, l’icône de résolution élevée devra porter le nom TrousseModelisation3D@2x.png. Sinon, le programme ne pourra pas retrouver l’icône. Cliquez sur Éditer icône pour importer l’icône de résolution standard. Si une icône de haute résolution est également présente avec la mention @2x, le logiciel l’importera également automatiquement. Le programme Vectorworks utilise automatiquement l’icône adaptée à la résolution de votre appareil.
Projection	Déterminez l’affichage qui doit être actif. Si une projection 3D est requise, l’affichage sera adapté. Si une projection 2D est requise, le plan du calque sera activé pour cet outil. La projection hybride n’affecte pas la projection de la vue.
Exécuter le script	Par défaut, les outils sont directement exécutés lorsqu’ils sont sélectionnés. Dans certains cas, il peut cependant être souhaitable de n’exécuter le script qu’à une action de la souris (comme par exemple avec un outil qui effectue un tracé interactif basé sur les mouvements de la souris).
Écraser aide contextuelle	Saisissez une URL (commençant par http:) pour définir une page internet contenant l’aide relative au plug-in. Pour définir un fichier par rapport au dossier de programme Vectoworks, indiquez l’emplacement du fichier en commençant par. / (point et barre oblique).
Créé dans la version	Déterminez dans quelle version de Vectorworks le plug-in a été créé. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Modifié dans la version	Indiquez dans quelle version de Vectorworks le plug-in a été modifié pour la dernière fois. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Fin de support dans la version	Indiquez depuis quelle version de Vectorworks le plug-in n’est plus pris en charge. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Message d’aide	Saisissez le texte qui apparaîtra comme texte d’aide lorsque vous placerez votre curseur sur une commande (cette option est uniquement disponible sur Macintosh).
Objet
Icône	Vous pouvez remplacer le pictogramme standard par une icône sur mesure. Réalisez une image de 8 octets centrée dans une zone de 26 pixels de large sur 20 pixels de haut. Enregistrez l’image au format .png et cliquez sur Éditer icône pour l’importer.
Projection	Déterminez l’affichage qui doit être actif. Si une projection 3D est requise, l’affichage sera adapté. Si une projection 2D est requise, le plan du calque sera activé pour cet outil. La projection hybride n’affecte pas la projection de la vue.
Exécuter le script	Par défaut, les objets sont directement exécutés lorsqu’ils sont sélectionnés. Dans certains cas, il peut cependant être souhaitable de n’exécuter le script qu’à une action de la souris (comme par exemple avec un objet qui effectue un tracé interactif basé sur les mouvements de la souris).
Classe par défaut	Déterminez la classe par défaut dans laquelle l’objet doit être créé. Si la classe n’existe pas encore au moment où vous placez l’objet, celle-ci sera créée automatiquement.
Écraser aide contextuelle	Saisissez une URL (commençant par http:) pour définir une page web contenant l’aide relative au plug-in. Pour définir un fichier par rapport au dossier de programme Vectoworks, indiquez l’emplacement du fichier en commençant par. / (point et barre oblique).
Créé dans la version	Déterminez dans quelle version de Vectorworks le plug-in a été créé. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Modifié dans la version	Indiquez dans quelle version de Vectorworks le plug-in a été modifié pour la dernière fois. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Fin de support dans la version	Indiquez depuis quelle version de Vectorworks le plug-in n’est plus pris en charge. Par exemple, pour Vectorworks 2020, 2021 et 2022, utilisez respectivement 25, 26 et 27.
Message d’aide	Saisissez le texte qui apparaîtra comme texte d’aide lorsque vous placerez votre curseur sur une commande (cette option est uniquement disponible sur Macintosh).
Sous-parties	Indiquez les sous-parties utilisées dans le plug-in.
Liste des sous-parties	Cette liste reprend chaque sous-partie et son nom alternatif (traduit) si celui-ci est disponible.
Nouveau	Cliquez pour ajouter un nouveau nom de sous-partie au plug-in. La boîte de dialogue « Ajouter nom de la sous-partie » s'ouvre. Indiquez le nom du paramètre et un nom alternatif (traduit) si nécessaire.
Éditer	Cliquez pour éditer le nom de sous-partie sélectionné.
Supprimer	Cliquez pour supprimer le nom de sous-partie sélectionné.
Options (types d’objet paramétrique personnalisés uniquement)
Options d'exécution	Les objets, comme les symboles, peuvent se voir attribuer des options d'insertion prédéfinies pour le placement dans le document. Ces options permettent aux objets d'interagir correctement avec des murs ou d’autres types d’objets avancés. Les plug-ins de type commande et outil n’ont pas d’option d’insertion. Par défaut, la géométrie d’un objet ne sera recalculée que si les paramètres ou les points de contrôle de l’objet sont modifiés. Lorsque la géométrie de l’objet est recalculée, les préférences par défaut du fichier pour les attributs tels que la police, la taille de texte ou la couleur de trait seront ré-appliqués à l’objet. Si l’un de ces paramètres a été modifié depuis que l’objet a été placé ou modifié pour la dernière fois, l’aspect de l’objet peut changer. Le script est exécuté lorsque les paramètres de l’objet sont modifiés. Pour des cas où il est important que l’objet soit à nouveau calculé (par exemple pour des fenêtres placées dans un mur), le script peut aussi faire en sorte que l’objet soit recalculé si celui-ci est pivoté (Actualiser après rotation) ou déplacé (Actualiser après déplacement). Le script du plug-in peut aussi devenir un gestionnaire d’évènements (Selon les évènements). Les scripts doivent alors répondre à un petit ensemble d’évènements d’application. Vous trouverez des exemples et de la documentation (en anglais) sur www.vectorworks.net.
Insérer dans murs	Sélectionnez l’option souhaitée pour l’objet. Voir Créer un symbole. Pour les objets ne nécessitant pas d’options d’insertion, laissez les valeurs par défaut.

Dès que vous avez défini le plug-in, cliquez sur OK pour revenir au gestionnaire des plug-ins.

Écrire des scripts pour des plug-ins

Définir des plug-ins

Concept: Plug-ins