Cette fonction alloue un espace de travail en mémoire qui servira à conserver le catalogue courant, la scène courante ou encore la langue courante. Le paramètre IniFileNameWithoutpath indique le nom du fichier de configuration de l’application (avec l’extension .INI mais sans le chemin car il doit se trouver dans le même répertoire qu’APPLICATOOLS.DLL). Le fichier de configuration défini par exemple les répertoires de travail (catalogues, textures, …), le nom du fichier dictionnaire, ainsi que d’autres paramètres de fonctionnement comme les règles de pose des linéaires automatiques, etc. Si ce paramètre est une chaîne vide, c’est le fichier SPACE.INI qui sera pris.

ATTENTION : la fonction retourne 0 s’il n’y a plus d’heure d’utilisation sur le compte ET si aucune clé de protection n’est branchée. Il faut donc tester le retour de la fonction avant de le passer en paramètre.

Cette fonction libère l’espace mémoire alloué en début de traitement par la fonction StartSession ou la fonction StartSessionFromCallParams. Le paramètre SessionId représente la valeur retournée par la fonction StartSession ou la fonction StartSessionFromCallParams.

Cette fonction fixe l’utilisateur courant de KitchenDraw qui est identifié par les paramètres Ident et Password comme le fait la boîte de dialogue d’identification de l’utilisateur au lancement de KitchenDraw (quand il y a plusieurs utilisateurs ou que l’utilisateur unique possède un mot de passe). Cette fonction est utile par exemple dans le cadre du développement d’une application autonome devant exécuter des fonctions SDK qui requièrent des droits particuliers comme le paramétrage des utilisateurs, des sites, des fournisseurs, etc. qui requièrent des droits d’administrateur. Cette fonction peut servir aussi lors du développement d’une boîte de dialogue d’identification de l’utilisateur alternative à celle de Kitchendraw.

Cette fonction permet de spécifier quel doit être le rang du premier élément dans les paramètres de type « rang » des fonctions du SDK (normalement 0 ou 1). Si le paramètre BaseIndex vaut 1 (valeur par défaut) alors le premier élément sera représenté par un rang de valeur 1. Si BaseIndex vaut 0 alors il faudra spécifier un rang valant 0 pour atteindre le premier élément.

Cette fonction établit la langue courante parmi les langues disponibles de KitchenDraw. Le paramètre LanguageCode représente le code de la langue tel qu’il est affiché dans la boîte à options « Langue » de la boîte de dialogue « Configuration | Système » de KitchenDraw. Par exemple, il faut choisir « FRA » pour le français, « ENG » pour l’anglais, « DEU » pour l’allemand, etc. La langue courante par défaut est l’anglais.

Cette fonction recherche la traduction dans la langue courante de l’application de la chaîne de caractères passée dans le paramètre Text. La chaîne de caractères à traduire doit être dans la langue de travail du catalogue courant et sa traduction est recherchée dans le dictionnaire de traduction du catalogue courant.

Cette fonction ne doit pas être appelée sans que la fonction StartSessionFromCallParams ait été appelée auparavant.

Cette fonction permet d’écrire dans le bloc de paramètres passé par l’application KitchenDraw lors de l’appel des fonctions standard. Seule la valeur de InfoType valant 7 (APPCALLPARAM_BUFFER) peut être écrite (les autres sont en lecture seule). Cette fonction est utile lors de l’écriture d’une fonction Plug-In qui doit retourner une valeur ou modifier une valeur passée en paramètre par KitchenDraw dans le champ APPCALLPARAM_BUFFER (par exemple, une fonction Plug-In qui aurait pour objet de modifier le sujet de l’email d’une commande ou pour objet de retourner une chaîne de caractères dans un document Word via le mot clé @Scène.AppelDeDll).

La chaîne retournée ne contient des informations valides que dans le cas d’un module de génération de fichiers de commandes fournisseur.

Cette fonction sélectionne dans la fenêtre de pose l’article spécifié par les paramètres CatalogFileName (sans chemin ni extension), Reference et HandingType. Les boîtes à options des catalogues, des chapitres et les boîtes de liste des blocs et des articles sont mises à jour en conséquence. Cette fonction est utile dans le cadre du développement de plug-in de recherche d’articles.

Cette fonction insère une ligne de menu (une commande) ou un séparateur dans un menu de KitchenDraw. Généralement, cette fonction est appelée une ou plusieurs fois dans une fonction plugin branchée sur l’évènement d’ouverture OnAppStartAfter de KitchenDraw afin d’ajouter des commandes personnelles. Voir le projet VB « sdk_plugin » pour plus d’informations. Le paramètre MenuItemText représente le nom de la commande tel qu’il doit apparaître dans le menu, AccelControlKey et AccelKeyCode la combinaison de touches à enfoncer pour lancer la commande (voir tableau des valeurs plus loin) avec la possibilité de leur affecter la valeur 0 si aucune touche accélératrice n’est prévue. Si le paramètre MenuItemText est une chaîne de caractères vide alors c’est un séparateur qui sera inséré. Le paramètre IconFileName indique le nom de fichier de l’image représentant l’icône (non gérée dans cette version ; il faut spécifier une chaîne vide), MenuRank le rang du menu dans lequel la commande sera insérée (à partir de 1) et ItemRank le rang de la commande dans le menu (à partir de 1 et en comptant les séparateurs ainsi que les commandes personnalisées déjà insérées). Les paramètres suivants spécifient la fonction qui sera appelée lorsque la commande ajoutée sera lancée par l’utilisateur. Le paramètre DLLFileName représente le nom de fichier (avec l’extension .DLL) de la DLL qui contient la fonction à appeler. Si la DLL n’est pas placée dans le répertoire de KitchenDraw, il est possible de faire précéder ce nom par un chemin d’accès afin de préciser le répertoire où se trouve la DLL. Sinon, c’est Si la fonction appartient à une DLL ordinaire, le paramètre ClassName doit être vide. Si la fonction appartient à une DLL ActiveX, le paramètre ClassName doit être indiqué. Le paramètre FunctionName représente le nom de la fonction à appeler. Cette fonction doit gérer un seul paramètre de type Long (CallParamsBlock) qui contient l’adresse d’une structure CALLPARAMSBLOCK et qui est passé par KitchenDraw au moment de l’appel de la fonction. Cette fonction retourne un Boolean (Vrai si la scène a été modifiée dans la fonction et Faux autrement). Cette fonction ne doit pas être appelée sans que la fonction StartSessionFromCallParams ait été appelée auparavant. La liste des codes de touches de contrôle est la suivante :

Cette fonction lance l’exécution de la commande de menu de KitchenDraw identifiée par les paramètres MenuRank et ItemRank (numéroté à partir de 1 par défaut et en comptant les séparateurs ainsi que les commandes personnalisées déjà insérées).

Cette fonction insère une ligne de menu (une commande) dans MobiScript. Pour la signification des paramètres, veuillez vous reporter à la fonction InsertMenuItem décrite ci-dessus.

Cette fonction lance l’exécution de la commande de menu de MobiScript identifiée par les paramètres MenuRank et ItemRank (numéroté à partir de 1 par défaut et en comptant les séparateurs ainsi que les commandes personnalisées déjà insérées).

Cette fonction supprime une ligne de menu (une commande, un séparateur ou un sous-menu) dans KitchenDraw. Le paramètre MenuItemId indique l’identifiant d’une commande de KitchenDraw. Le paramètre Modifier précise, par rapport à la commande indiquée précédemment, quelle ligne de menu doit être supprimée ce qui permet la suppression de lignes n’ayant pas d’identifiant (séparateurs, sous-menu, commandes personnalisées).

Cette fonction grise (ou « dégrise ») une ligne de menu dans KitchenDraw. Le paramètre MenuItemId indique l’identifiant d’une commande de KitchenDraw. Le paramètre Grayed précise si la commande doit être grisée (Vrai) ou « dégrisée » (faux). La liste des MenuItemId se trouve en annexe.

Cette fonction positionne au centre de l’écran la fenêtre dont le « handle » est passé dans le paramètre WindowHandle. Cette fonction est utile lors du développement d’assistants afin de contrôler la position de sa fenêtre à l’écran.

Les paramètres StatOnly, SellerId, SortType et FilterOn permettent de trier et de filter le résultat. -        Si StatOnly vaut Vrai, seules les scènes dont la case à cocher « Stat. » est cochée apparaîtront dans le résultat, -        Si SellerId n’est pas vide, seules les scènes appartenant à l’utilisateur dont l’Id vaudra SellerId apparaîtront dans le résultat, -        SortType permet de spécifié le critère de tri à utiliser : o   0 : par ordre alphabétique croissant du nom, o   1 : par date décroissante, o   2 : par semaine de décision décroissante. -        FilterOn permettra d’activer d’autres critères de tri (non géré dans cette version) La liste se présente sous la forme d’une suite de chaîne de caractères, chaque chaîne de caractères correspondant à un catalogue. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format : Attention : la taille maximale de la chaîne de caractères retournée est de 65000 caractères.

Cette fonction appelle une fonction de callback défini par les paramètres DllName, ClassName et FunctionName pour chaque scène enregistrée sur le compte (listée dans le fichier SCENES.LST représentant le compte en cours). Si la fonction de callback provient d’une Dll ordinaire, le paramètre ClassName sera une chaîne de caractères vide. La fonction de callback devra accepter un seul paramètre qui sera le numéro de session SessionId et devra retourner un entier Long. Si ce retour est différent de 0 la scène sera sauvegardée par EnumScenes au retour de la fonction de callback.

Si le paramètre AllItems vaut Vrai, tous les catalogues sont retournés ; sinon, seuls les catalogues valides apparaissent (catalogues qui apparaîtraient dans la boîte à options des catalogues de KitchenDraw). La liste se présente sous la forme d’une suite de chaîne de caractères, chaque chaîne de caractères correspondant à un catalogue. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format : Attention : la taille maximale de la chaîne de caractères retournée est de 65000 caractères.

Cette fonction met à jour le fichier CATALOGS.LST se trouvant dans le répertoire des catalogues. Cette mise à jour se traduit par la décompression en fichiers .CAT des fichiers .PAC éventuels se trouvant dans le répertoire principal des catalogues (par défaut C:\KD\CATALOGS) et dans le répertoire des catalogues dépendant du numéro de compte (par défaut C:\KD\CATALOGS\xxxxxxx où xxxxxxx est le numéro de compte courant) puis l’incorporation des catalogues (fichiers .CAT) dans le fichier CATALOGS.LST listant les catalogues utilisables du système.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le catalogue dont le nom de fichier (y compris le chemin d’accès complet ainsi que l’extension « .cat ») est indiqué dans le paramètre CatalogFileName. Les valeurs que peut prendre le paramètre InfoType sont les mêmes que celles de la fonction GetInfo de la classe Catalog (voir cette fonction pour obtenir la liste complète).

Cette fonction convertit un catalogue KitchenDraw normal (.CAT) dont le nom de fichier (y compris le chemin d’accès complet ainsi que l’extension « .cat ») est passé en paramètre en un catalogue compressé au format .CCA. Les catalogues compressés au format .CCA peuvent être produits par MobiScript par la commande « Fichier | Compresser pour Upload» et sont destinés à être placés (« uploadés ») sur le site de mise à jour des catalogues.

Si le paramètre AllItems vaut Vrai, tous les chapitres sont retournés ; sinon, seuls le sont les chapitres qui seraient visibles dans la fenêtre de pose de KitchenDraw (chapitres n’ayant pas @ comme premier caractère du nom). D’autre part, les noms de chapitre ne sont ni traduit dans la langue courante ni filtrés (les compléments figurant dans le nom après le caractère « @ » ne sont pas éliminés). La liste se présente sous la forme d’une suite de chaînes de caractères, chaque chaîne de caractères correspondant à un chapitre. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format :

Si le paramètre AllItems vaut Vrai, tous les blocs sont retournés ; sinon, seuls le sont les blocs qui seraient visibles dans la fenêtre de pose de KitchenDraw (blocs n’ayant pas @ comme premier caractère du nom). D’autre part, les noms de bloc ne sont ni traduits dans la langue courante ni filtrés (les compléments figurant dans le nom après le caractère « @ » ne sont pas éliminés). La liste se présente sous la forme d’une suite de chaîne de caractères, chaque chaîne de caractère correspondant à un bloc. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format :

Pour l’instant le paramètre AllItems na pas d’influence sur le résultat. Cependant, il pourra être utilisé dans une version ultérieure. La liste se présente sous la forme d’une suite de chaîne de caractères, chaque chaîne de caractère correspondant à un article. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format :

La chaîne de caractères se présente sous la forme suivante : «Corniche moderne,Corniche classique,Corniche rustique;;CM150,CC150,CR150». A gauche des « ;; », se trouvent, séparés par des virgules, les noms de bloc. A droite des « ;; », se trouvent, séparés par des virgules, les références du premier article correspondant. Pour les catalogues de meubles de cuisine et de salle de bains les différents LinearType sont les suivants : 0       Plinthes, 1       Plans de travail, 2       Cache-lumière, 3       Corniches, 4       Chants de plans de travail.

Si le paramètre AllItems vaut Vrai, tous les modèles sont retournés ; sinon, seuls les modèles visibles dans KitchenDraw (modèles n’ayant pas @ comme premier caractère du nom). D’autre part, les noms de modèle ne sont ni traduit dans la langue courante ni filtrés (les compléments figurant dans le nom après le caractère « @ » ne sont pas éliminés). La liste se présente sous la forme d’une suite de chaîne de caractères, chaque chaîne de caractère correspondant à un modèle. Le contenu de chacune des chaînes est spécifié par le paramètre Format qui est une chaîne de caractères mélangeant caractères et paramètres. Si vous souhaitez qu’un caractère particulier sépare les chaînes de caractères les unes des autres il faut le prévoir dans le paramètre Format. Voici la liste des codes qu’il est possible d’utiliser pour construire le paramètre Format :

A titre d’information, voici les numéros des types de finition du catalogue de base « BASE CUISINE » (fichier #BASE.CAT) :

La chaîne de caractères se présente sous la forme suivante : «-1,10005,10006,10007,20022,20023;;1,2,1,4,9,7». A gauche des « ;; », se trouvent, séparés par des virgules, les types de finition. Il est possible d’obtenir les noms des types de finition correspondant à ces valeurs grâce à la fonction de la classe Appli, CatalogGetFinishTypeName. Le code -1 représente le modèle, les codes en 1XXXX représentent les types de finitions de modèle et les codes en 2XXXX les types de finitions de famille. A droite des « ;; », se trouvent les positions (sorte de rangs numérotés à partir de 0 et séparés par des virgules) des finitions correspondant respectivement au types de finition listés précédemment. Chacune de ces valeur représente la position de la finition en vigueur dans la liste des finitions possibles pour le type de finition correspondant.

Cette fonction permet d’exporter la vignette correspondant à l’article de référence ArticleRef et de sens HandingType dans le catalogue dont le nom de fichier est spécifoé dans le paramètre CatalogFileName sous la forme d’un fichier .JPG, .BMP, .GIF, .PNG ou .TIF dont le nom (avec le chemin complet et l’extension) est spécifié dans le paramètre ImageFileName. Pour une description détaillée des autres paramètres veuillez vous reporter à la fonction FileExportImage de la classe Catalog.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant l’utilisateur occupant le rang Rank dans la liste des utilisateurs enregistrés dans KitchenDraw. Si Rank vaut -1, la fonction s’applique à l’utilisateur courant de Kitchendraw. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ spécifié par le paramètre InfoType de l’utilisateur occupant le rang Rank dans la liste des utilisateurs enregistrés dans KitchenDraw. Si Rank vaut -1, la fonction s’applique à l’utilisateur courant de Kitchendraw. Consultez la fonction UserGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction insère un utilisateur dans la liste des utilisateurs enregistrés dans KitchenDraw juste au dessus de l’utilisateur de rang Rank. L’identifiant de ce nouvel utilisateur est défini par le paramètre Ident.

Cette fonction ajoute un utilisateur à la fin de la liste des utilisateurs enregistrés dans KitchenDraw. L’identifiant de ce nouvel utilisateur est défini par le paramètre Ident.

Cette fonction supprime l’utilisateur de rang Rank dans la liste des utilisateurs enregistrés dans KitchenDraw. Si Rank vaut -1, la fonction s’applique à l’utilisateur courant de Kitchendraw. Attention, dans ce cas il faut effectuer un changement d’utilisateur courant à l’aide de la fonction SetCurrentUser décrite au début du document.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le site occupant le rang Rank dans la liste des sites enregistrés dans KitchenDraw. Si Rank vaut -1, la fonction s’applique au site auquel appartient l’utilisateur courant de Kitchendraw. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ spécifié par le paramètre InfoType du site occupant le rang Rank dans la liste des sites enregistrés dans KitchenDraw. Si Rank vaut -1, la fonction s’applique au site auquel appartient l’utilisateur courant de Kitchendraw. Consultez la fonction SiteGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction insère un site dans la liste des sites enregistrés dans KitchenDraw juste au dessus du site de rang Rank. Le code de ce nouveau site est défini par le paramètre Code.

Cette fonction ajoute un site à la fin de la liste des sites enregistrés dans KitchenDraw. Le code de ce nouveau site est défini par le paramètre Code.

Cette fonction supprime le site de rang Rank dans la liste des sites enregistrés dans KitchenDraw.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le fournisseur occupant le rang Rank dans la liste des fournisseurs enregistrés pour le site auquel appartient l’utilisateur courant. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ spécifié par le paramètre InfoType du fournisseur occupant le rang Rank dans la liste des fournisseurs enregistrés pour le site auquel appartient l’utilisateur courant. Consultez la fonction SupplierGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction insère un fournisseur dans la liste des fournisseurs enregistrés pour le site auquel appartient l’utilisateur courant, juste au dessus du fournisseur de rang Rank. L’identifiant de ce nouveau fournisseur est défini par le paramètre Ident.

Cette fonction ajoute un fournisseur à la fin de la liste des fournisseurs enregistrés pour le site auquel appartient l’utilisateur courant. L’identifiant de ce nouveau fournisseur est défini par le paramètre Ident.

Cette fonction supprime le fournisseur de rang Rank dans la liste des des fournisseurs enregistrés pour le site auquel appartient l’utilisateur courant.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le catalogue occupant le rang Rank dans la liste des catalogues associés au fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ spécifié par le paramètre InfoType du catalogue occupant le rang Rank dans la liste des catalogues associés au fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. Consultez la fonction SupplierCatalogGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction insère un catalogue dans la liste des catalogues du fournisseur de rang SupplierRank, juste au dessus du catalogue de rang Rank. Le nom de fichier de ce nouveau catalogue est défini par le paramètre FileName.

Cette fonction ajoute un catalogue à la fin de la liste des catalogues du fournisseur de rang SupplierRank. Le nom de fichier de ce nouveau catalogue est défini par le paramètre FileName.

Cette fonction supprime le catalogue de fournisseur de rang Rank dans la liste des catalogues du fournisseur de rang SupplierRank.

La liste des tables de coefficients de catalogue fournisseur est la suivante :

Le paramètre PriceGroup est ignoré dans le cas d’une recherche dans la table des familles ou celle des articles.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant la ligne de coefficients de rang Rank dans la table de coefficients CoeffTable du catalogue de rang CatalogRank associé au fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ spécifié par le paramètre InfoType de la ligne de coefficients de rang Rank dans la table de coefficients CoeffTable du catalogue de rang CatalogRank associé au fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. Consultez la fonction SupplierCatalogCoeffLineGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction insère une ligne de coefficients dans la table CoeffTable du catalogue de rang CatalogRank dans la liste des catalogues du fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant, juste au dessus de la ligne de coefficients de rang Rank. La nouvelle ligne de coefficients est caractérisée par le paramètre Code (et éventuellement PriceGroup dans le cas de la table des modèles). Cette fonction est essentiellement utile pour éditer la table des coefficients d’article.

Cette fonction ajoute une ligne de coefficients à la fin de la table CoeffTable du catalogue de rang CatalogRank dans la liste des catalogues du fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. La nouvelle ligne de coefficients est caractérisée par le paramètre Code (et éventuellement PriceGroup dans le cas de la table des modèles). Cette fonction est essentiellement utile pour éditer la table des coefficients d’article.

Cette fonction supprime la ligne de coefficients de rang Rank dans la table CoeffTable du catalogue de rang CatalogRank dans la liste des catalogues du fournisseur de rang SupplierRank pour le site auquel appartient l’utilisateur courant. Cette fonction est essentiellement utile pour éditer la table des coefficients d’article.

Les fonctions d’édition des utilisateurs et des sites décrites ci-dessus ont lieu en mémoire. Si l’on veut conserver ces modifications pour des utilisations ultérieures de Kitchendraw il est nécessaire d’enregistrer ces paramètres dans le fichier de configuration. C’est l’objet de cette fonction.

Les fonctions d’édition des fournisseurs, des catalogues qui leurs sont associés ainsi que des coefficients de ces catalogues qui sont décrites ci-dessus ont lieu en mémoire. Si l’on veut conserver ces modifications pour des utilisations ultérieures de Kitchendraw il est nécessaire d’enregistrer ces paramètres dans le fichier de fournisseur correspondant au site de l’utilisateur courant. C’est l’objet de cette fonction.

Cette fonction charge en mémoire le fichier INSITU.DOD qui décrit la liste des documents chiffrés utilisables dans Kitchendraw. Cette fonction doit être appelée préalablement à tout appel à l’une des fonctions liées aux documents chiffrés qui sont présentées ci-après.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le document chiffré occupant le rang Rank dans la liste des documents chiffrés disponibles dans KitchenDraw. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction permet d’obtenir l’information spécifiée par le paramètre InfoType concernant le sous-document occupant le rang Rank dans la liste des sous-documents composant le document chiffré de rang DocRank dans la liste des documents chiffrés disponibles dans KitchenDraw. Les valeurs que peut prendre le paramètre InfoType sont décrites dans le tableau ci-dessous :

Cette fonction charge dans MobiScript le catalogue dont le nom de fichier (sans le chemin ni l’extension) est spécifié dans le paramètre CatalogFileName.

Cette fonction enregistre sur disque le catalogue ouvert dans MobiScript. La variable CatalogFileName contient le nom du fichier (sans le chemin ni l’extension) dans lequel le catalogue sera enregistré.

Cette fonction permet de lire certaines informations d’ordre général concernant le catalogue actuellement ouvert dans MobiScript. L’information demandée est spécifiée par le paramètre InfoType dont voici la liste des valeurs :

Cette fonction permet d’écrire certaines informations dans le catalogue actuellement ouvert dans MobiScript. Consultez la fonction MobiScriptCatalogGetInfo pour plus de détails. Attention : l’information Nom de fichier est en lecture seule.

Cette fonction affecte l’utilisateur NewUserIdent à toutes les scènes répertoriées dans le système (c’est-à-dire dans le fichier SCENES.LST) qui « appartiennent » à l’utilisateur CurrentUserIdent.

Cette fonction permet de spécifier si l’on souhaite voir (Show valant Vrai) ou pas (Show valant Faux) le message d’alerte « Appliquer même aux éléments qui avaient des choix différents » qui peut apparaître lors de l’exécution des fonctions du SDK de changement de finitions génériques. Par défaut ces messages apparaissent.

Cette fonction enregistre dans le fichier spécifié par TextFileName (avec chemin d’accès et extension) le texte contenu dans le paramètre TextToBeSaved.

Cette fonction envoie un message Email au destinataire dont l’adresse Email est RecipientAddress ou le nom est RecipientName avec une copie cachée aux destinataires éventuellement renseignés dans le paramètre CC. Le sujet du message est précisé dans le paramètre Subject et le corps du message dans Body. Il est possible d’attacher des fichiers au message en remplissant les paramètres AttachedFilesPathsList et optionnellement de donner un nom plus parlant à ces fichiers en renseignant le paramètre AttachedFilesNamesList. Le paramètre ShowDialog permet de contrôler l’affichage ou pas des messages d’erreur ou d’alerte.

Cette fonction crée un catalogue en mémoire. Le catalogue incorpore les informations du catalogue de base dont le nom (sans chemin ni extension) est spécifié dans le paramètre BaseCatalogFileName. Le paramètre Measurement permet de spécifier l’unité de mesure employée dans le catalogue. Le paramètre CatalogType indique s’il s’agit d’un catalogue standard (CatalogType=0) ou un catalogue de base ou intermédiaire (CatalogType=1). La liste des unités de mesure disponibles est la suivante :

Attention : un catalogue chargé avec cette fonction ne permet pas de générer les vignettes de finitions génériques de famille via la fonction FileExportFamilyFinishImage. Si tel est votre souhait il faut alors utiliser la fonction FileLoadCatalog de la classe Scene.

Cette fonction enregistre le catalogue courant sur disque. La variable CatalogFileName contient le nom du fichier (avec le chemin complet et l’extension) dans lequel le catalogue courant sera enregistré. Attention : si le catalogue est un catalogue de base ou un catalogue intermédiaire (CatalogType=1 lors de la création du catalogue avec la fonction FileNew) alors le nom de fichier doit commencer par un caractère « # ».

Remarque : le modèle et les finitions avec lesquels seront représentés les articles sont ceux de la scène de présentation correspondant au catalogue (voir les fonctions FileLoadCatalogScene et FileSaveCatalogScene de la classe Scene relatives à la scène de présentation).

Cette fonction permet d’exporter la vignette correspondant au modèle spécifié dans FinishTypesList et FinishesList sous la forme d’un fichier .JPG, .BMP, .GIF, .PNG ou .TIF dont le nom (avec le chemin complet et l’extension) est spécifié dans le paramètre ImageFileName. Pour le format .JPG uniquement, il est possible de contrôler le niveau de qualité de l’image par le paramètre JPEGQuality (valeur comprise entre 0 et 100). Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Le paramètre AntiAliasing indique le niveau d’anti-crénelage mis en œuvre pour réduire l’effet d’escalier sur les obliques. Il est déconseillé d’utiliser une valeur d’anti-crénelage supérieure à 3.

Attention : si les vignettes sont générées mais qu’elles sont blanches c'est qu'il manque l'entité 2D "Présentation de finitions" dans le catalogue.

Attention : si les vignettes sont générées mais qu’elles sont blanches c'est qu'il manque l'entité 2D "Présentation de finitions" dans le catalogue.

Cette fonction permet de générer un fichier à partir de la ressource incorporée dans le catalogue courant. Le nom du fichier généré (avec le chemin complet et l’extension) est spécifié dans le paramètre ResourceFileName. Les ressources incorporées sont par exemple les fichiers de textures inscrits dans la colonne « Fichier JPG ou BMP » de la table « Textures » et dont la case « Incorporé » située sur la même ligne est cochée. Cependant, il est envisageable d’incorporer dans un catalogue tout type de fichier (images, son, vidéo, etc.) et de les extraire le moment venu pour s’en servir. Par exemple, les photos des poignées d’un catalogue pourraient être incorporées dans le fichier catalogue. Ensuite, une application ce SDK pourrait se servir de la fonction FileExportResource pour exporter ces photos afin de les afficher dans une « Combo box graphique » de choix de poignée. Le paramètre LineRank qui indique le rang de la ressource à exporter dans la table CATALOGTABLE_RESOURCES peut être obtenu à l’aide de la fonction TableGetLineRankFromName si l’on connaît le nom de celle-ci. Remarque : il est possible d’incorporer un fichier par programme en utilisant la fonction TableSetLineInfo décrite plus loin et en spécifiant le nom du fichier à incorporer (avec le chemin complet et l’extension) dans le paramètre InfoValue. Cette opération est également possible en utilisant la fonction FileImportResource décrite plus loin.

Cette fonction permet de générer le fichier spécifié par le paramètre ResourceFileName (avec le chemin complet et l’extension) à partir de la ressource incorporée dans le catalogue courant portant le même nom que le fichier spécifié par ResourceFileName mais sans le chemin. Pour plus d’informations concernant l’import et l’export des ressources, veuillez vous reporter à la fonction FileExportResource décrite précédemment.

Cette fonction permet d’incorporer le contenu d’un fichier quelconque dans le catalogue courant en tant que ressource. La ressource sera alors visible dans la table CATALOGTABLE_RESOURCES et identifiée par le nom du fichier. Le paramètre IfNewerOnly s’il vaut Vrai permet de n’effectuer réellement l’incorporation du fichier que si celui-ci n’a pas déjà été incorporé ou si sa version incorporée est plus ancienne que la date du fichier. Pour plus d’informations concernant l’import et l’export des ressources, veuillez vous reporter à la fonction FileExportResource décrite précédemment.

Cette fonction permet de générer un fichier contenant les prix des articles du catalogue courant.

Cette fonction permet de mettre à jour les prix des articles du catalogue courant à partir des données d’un fichier dont le nom est passé dans le paramètre PricesFileName. Le format du fichier est le même que celui de la fonction FileExportPrices décrite plus haut.

Cette fonction permet de savoir si un catalogue est chargé en mémoire et donc s’il est possible d’appeler les fonctions qui s’appliquent au catalogue chargé en mémoire (la plupart des fonctions de la classe Catalog).

Cette fonction permet de lire les informations d’ordre général concernant le catalogue courant (nom du catalogue, code du catalogue, catalogue de base utilisé, etc.). En fait, ces informations sont celles qui sont présentes dans la boîte de dialogue « Catalogue | Informations » de Mobiscript. Attention, les informations dépendantes de la langue comme le nom, le nom du catalogue de base sont retournées dans la langue courante. L’information demandée est spécifiée par le paramètre InfoType dont voici la liste des valeurs :

Cette fonction permet d’écrire les informations d’ordre générales concernant le catalogue courant. Consultez la fonction GetInfo pour plus de détails. Attention : l’information Unité de mesure est en lecture seule.

Elle retourne -1 si la valeur de ClusterRank est invalide.

Elle retourne -1 si la valeur de ClusterRank ou de LineRank est invalide.

Elle retourne -1 si la valeur de ClusterRank ou de LineRank est invalide.

Elle retourne une chaîne vide si la valeur de ClusterRank ou de LineRank est invalide.

Cette fonction permet d’écrire la chaîne de caractères InfoValue dans la cellule correspondant à la colonne de rang InfoColumnRank (numéroté à partir de 1) et à la ligne de rang LineRank de la grappe ClusterRank de la table Table du catalogue courant. Attention, les informations dépendantes de la langue comme le nom ou la description doivent être fournies dans la langue courante. Si le paramètre ClusterRank vaut CLUSTER_FROM_ITEM (c’est-à-dire 0), alors le paramètre LineRank est considéré comme étant le rang dans la table et non plus le rang dans le cluster.

Elle retourne une chaîne vide si la valeur de ClusterRank ou de LineRank est invalide.

Cette fonction permet de retrouver dans la table Table le rang de la ligne dont le code est identique à Code. La recherche s’effectue en partant de la ligne LineRank de la grappe ClusterRank et dans le sens croissant des rangs de lignes si BackScan vaut 0 (dans le sens de la fin vers le début si BackScan vaut True). Remarque : pour retrouver le rang d’un article par son numéro de référence, il faut utiliser la fonction TableGetLineRankFromName décrite ci-après.

Cette fonction permet de retrouver dans la table Table le rang de la ligne dont le nom est identique à Name. La recherche s’effectue en partant de la ligne LineRank de la grappe ClusterRank et dans le sens croissant des rangs de lignes si BackScan vaut 0 (dans le sens de la fin vers le début si BackScan vaut True). Attention, le paramètre Name n’est recherché que dans la langue courante.

Cette fonction permet d’obtenir le nombre de lignes contenues dans la grappe ClusterRank de la table Table.

Indiquer à la fonction le nombre de colonne de la table grâce au paramètre ColumnNb permet d’accélérer son traitement. Cela peut s’avérer important si la fonction doit être appelée souvent. Si le paramètre ColumnNb vaut zéro, la détermination du nombre de colonnes de la table est effectué à l’intérieur de la fonction.

Attention, le rang retourné est le rang dans la table complète. Il peut ne pas correspondre au numéro de ligne affiché dans la première colonne du tableau dans MobiScript si vous avez coché la case « Gauche » ou la case « Droit » dans la table CATTABLE_ARTICLES, CATTABLE_PRICES, CATTABLE_PURCHASEPRICES ou CATTABLE_REFERENCES. Remarque : Cette fonction peut être utile lors de l’écriture de fonctions d’extension de MobiScript (par exemple un assistant à l’écriture de scripts) afin de savoir à quelle ligne doit s’appliquer la fonction.

La fonction retourne -1 si vous avez coché la case « Gauche » ou la case « Droit » dans la table CATTABLE_ARTICLES, CATTABLE_PRICES, CATTABLE_PURCHASEPRICES ou CATTABLE_REFERENCES. Remarque : Avec la fonction TableSelectionGetLinesNb, cette fonction peut être utile lors de l’écriture de fonctions d’extension de MobiScript pour balayer les lignes sélectionnées dans la table active afin de leur appliquer un traitement particulier.

La fonction retourne 0 si vous avez coché la case « Gauche » ou la case « Droit » dans la table CATTABLE_ARTICLES, CATTABLE_PRICES, CATTABLE_PURCHASEPRICES ou CATTABLE_REFERENCES. Remarque : Avec la fonction TableSelectionGetFirstLineRank, cette fonction peut être utile lors de l’écriture de fonctions d’extension de MobiScript pour balayer les lignes sélectionnées dans la table active afin de leur appliquer un traitement particulier.

Cette fonction permet de retrouver dans la table « Finitions de modèle » le rang de la grappe défini par le modèle ModelRank et le type de finition FinishType. Le paramètre ModelRank représente le rang du modèle concerné dans la table « Modèles ». Le paramètre FinishType doit être l’une des chaînes de caractères que l’on trouve dans la boîte à options « Type de finition » de la table « Finitions de modèle ». Attention, ces chaînes de caractères dépendent de la langue courante. Le rang de la grappe retourné par cette fonction est destiné à servir de paramètre pour les fonctions de cette classe qui requièrent ce type de paramètre.

Cette fonction permet de retrouver dans la table « Poignées de modèle » le rang de la grappe défini par le modèle Model et le type de poignée HandleType. Le paramètre ModelRank représente le rang du modèle concerné dans la table « Modèles ». Le paramètre HandleType doit être l’une des chaînes de caractères que l’on trouve dans la boîte à options « Type de poignée » de la table « Poignées de modèle ». Attention, ces chaînes de caractères dépendent de la langue courante. Le rang de la grappe retourné par cette fonction est destiné à servir de paramètre pour les fonctions de cette classe qui requièrent ce type de paramètre.

Cette fonction permet de retrouver dans la table « Finitions de famille » le rang de la grappe défini par la famille FamilyRank et le type de finition FinishType. Le paramètre FamilyRank représente le rang de la famille concernée dans la table « Familles ». Le paramètre FinishType doit être l’une des chaînes de caractères que l’on trouve dans la boîte à options « Type de finition » de la table « Finitions de famille ». Attention, ces chaînes de caractères dépendent de la langue courante. Le rang de la grappe retourné par cette fonction est destiné à servir de paramètre pour les fonctions de cette classe qui requièrent ce type de paramètre.

Cette fonction permet d’ajouter à la table du dictionnaire de traduction du catalogue courant tous les textes (noms de chapitre, noms et descriptions de bloc, noms et descriptions de modèle, finitions, etc.) qui ont été ajoutés dans ce catalogue depuis la dernière mise à jour et de supprimer tous les textes qui ont été enlevés du catalogue. Une mise à jour est également effectuée automatiquement lors de l’ouverture de la fenêtre de traduction d’un catalogue dans MobiScript.

Cette fonction permet d’écrire dans la table du dictionnaire de traduction du catalogue courant la chaîne de caractères Text représentant la traduction dans la langue défini par LanguageCode de la chaîne de caractères présente à la ligne LineRank.

Cette fonction permet de lire dans la table du dictionnaire de traduction du catalogue courant la chaîne de caractères représentant la traduction dans la langue défini par LanguageCode de la chaîne de caractères présente à la ligne LineRank.

Cette fonction permet d’écrire dans la table du dictionnaire de traduction du catalogue courant la chaîne de caractères TranslatedString représentant la traduction dans la langue défini par LanguageCode de la chaîne de caractères KeyString.

Les fonctions AppliCatxxx de la classe Catalog décrites ci-dessous ne sont utiles que dans le cadre du développement de fonctions d’extensions pour des AppliCats (contrôles personnalisés ou moteur de règles personnalisé).

Si VariableName est vide, la fonction retourne une chaîne de caractères contenant toutes les variables de l’AppliCat avec leur contenu.

Cette fonction permet d’écrire la valeur contenu dans le paramètre Value dans la variable dont le nom est indiqué dans VariableName et appartenant à l’AppliCat de rang AppliCatRank dans le catalogue courant.

Voici un exemple : imaginons que la colonne « Valeur » d’un contrôle d’un AppliCat du catalogue courant contienne la chaîne de caractères $i="0" $c="FRA" $n="Français" $fn="france.jpg"| $i="1" $c="ENG" $n="English" $fn="uk.jpg"| $i="2" $c="DEU" $n="Deutch" $fn="germany.jpg"|  représentant un ensemble de trois choix à placer dans une liste. L’appel de la fonction avec des paramètres OptionRank valant « 2 » et Keyword valant « $c » retournerait un résultat valant « ENG ». Si Keyword est vide, la fonction retourne une chaîne de caractères avec le contenu du choix de liste OptionRank (avec tous ces éléments d’information et les valeurs correspondantes) du contrôle de rang ControlRank de l’AppliCat de rang AppliCatRank dans le catalogue courant. Si, en plus, OptionRank est égal à l’index de base moins un (par défaut 0), la fonction retourne tout le contenu de la cellule « Valeur » du contrôle.

Cette fonction permet d’écrire la valeur contenu dans le paramètre Value dans l’élément d’information dont le nom est indiqué dans Keyword et appartenant au choix de liste de rang OptionRank du contrôle de rang ControlRank de l’AppliCat de rang AppliCatRank dans le catalogue courant.

Voici un exemple : imaginons que la colonne « Attributs » d’un contrôle d’un AppliCat du catalogue courant contienne la chaîne de caractères :  width=250 height=100  L’appel de la fonction avec le paramètre AttributName valant « height » retournerait un résultat valant « 100 ». Si AttributName est vide, la fonction retourne une chaîne de caractères avec tout le contenu de la cellule « Attributs » du contrôle.

Cette fonction permet d’écrire la valeur contenu dans le paramètre Value dans l’attribut dont le nom est indiqué dans AttributName et appartenant au contrôle de rang ControlRank de l’AppliCat de rang AppliCatRank dans le catalogue courant.

Si StyleName est vide, la fonction retourne une chaîne de caractères avec tout le contenu de la cellule « Style » du contrôle.

Cette fonction permet d’écrire la valeur contenu dans le paramètre Value dans l’élément de style dont le nom est indiqué dans StyleName et appartenant au contrôle de rang ControlRank de l’AppliCat de rang AppliCatRank dans le catalogue courant.

Si VariableName est vide, la fonction retourne une chaîne de caractères avec tout le contenu de la cellule « Style » du contrôle.

Cette fonction permet d’écrire la valeur contenu dans le paramètre Value dans l’élément de style dont le nom est indiqué dans VariableName et appartenant au contrôle de rang ControlRank de l’AppliCat de rang AppliCatRank dans le catalogue courant.

Cette fonction crée une scène en mémoire. Le paramètre Measurement permet de spécifier l’unité de mesure employée dans la scène. La liste des unités de mesure disponibles est la suivante :

Cette fonction charge en mémoire la scène dont le nom (avec le chemin complet) est spécifié dans le paramètre SceneFileName. Pour une application donnée, seule une scène peut être chargée en mémoire à la fois. La scène chargée est alors appelée la scène courante.

Cette fonction enregistre la scène courante sur disque. La variable SceneFileName contient le nom du fichier (avec le chemin complet) dans lequel la scène courante sera enregistrée.

Cette fonction charge un catalogue en mémoire mais sans le convertir au format compréhensible par MobiScript. Cette fonction est plus rapide que la fonction FileLoad de la classe Catalog et permet d'accéder aux informations relatives aux finitions génériques de famille comme leur nom ou leur vignette (via la fonction FileExportFamilyFinishImage). Par contre, un catalogue chargé de cette manière n’étant pas au « format MobiScript », il ne faut pas tenter de lire ou d’écrire des informations à l’aide des fonctions de la classe Catalog du type Tablexxx. Si on met SessionId à 0, alors on charge le catalogue dans la zone globale afin de partager le catalogue entre toutes les sessions.

Cette fonction charge en mémoire la scène de présentation correspondant au catalogue dont le nom (avec le chemin complet) est spécifié dans le paramètre CatalogFileName. La scène de présentation d’un catalogue contient les spécifications de dessin des vignettes du catalogue. Elle est créée dans le répertoire des catalogues lorsqu’on valide l’une des boîtes de dialogue de MobiScript qui définissent la façon dont les vignettes doivent être dessinées (commandes du sous-menu « Catalogue | Vignettes » ). Elle porte le même nom que le catalogue. Si aucune scène de présentation n’existe pour le catalogue, une scène vide est créée en mémoire. Une fois chargée en mémoire la scène de présentation devient la scène courante. Vous pouvez ensuite agir sur cette scène à l’aide des fonctions de la classe Scene décrites ci-après puis éventuellement l’enregistrer. Vous devez charger la scène de présentation avant d’exporter des vignettes du catalogue si vous voulez qu’un modèle particulier de façade, de finition ou de poignée soit appliqué.

Cette fonction enregistre sur disque la scène de présentation correspondant au catalogue courant. La variable SceneFileName contient le nom du fichier (avec le chemin complet) dans lequel la scène de présentation sera enregistrée.

Cette fonction permet d’exporter une nomenclature (liste de constituants) de la scène courante sous la forme d’un fichier texte dont le nom (avec le chemin complet) est spécifié dans le paramètre ListFileName. Le paramètre ListType permet de spécifier le type de nomenclature à générer.

Cette fonction permet d’exporter le contenu de la scène en cours sous la forme d’un fichier XML dont le nom (avec le chemin complet) est spécifié dans le paramètre ListFileName. S’il vaut Vrai le paramètre Factorized indique que les objets identiques doivent être représentées par un seul « tag » mais avec une information de quantité.

Cette fonction permet d’exporter la vue en cours (vue de dessus, élévation ou perspective) sous la forme d’un fichier .JPG, .BMP, .GIF, .PNG ou .TIF dont le nom (avec le chemin complet) est spécifié dans le paramètre ImageFileName. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Le paramètre BackGroungColor permet de définir la couleur de fond de l’image. Il s’exprime sous la forme d’une chaîne de caractères représentant les valeurs décimales (de 0 à 255) de la composante rouge, puis verte puis bleu de la couleur de fond, séparées par une virgule comme dans l’exemple suivant : « 255,128,0 ». Si le paramètre BackGroungColor est une chaîne vide, la couleur de fond sera blanche. Si le paramètre Transparent est positionné à vrai, la couleur de fond sera définie comme transparente (uniquement pour les formats .GIF, .PNG et .TIF). Pour le format .JPG uniquement, il est possible de contrôler le niveau de qualité de l’image par le paramètre JPEGQuality (valeur comprise entre 0 et 100). Le paramètre AntiAliasing indique le niveau d’anti-crénelage mis en œuvre pour réduire l’effet d’escalier sur les obliques. Il est déconseillé d’utiliser une valeur d’anti-crénelage supérieure à 3.

Cette fonction permet d’exporter une image de visualisation des objets sélectionnés de la vue en cours (vue de dessus, élévation ou perspective) sous la forme d’un fichier .BMP, .GIF ou .PNG dont le nom (avec le chemin complet) est spécifié dans le paramètre Image. Cette image ne donne pas une représentation réaliste de la vue en cours mais permet de visualiser, grâce à une opération de superposition d’image, quels sont les objets sélectionnés. Si le format .BMP est choisi, les carrés de sélection sont dessinés en blanc sur fond noir. Si le format .GIF ou .PNG est choisi, les carrés de sélection sont dessinés en noir sur fond transparent. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Normalement, l’ « image de la sélection » doit être générée avec la même résolution que l’image servant à représenter la scène.

Cette fonction permet d’exporter une image de visualisation de l’objet actif de la vue en cours (vue de dessus, élévation ou perspective) sous la forme d’un fichier .BMP, .GIF ou .PNG dont le nom (avec le chemin complet) est spécifié dans le paramètre Image. Cette image ne donne pas une représentation réaliste de la vue en cours mais permet de visualiser, grâce à une opération de superposition d’image, quel est l’objet actif de la scène. Si le format .BMP est choisi, les carrés de sélection sont dessinés en blanc sur fond noir. Si le format .GIF ou .PNG est choisi, les carrés de sélection sont dessinés en noir sur fond transparent. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Normalement, l’ « image de l’objet actif » doit être générée avec la même résolution que l’image servant à représenter la scène.

Cette fonction permet d’exporter une image de visualisation des contours des objets sélectionnés de la vue en cours (vue de dessus ou élévation) sous la forme d’un fichier .BMP, .GIF ou .PNG dont le nom (avec le chemin complet) est spécifié dans le paramètre ImageFileName. Cette image ne donne pas une représentation réaliste de la vue en cours mais permet de visualiser, grâce à une opération de superposition d’image, le déplacement à la souris de la sélection. Si le format .BMP est choisi, les traits de contour sont dessinés en blanc sur fond noir. Si le format .GIF ou .PNG est choisi, les traits de contour sont dessinés en noir sur fond transparent. Les paramètres PixelXRot et PixelYRot représentent la position en coordonnées image (pixels) du point de pivot de l’éventuelle rotation (par exemple la position du pointeur de la souris) et le paramètre Angle permet de spécifier en degrés l’angle de rotation des contours. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée, qui, normalement, doit être identique à la résolution de l’image servant à représenter la scène.

Cette fonction permet d’exporter la vignette correspondant à l’article de référence ArticleRef et de sens HandingType dans le catalogue CatalogFileName (nom de fichier court sans extension).

Cette fonction permet d’exporter les vignettes correspondant aux blocs listés dans BlocksList avec le sens HandingType dans le catalogue CatalogFileName (nom de fichier court sans extension). BlocksList est une chaîne de caractères qui liste les rang des blocs dans le catalogue, séparés par une virgule (exemple : « 1,2,3,8,10,11,12,15,16 »). Les blocs adoptent les finitions génériques de la scène de présentation associée au catalogue CatalogFileName. Si Opened vaut 0, les blocs sont représentés dans l’état fermé ; sinon, ils sont représentés dans l’état ouvert. Le paramètre ViewMode indique quelle vue de l’article on souhaite obtenir (voir fonction FileExportCatalogImage ci-dessus pour plus d’information). Les vignettes sont générées sous la forme de fichiers .JPG, .BMP, .GIF, .PNG, ou .TIF de résolution XRes x YRes dont le nom est le rang du bloc tel qu’il figure dans BlocksList (avec le chemin complet et l’extension spécifiés dans le paramètre ImageFileName). Le paramètre BackGroungColor permet de définir la couleur de fond de l’image. Il s’exprime sous la forme d’une chaîne de caractères représentant les valeurs décimales (de 0 à 255) de la composante rouge, puis verte puis bleu de la couleur de fond, séparées par une virgule comme dans l’exemple suivant : « 255,128,0 ». Si le paramètre BackGroungColor est une chaîne vide, la couleur de fond sera blanche. Si le paramètre Transparent est positionné à vrai, la couleur de fond sera définie comme transparente (uniquement pour les formats .GIF, .PNG et .TIF). Pour le format .JPG uniquement, il est possible de contrôler le niveau de qualité de l’image par le paramètre JPEGQuality (valeur comprise entre 0 et 100 avec une valeur recommandée de 75). Le paramètre AntiAliasing indique le niveau d’anti-crénelage mis en œuvre pour réduire l’effet d’escalier sur les obliques. Il est déconseillé d’utiliser une valeur d’anti-crénelage supérieure à 3 (voir fonction FileExportCatalogImage ci-dessus pour plus d’information).

Cette fonction permet d’exporter une image de visualisation du contour de l’article de référence ArticleRef et de sens HandingType dans le catalogue CatalogFileName (nom de fichier court sans extension). Cette image de visualisation correspond à la vue en cours de la scène courante (vue de dessus, élévation ou perspective). Elle est exportée sous la forme d’un fichier .BMP, .GIF ou .PNG dont le nom (avec le chemin complet) est spécifié dans le paramètre ImageFileName. Cette image ne donne pas une représentation réaliste de l’article mais permet de visualiser, grâce à une opération de superposition d’image, le déplacement à la souris du contour de l’article à poser en « drag & drop ». Si le format .BMP est choisi, les traits de contour sont dessinés en blanc sur fond noir. Si le format .GIF ou .PNG est choisi, les traits de contour sont dessinés en noir sur fond transparent. Les dimensions appliquées à l’article qui peuvent être différentes des dimensions par défaut sont définies dans les paramètres Width, Depth et Height. Si Opened vaut 0, l’article est représenté dans l’état fermé ; sinon, il est représenté dans l’état ouvert pour peu qu’un état ouvert ait été spécifié dans le catalogue. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Normalement, l’image de contour doit être générée avec la même résolution que l’image servant à représenter la scène. Le point d’origine est au centre de l’image de contour. Le paramètre Angle permet de spécifier en degrés un éventuel angle de rotation de l’article effectué durant l’opération de « drag & drop ».

Cette fonction permet d’exporter la vignette représentant un bloc généré par un script. Tout d’abord, la fonction crée un bloc temporaire dans le catalogue CatalogFileName (nom de fichier sans extension) à partir du script Script. Ensuite, elle ajoute un article à ce bloc. Les dimensions de cet article sont précisées par les paramètres Width, Depth et Height et le sens par le paramètre HandingType. Si Opened vaut 0, l’article est représenté dans l’état fermé ; sinon, il est représenté dans l’état ouvert. Le paramètre ViewMode indique quelle vue de l’article on souhaite obtenir (voir la fonction FileExportCatalogImage ci-dessus pour plus de détails). L’article adopte les finitions génériques de la scène de présentation associée au catalogue CatalogFileName. La vignette est générée sous la forme d’un fichier .JPG, .BMP, GIF, PNG ou .TIF de résolution XRes x YRes dont le nom (avec le chemin complet) est spécifié dans le paramètre ImageFileName. Le paramètre BackGroungColor permet de définir la couleur de fond de l’image. Il s’exprime sous la forme d’une chaîne de caractères représentant les valeurs décimales (de 0 à 255) de la composante rouge, puis verte puis bleu de la couleur de fond, séparées par une virgule comme dans l’exemple suivant : « 255,128,0 ». Si le paramètre BackGroungColor est une chaîne vide, la couleur de fond sera blanche. Si le paramètre Transparent est positionné à vrai, la couleur de fond sera définie comme transparente (uniquement pour les formats .GIF, .PNG et .TIF). Pour le format .JPG uniquement, il est possible de contrôler le niveau de qualité de l’image par le paramètre JPEGQuality (valeur comprise entre 0 et 100 avec une valeur recommandée de 75). Le paramètre AntiAliasing indique le niveau d’anti-crénelage mis en œuvre pour réduire l’effet d’escalier sur les obliques (voir la fonction FileExportCatalogImage ci-dessus pour plus de détails).

Cette fonction est similaire à la fonction FileExportCatalogImageFromScript décrite ci-dessus à l’exeption du fait qu’elle utilise la scène courante et non pas une scène vide créée pour l’occasion. Il sera ainsi possible de charger, préalablement au lancement de cette fonction, une scène contenant déjà des objects (un studio) afin que l’objet issu du script apparaisse en situation. Les paramètres X, Y, Altitude, AltitudeType et OXYAngle permettent alors de spécifier la position et l’orientation de l’objet dans la scène. Le paramètre AdjustedZoom quant à lui permet de lancer une opération de « Zoom Ajusté » avant la génération et l’export de l’image.

Cette fonction permet d’obtenir les points de sélection c’est-à-dire les points de contour appartenant aux objets sélectionnés de la scène courante. Cette liste de points de sélection correspond à la vue en cours de la scène courante (vue de dessus, élévation ou perspective). Elle est retournée sous la forme d’une chaîne de caractères listant les différents points. Les coordonnées des points de sélection sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Les coordonnées des points sont séparées par une virgule et les points par un point-virgule comme indiqué dans l’exemple ci-dessous : « x1,y1,z1;x2,y2,z2;….;xn,yn,zn;…», où « xn », « yn » et « zn » sont les coordonnées du nième point de sélection.

Cette fonction permet d’obtenir les polylignes constituant le contour des objets sélectionnés de la scène courante. Cette liste de polylignes de visualisation correspond à la vue en cours de la scène courante (vue de dessus, élévation ou perspective). Elle est retournée sous la forme d’une chaîne de caractères listant les différentes polylignes. Les coordonnées des points des polylignes sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Les coordonnées des points sont séparées par une virgule, les points par un point-virgule et les polylignes par deux points (« : »), comme indiqué dans l’exemple ci-dessous : « p1x1,p1y1,p1z1;p1x2,p1y2,p1z2;….;p1xn,p1yn,p1zn;…:p2x1,p2y1,p2z1;p2x2,p2y2,p2z2;….;p2xn,p2yn,p2zn;….», où « pmxn », « pmyn » et « pmzn » sont les coordonnées du nième point de la mième polyligne. Les paramètres PixelXRot et PixelYRot représentent la position en coordonnées image (pixels) du point de pivot de l’éventuelle rotation (par exemple la position du pointeur de la souris) et le paramètre Angle permet de spécifier en degrés l’angle de rotation des contours.

Cette fonction permet d’obtenir les polylignes constituant le contour de l’article de référence ArticleRef et de sens HandingType dans le catalogue CatalogFileName (nom de fichier court sans extension). Cette liste de polylignes de visualisation correspond à la vue en cours de la scène courante (vue de dessus, élévation ou perspective). Elle est retournée sous la forme d’une chaîne de caractères listant les différentes polylignes. Les coordonnées des points des polylignes sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Les coordonnées des points sont séparées par une virgule, les points par un point-virgule et les polylignes par deux points (« : »), comme indiqué dans l’exemple ci-dessous : « p1x1,p1y1,p1z1;p1x2,p1y2,p1z2;….;p1xn,p1yn,p1zn;…:p2x1,p2y1,p2z1;p2x2,p2y2,p2z2;….;p2xn,p2yn,p2zn;….», où « pmxn », « pmyn » et « pmzn » sont les coordonnées du nième point de la mième polyligne. Les dimensions appliquées à l’article qui peuvent être différentes des dimensions par défaut sont définies dans les paramètres Width, Depth et Height. Si Opened vaut 0, le contour de l’article est représenté dans l’état fermé ; sinon, il est représenté dans l’état ouvert pour peu qu’un état ouvert ait été spécifié dans le catalogue. Le paramètre Angle permet de spécifier en degrés un éventuel angle de rotation de l’article effectué durant l’opération de « drag & drop ».

Cette fonction permet de générer un fichier de commande listant tous les articles de la scène courante appartenant à l’un des catalogues attachés au fournisseur identifié par SupplierId. Les paramètres DeliveryYear et DeliveryWeek sont indiqués dans le fichier de commande si le format de celui-ci a prévu une place pour eux. Le nom du fichier généré (y compris le chemin complet et l’extension) est spécifié dans le paramètre OrderFileName.

Cette fonction exécute une opération de restauration de scène c’est-à-dire la copie du fichier scène dans le répertoire des scènes (avec attribution d’un nouveau nom de fichier) puis son intégration dans le fichier SCENES.LST afin que cette scène puisse être vue dans la liste des scènes de la boîte de dialogue « Fichier | Ouvrir ». Le paramètre SceneFileName (avec le chemin complet et l’extension .SCN) spécifie le fichier scène à intégrer et UserIdent indique à quel utilisateur enregistré elle doit être affectée. Une opération de restauration

Cette fonction retire la scène spécifiée par son nom de fichier SceneFileName du fichier SCENES.LST afin qu’elle ne soit plus visible dans la liste des scènes de la boîte de dialogue « Fichier | Ouvrir ». En outre, si le paramètre DeleteFile vaut Vrai alors le fichier spécifié par SceneFileName est supprimé du répertoire des scènes.

Cette fonction annule la dernière opération effectuée. Appeler cette fonction deux fois de suite équivaut à ne rien faire ; il n’y a qu’un seul niveau d’annulation.

Cette fonction grise temporairement la commande d’annulation (jusqu’à ce qu’une opération « annulable » soit effectuée). Cette fonction est utilisée lors du développement de plugins qui modifient la scène à la suite d’un évènement sur un objet (par exemple pose, suppression, modification, etc.). Si la scène a été modifiée suite à un évènement et que cet évènement est annulé par la suite on pourrait laisser la scène dans un état incohérent. Il serait alors plus prudent d’empêcher l’annulation de cet évènement.

Cette fonction supprime les objets sélectionnés de la scène courante.

Cette fonction supprime l’objet actif de la scène puis établit en tant qu’objet actif l’objet de la scène placé juste avant chronologiquement parlant comme le ferait l’appui sur la touche Retour Arrière (aussi connu sous le nom de BackSpace) dans KitchenDraw.

Cette fonction ajoute dans la scène courante l’article de référence ArticleRef et de sens HandingType pris dans le catalogue CatalogFileName (nom court avec ou sans extension). L’article est posé avec les dimensions Width, Depth et Height de telle sorte que son point d’origine dans le plan horizontal se trouve sur le point de coordonnées X, Y et que son orientation dans la scène fasse un angle de OXYAngle degrés par rapport à l’axe horizontal. L’altitude de l’article c’est-à-dire sa position suivant l’axe verticale est défini par le paramètre Altitude qui spécifie une valeur et par le paramètre AltitudeType qui indique si Altitude précise la position du bas de l’article (ALTITUDETYPE_ON = 0) ou du sommet de l’article (ALTITUDETYPE_UNDER = 1). Attention : il est possible de spécifier que l’altitude de pose de l’objet soit la valeur par défaut défini dans le catalogue (au niveau du bloc) en donnant au paramètre AltitudeType la valeur ALTITUDETYPE_DEFAULT = -1. Si l’indicateur Opened est positionné à 1, l’objet sera posé dans l’état « ouvert ». Si l’indicateur Percussion est positionné à 1, la fonction effectue un ancrage automatique en fonction des percussions éventuelles avec les autres objets de la scène courante. Si l’indicateur Pool est positionné à 1, l’objet ne sera pas visible dans les vues de dessus, d’élévation et de perspective. Par contre Il figurera dans la pioche c’est-à-dire dans la liste des objets placés en mode chiffrage (sans information de position) et susceptibles d’être positionnés manuellement dans un second temps. Si vous utilisez cette fonction avec l’indicateur Pool positionné à 1, les informations X, Y et Altitude seront ignorées.

Cette fonction a la même fonction que la fonction décrite précédemment (EditPlaceObject) à la différence près que la position du point d’origine de l’objet (PixelX et PixelY) est exprimée en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Si le mode de visualisation est VIEWMODE_2D, PixelX et PixelY représentent la position du point d’origine de l’objet dans le plan horizontal. Si le mode de visualisation est VIEWMODE_ELEVATION ou VIEWMODE_REALELEVATION, PixelX et PixelY représentent la position du point d’origine de l’objet dans le plan d’élévation courant. Pour les autres paramètres, veuillez vous reporter à la fonction précédente EditPlaceObject.

Cette fonction commence par effacer les objets linéaires du même type (plinthe, plan de travail, moulure de plan de travail, cache-lumière, corniche) que l’article ArticleRef qui se trouvent déjà dans la scène (si ArticleRef est vide et Place vaut 0, tous les objets linéaires de la scène sont effacés quelque soit leur type). Ensuite, si le paramètre Place vaut 1, la fonction crée un ou plusieurs gabarits suivant les objets présents dans la scène courante et du type (plinthe, plan de travail, moulure de plan de travail, cache-lumière, corniche) de l’objet linéaire à poser. L’article linéaire de référence ArticleRef pris dans le catalogue CatalogFileName (nom de fichier sans chemin d’accès avec ou sans extension) est ensuite posé le long du ou des gabarits générés et dans les finitions précisées dans FinishesList.

Cette fonction ajoute un « article libre », c’est-à-dire un article n’appartenant à aucun catalogue, dans la scène courante. Les paramètres qui définissent l’article à créer sont les suivants : -        SupplierId : l’identifiant du fournisseur auquel il sera affecté, -        ArticleRef : la reference de l’article, -        HandingType : son type de ferrage ou de sens (voir fonction FileExportCatalogImage ci-dessus pour plus d’information), -        Designation : nom court sur 30 caractères maximum, -        Description : nom long non limité en nombre de caractères et qui apparaîtra sur le devis, -        UnitPurchasePrice : prix d’achat unitaire HT, -        UnitSalesPrice : prix de vente unitaire HT ou TTC en fonction du paramètre suivant, -        VATIncluded : indique si le prix de vente ci-dessus est HT (valeur à 0) ou TTC (valeur à 1), -        Quantity : quantité (avec éventuellement des décimales), -        HeadingRank : rang de la rubrique de la scène à laquelle l’article sera rattaché.

Cette fonction remplace tous les objets sélectionnés de la scène courante par l’article de référence ArticleRef et de sens HandingType pris dans le catalogue CatalogFileName (nom court avec ou sans extension). L’article se substituant aux objets sélectionnés est posé avec les dimensions Width, Depth et Height et à l’emplacement exact et avec la même orientation que les objets sélectionnés.

Cette fonction sélectionne tous les objets de la scène courante.

Cette fonction inverse l’état de sélection de tous les objets de la scène courante. Ainsi, les objets sélectionnés deviennent non sélectionnés et réciproquement.

Cette fonction sélectionne tous les objets de la scène courante qui sont complètement inclus dans le rectangle défini par les deux points PixelX1, PixelY1 et PixelX2, PixelY2 exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Si l’indicateur MultipleSelection est positionné à 1, les objets éventuellement déjà sélectionnés le resteront.

où, x1 = coordonnée x du point magnétique projeté dans le plan de la vue en cours (vue de dessus, plan d’élévation) exprimé en unités de la scène, y1 = coordonnée y du point magnétique projeté dans le plan de la vue en cours (vue de dessus, plan d’élévation) exprimé en unités de la scène, x2 = coordonnée x du point magnétique projeté dans le plan de la vue en cours (vue de dessus, plan d’élévation) exprimé en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY, y2 = coordonnée y du point magnétique projeté dans le plan de la vue en cours (vue de dessus, plan d’élévation) exprimé en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY, x3 = coordonnée x du point magnétique exprimé en unités de la scène, y3 = coordonnée y du point magnétique exprimé en unités de la scène, z3 = coordonnée z du point magnétique exprimé en unités de la scène.

Cette fonction copie dans le presse-papier le contenu du tableau de chiffrage courant. Il pourra ensuite être collé dans Excel ou autre. Cette fonction n’effectue cette opération que si l’on se trouve en « vue chiffrage ».

Cette fonction provoque la translation et/ou la rotation des objets sélectionnés de la scène courante. L’axe de translation est définie par le vecteur en coordonnées scène ayant pour origine le point (SceneXOrig, SceneYOrig, SceneZOrig) et pour extrémité le point (SceneXExt, SceneYExt, SceneZExt). La valeur (longueur) de la translation est définie par le paramètre Distance exprimé en unités de mesure de la scène. Si le paramètre Distance est égal à 0, la valeur (longueur) de la translation est définie par la distance entre les deux points dont les coordonnées sont passées en paramètres. Les rotations sont définies par les différences entre les angles OXYAngleExt et OXYAngleOrig, OYZAngleExt et OYZAngleOrig et enfin OZXAngleExt et OZXAngleOrig. Si l’indicateur Duplicate est positionné à 1, la fonction n’efface pas les objets sélectionnés situés à leur position d’origine. Il y a alors ajout de nouveaux objets dans la scène courante. Si l’indicateur Percussion est positionné à 1, la fonction effectue un ancrage automatique en fonction des percussions éventuelles avec les autres objets de la scène courante.

Cette fonction provoque la translation et/ou la rotation des objets sélectionnés de la scène courante. L’axe de la translation est définie par le vecteur en coordonnées pixel ayant pour origine le point (PixelXOrig, PixelYOrig) et pour extrémité le point (PixelXExt, PixelYExt). La valeur (longueur) de la translation est définie par le paramètre Distance exprimé en unités de mesure de la scène. Si le paramètre Distance est égal à 0, la valeur (longueur) de la translation est définie par la distance entre les deux points dont les coordonnées sont passées en paramètres. La rotation dans le plan horizontale est définie par la différence entre les angles OXYAngleExt et OXYAngleOrig. Si l’indicateur Duplicate est positionné à 1, la fonction n’efface pas les objets situés à leur position d’origine. Il y a alors ajout de nouveaux objets dans la scène courante. Si l’indicateur Percussion est positionné à 1, la fonction effectue un ancrage automatique en fonction des percussions éventuelles avec les autres objets de la scène courante.

Cette fonction provoque la rotation des objets sélectionnés de la scène courante dans un ou plusieurs des 3 plans de rotation. Cette rotation s’effectue pour tous les objets sélectionnés autour du même pivot situé au centre du parallélépipède englobant tous les objets sélectionnés.

Cette fonction lance l’opération de génération automatique de cotes sur les objets sélectionnés de la scène. Si aucun objet n’est sélectionné, la génération des cotes s’effectue pour tous les objets de la scène.

Cette fonction place les objets sélectionnés de la scène dans leur état « ouvert ».

Cette fonction place les objets sélectionnés de la scène dans leur état « fermé ».

Cette fonction cache les objets sélectionnés de la scène.

Cette fonction montre les objets sélectionnés de la scène qui étaient cachés.

Cette fonction permet de récupérer l’état de sélection global de la scène courante. Cela peut servir en particulier pour faire une sauvegarde de l’état de sélection de la scène avant un traitement qui pourrait venir altérer cet état de sélection. Par exemple, un traitement qui voudrait supprimer certains objets de la scène devra préalablement sélectionner ces objets perdant ainsi l’état de sélection existant. Si l’état de sélection de la scène a été sauvegardé dans une chaîne de caractères, il pourra être restauré à l’issue du traitement grâce à la commande SelectionSetList décrite ci-après.

Cette fonction sélectionne les objets de la scène courante dont les identifiants figurent dans le paramètre SelectionList. Ce paramètre est une chaîne de caractères listant les identifiants des objets à sélectionner séparés par une virgule. Il peut être le résultat de la commande SelectionGetList décrite précédemment.

Cette fonction permet d’obtenir l’information spécifiée par le paramètre KeyWord concernant l’objet dont l’identifiant est ObjectId. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante. Les valeurs que peut prendre le paramètre KeyWord sont décrites dans le document « Réalisation de modèles de documents WORD ». Tous les mots clé de type « Objet »peuvent être employés.

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ de l’objet dont l’identifiant est ObjectId spécifié par le paramètre KeyWord. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante. Les valeurs que peut prendre le paramètre KeyWord sont décrites dans le document « Réalisation de modèles de documents WORD ». Tous les mots clé de type « Objet » peuvent être employés.

Cette fonction permet d’écrire la chaîne de caractères Value dans le champ de l’objet dont l’identifiant est Object spécifié par le paramètre InfoType. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante. Consultez la fonction ObjectGetInfo pour connaître les valeurs que peut prendre le paramètre InfoType.

Cette fonction permet de rétablir la description (le libellé long) d’origine de l’objet dont l’identifiant est ObjectId à partir de la description venant du catalogue.

Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Cette fonction permet de remplacer puis de recompiler le script de l’objet dont l’identifiant est ObjectId dans la scène courante. Cela se traduit généralement par un changement de la vue de dessus de l’objet, de son modèle 3D, de sa description, etc. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante. Cette fonction est utilisée lors dans le développement d’un assistant, et dans la partie validation de celui-ci.

Cette fonction permet de lire la chaîne de caractères identifiée par le paramètre InfoKey et contenu dans la zone de l’objet ObjectId qui est dédiée aux extensions d’application que sont les assistants et les « plug-ins ». Cette chaîne de caractères doit y avoir été placée auparavant grâce à la fonction ObjectSetCustomInfo décrite plus loin et la même valeur du paramètre InfoKey. Ces chaînes de caractères permettent à un assistant ou un plugin de stocker dans les objets de la scènes des variables de configuration qui lui sont spécifiques, le paramètre InfoKey lui permettant d’isoler ses variables propres de celles des autres assistants ou « plug-ins ». Ces chaînes de caractères spécifiques apparaissent dans le fichier XML qui est généré par la commande « Fichier | Exporter | Données de gestion (.XML) » chacune sous un tag égal à la valeur du paramètre InfoKey correspondant. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Cette fonction permet d’écrire la chaîne de caractères Value dans la zone de l’objet ObjectId qui est dédiée aux extensions d’application. Cette chaîne de caractères sera identifiée par le paramètre InfoKey. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Si AllComponents vaut 1, ce nombre représente tous les composants de l’objet quelque soit leur niveau dans la hiérarchie alors que si AllComponents vaut 0, ce nombre représente seulement les composants du niveau inférieur. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Attention : le paramètre ChildRank va pointer vers un composant différent en fonction de la valeur du paramètre AllComponents. Prière de vous reporter à la description de la fonction ObjectGetChildrenNb pour connaître la signification exacte de ce paramètre. Le nombre de composants de l’objet ObjectId est retourné par la fonction ObjectGetChildrenNb décrite précédemment. Le paramètre AllComponents utilisé dans cette fonction doit avoir la même valeur que celui utilisé dans la fonction ObjectGetChildrenNb. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Pour mémoire un objet « hôte » est un objet de la scène auquel un ou plusieurs objets posés ultérieurement ont été associés. Il s’agit d’un lien similaire à celui des objets « parents » et de leurs composants décrit ci-dessus mais à la différence de ces derniers, le lien n’est pas pré-établi dans le catalogue d’origine mais lors de la pose des objets dans la scène. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Si AllComponents vaut 1, ce nombre représente tous les « objets hébergés » par l’objet identifié par ObjectId quelque soit leur niveau dans la hiérarchie alors que si AllComponents vaut 0, ce nombre représente seulement les « objets hébergés » du niveau inférieur. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Attention : le paramètre HostedRank va pointer vers un « objet hébergé » différent en fonction de la valeur du paramètre AllComponents. Prière de vous reporter à la description de la fonction ObjectGetHostedNb pour connaître la signification exacte de ce paramètre. Le nombre « d’objets hébergés » de l’objet ObjectId est retourné par la fonction ObjectGetHostedNb décrite précédemment. Le paramètre AllComponents utilisé dans cette fonction doit avoir la même valeur que celui utilisé dans la fonction ObjectGetHostedNb. Si ObjectId vaut -2, la fonction s’applique à l’objet actif de la scène courante.

Cette fonction permet de sélectionner l’objet dont l’identifiant est ObjectId dans la scène courante. Si l’indicateur MultipleSelection est positionné à 1, les objets éventuellement déjà sélectionnés le resteront.

La chaîne de caractères retournée se présente sous la forme suivante : «-1,10008,10009,10010,20005,20006;;5,0,0,4,9,7». A gauche des « ;; », se trouvent, séparés par des virgules, les types de finition de l’objet. Le code -1 représente le modèle, les codes en 1XXXX représentent les finitions de modèle et les codes en 2XXXX les finitions de famille. Il est possible d’obtenir les noms des types de finition correspondant à ces rangs grâce à la fonction CatalogGetFinishTypeName de la classe Appli. A droite des « ;; », se trouvent, séparés par des virgules, les rangs (numérotés à partir de 0) des finitions appliquées à l’objet et correspondant respectivement au types de finition listés précédemment. Chacun de ces rangs représente la position de la finition en vigueur dans la liste des finitions possibles pour le type de finition correspondant.

Cette fonction permet de modifier le modèle et les finitions de l’objet dont l’identifiant est ObjectId. Cela se fait grâce au paramètre FinishesList représentant la chaîne de caractères listant dans l’ordre le rang du modèle éventuel suivi des rangs des finitions à appliquer. Les rangs de finition sont numérotés à partir de 0 et sont séparés par des virgules.

La chaîne de caractères retournée se présente sous la forme suivante : «-1,10008,10009,10010,20005,20006;;5,0,0,4,9,7». A gauche des « ;; », se trouvent, séparés par des virgules, les types de finition de l’objet. Le code -1 représente le modèle, les codes en 10000 représentent les finitions de modèle et les codes en 20000 les finitions de famille. Il est possible d’obtenir les noms des types de finition correspondant à ces rangs grâce à la fonction CatalogGetFinishTypeName de la classe Appli. A droite des « ;; », se trouvent, séparés par des virgules, les rangs (numérotés à partir de 0) des finitions appliquées à l’objet et correspondant respectivement au types de finition listés précédemment. Chacun de ces rangs représente la position de la finition en vigueur dans la liste des finitions possibles pour le type de finition correspondant. Si l’indicateur Modify est positionné à 1, la configuration des finitions de l’objet sera effectivement modifiée.

Cette fonction permet d’exporter la vue de l’objet de la scène en cours spécifié par ObjectId (vue de dessus ou perspective) sous la forme d’un fichier .JPG, .BMP, .GIF, .PNG ou .TIF dont le nom (avec le chemin complet) est spécifié dans le paramètre ImageFileName. Les paramètres XRes et YRes permettent de spécifier la résolution en pixels de l’image exportée. Si le paramètre Opened est égal à 0, l’objet est représenté fermé ; sinon, il est représenté ouvert. Le paramètre ViewMode indique quelle vue de l’article on souhaite obtenir.

Les coordonnées exprimées en valeurs décimales sont séparées par une virgule, et les points par un point-virgule comme indiqué ci-dessous : « x1,y1,z1,t1;x2,y2,z2,t2;….;xn,yn,zn,pn;…», où « xn », « yn » et « zn » sont les coordonnées scène du nième point du gabarit et « pn » sa valeur de propriétés. Les propriétés des points de gabarit sont indiquées dans le tableau suivant :

Cette fonction permet de modifier les points constituant le gabarit de l’objet dont l’identifiant est ObjectId. Cela se fait grâce au paramètre ShapePointsList représentant la chaîne de caractères listant dans l’ordre les points du gabarit. Le format de la chaîne de caractères est spécifié dans la description de la fonction ObjectGetShape.

Cette fonction permet de lancer l’exécution de l’assistant éventuellement associé à l’objet dont l’identifiant est ObjectId.

Cette fonction permet de convertir les valeurs de dimension ou d’altitude d’objet retournées en unités catalogue (par exemple par la fonction ObjectGetInfo) en nombre d’incréments de mesure (plus petite variation de mesure) du catalogue d’origine de l’objet. L’incrément de mesure peut être identique à l’unité de mesure du catalogue comme dans le cas des unités de mesure impériales ou dans le cas de l’unité de mesure « 1mm ». Il peut aussi être différent de l’unité de mesure comme dans le cas de l’unité de mesure « 1mm (1.0 mm) » où l’unité de mesure du catalogue est le millimètre tandis que l’incrément de mesure est le dixième de millimètre. Cette fonction trouve son intérêt lors du développement d’assistants ou de fonctions Plug-ins qui doivent fonctionner aussi bien en unités métriques qu’impériales. Dans ce cas, les dimensions d’objets doivent être converties en incréments, puis traitées, et enfin converties en valeur d’affichage (par la fonction ObjectIncrementsToValue décrite ci-après) avant d’être affichées ou modifiées par la fonction ObjectSetInfo. L’assistant de sous-pente « sdk_slop.dll » est un exemple de l’utilisation de ces fonctions. Remarque : les objets provenant des catalogues standard comme les catalogues de contraintes ou les catalogues de décoration retournent des valeurs de dimensions en unités scène. Dans ce cas, la fonction considère que l’unité de mesure du catalogue est l’unité de mesure de la scène courante.

Cette fonction permet de formater un nombre d’incréments de mesure passé en paramètre dans IncrementsNumber en une chaîne de caractères exprimée en unités catalogue (unités de mesure du catalogue d’origine de l’objet ObjectId). Par exemple, un nombre d’incréments de 67 pour un objet venant d’un catalogue en 1/32ème de pouce donnera la chaîne de caractères « 2 3/32 ». Voir la fonction ObjectValueToIncrements décrite ci-dessus pour plus de détails.

Pour être déclaré « contre le mur », l’orientation de l’objet doit être la même que celle du mur et son point d’ancrage (son point 0) ne doit pas se trouver à une distance (en unité de mesure de la scène) supérieure à MaxDistance du mur.

Le paramètre Gap permet de spécifier un écart maximum (distance entre le point d’ancrage ou point 0 de l’objet et le mur en unités de mesure de la scène) au-delà duquel l’objet ne sera pas déclaré « contre » un mur.

Si le paramètre AltitudeTest vaut Vrai alors il faudra en plus qu’il y ait recouvrement sur l’axe vertical pour qu’un objet apparaisse dans la liste.

Cette fonction permet d’effectuer un zoom sur la vue en cours à partir d’un rectangle. Les paramètres PixelX1 et PixelY1 déterminent la position d’un des coins du rectangle tandis que PixelX2 et PixelY2 déterminent la position du coin opposé. Ils sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours.

Cette fonction permet d’effectuer un zoom arrière sur la vue en cours en divisant par deux la longueur des segments en pixels.

Cette fonction permet de régler le zoom de la vue en cours à sa valeur par défaut. En vue de dessus, le rectangle en pointillés vert bornant la scène est affichée avec une petite marge autour. En élévation, la vue de face de l’objet actif est affichée avec une petite marge autour. En perspective, la totalité du champ de vision est affichée.

Cette fonction permet d’obtenir le zoom de la vue en cours le plus important possible tout en affichant intégralement tous les objets de la scène.

Cette fonction permet d’effectuer un zoom centré sur le point défini par les paramètres PixelX1 et PixelY1. Les paramètres PixelX1 et PixelY1 sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours. Si la valeur de ZoomPercentage est positive, le zoom est un agrandissement dont le pourcentage est donné par la valeur de ZoomPercentage. Par exemple une valeur de 100 donne un agrandissement d’un facteur 2 sur chaque axe. Réciproquement, une valeur négative de ZoomPercentage entraîne une réduction du facteur de zoom. Par exemple une valeur de -100 donne une réduction d’un facteur 2 sur chaque axe. Cette fonction peut être utilisée pour gérer une fonction de zoom avant/zoom arrière à partir de la molette de la souris comme dans KitchenDraw.

Cette fonction ne change pas le facteur de zoom mais permet de translater la vue en cours de telle sorte que le point défini par les paramètres StartPixelX et StartPixelY se retrouve déplacé à la position définie par EndPixelX et EndPixelY. Les paramètres StartPixelX, StartPixelY, EndPixelX, et EndPixelY sont exprimés en pixels dans le repère correspondant à l’image dont la résolution en pixels est de ImageResX x ImageResY et qui sert à représenter la vue en cours.

Cette fonction permet de choisir un type de vue. Le paramètre ViewMode indique quelle vue de la scène courante on souhaite obtenir.