Scripting/Projet/Fonctions globales
Fonctions globales
Pour commencer on va examiner les différentes façons d'afficher une fenêtre à l'écran, qu'il s'agisse d'un simple message d'alerte lancé à l'utilisateur, d'une demande de confirmation ou encore d'une boîte de dialogue permettant d'aller chercher un fichier dans l'ordinateur. On ne parlera pas ici des éléments d'interface utilisateur que l'on peut créer soi-même pour interagir avec l'utilisateur, ceux-ci seront vus dans la section Interface.
alert()
, prompt()
, ...
La fonction alert()
permet d'afficher un message dans une fenêtre. Elle prend
en argument (ou paramètre) une chaîne de caractères notée entre guillemets (les chaînes de caractères sont
toujours notées entre guillemets). Elle correspond au message à afficher. Cette fonction est très utile notamment
pour prévenir l'utilisateur en cas d'échec (ou de succés) d'une opération ou pour lui rappeler dans quelle
condition le script doit s'exécuter. C'est un bon moyen pour communiquer avec lui.
La fonction alert()
La fonction confirm()
affiche une fenêtre demandant une confirmation (oui/non?) et
retourne une valeur booléenne (true
ou false
).
La fonction confirm()
La fonction prompt()
affiche une fenêtre contenant une zone de texte
éditable. C'est un moyen par exemple pour demander de préciser la valeur d'un paramètre
du script. Elle nécessite deux chaînes de caractères, la première étant le message à afficher et la seconde
le texte par défaut situé dans l'espace éditable.
La fonction prompt()
On peut utiliser la fonction fileGetDialog()
pour aller rechercher un fichier.
Elle nécessite deux arguments qui sont le titre de la fenêtre et le type de fichier
à ouvrir (qu'on peut laisser vide "" si l'on ne souhaite pas spécifier une extenion particulière).
Cette fonction retourne un objet File
ou null
si
aucun fichier n'a été sélectionné.
La fonction fileGetDialog()
Il est également possible de sélectionner un dossier en utilisant la fonction
folderGetDialog()
. Elle nécessite la chaîne de caractères à afficher au-dessus de
l'arborescence. Cette fonction retourne un objet Folder
ou null
si aucun dossier n'a été sélectionné.
La fonction folderGetDialog()
Pour terminer cette partie, on mentionne une dernière fonction qui peut être utile pour afficher des
informations dans l'interface d'After Effects. Elle nécessite une chaîne de caractères et affiche cette
chaîne dans la palette "Informations". Il s'agit de la fonction write()
La fonction write()
Il existe aussi la variante writeLn()
pour écrire sur plusieurs lignes
et la fonction clearOutput()
pour effacer le contenu de la palette.
Remarques
La majorité de ces fonctions acceptent une chaîne de caractères additionnelle, que l'on spécifie en dernier argument. Ce texte représente le titre de la fenêtre (à la place du message "Script Prompt" par exemple). Y mettre le nom du script est un bon moyen de s'identifier.
Pour connaître les fonctions les plus récentes permettant de manipuler les fichiers ou les dossiers, on pourra consulter la dernière version du JavaScript Tools Guide.