Fonctions de traitement du contenu 3D
setViewProperties
Configure les options de rendu au niveau de la vue.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
params
|
Objet
|
Objet contenant les propriétés de vue à configurer.
|
Obligatoire
|
|
|
params.dropshadow
|
Booléen
|
Active ou désactive l'ombre portée.
|
Facultatif
|
true
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
 |
Actuellement, seule l'ombre portée est prise en charge dans l'objet params.
|
addPVS
Ajoute un modèle 3D à l'expérience.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
trackerName
|
Chaîne
|
ID de suivi auquel ce modèle doit être associé.
|
Obligatoire
|
|
name
|
Chaîne
|
ID Studio du widget de modèle.
|
Obligatoire
|
|
url
|
Chaîne
|
URI pour le chargement du modèle 3D.
|
Facultatif
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
Si url reste vide ou non défini, un espace réservé de modèle vide est créé.
|
setModelURL
Définit une nouvelle URL pour un modèle et charge le modèle.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
params
|
Objet
|
Objet contenant une référence de modèle et un URI.
|
Obligatoire
|
|
params.modelID
|
Chaîne
|
ID Studio de l'élément de modèle à mettre à jour.
|
Obligatoire
|
|
params.modelURL
|
Chaîne
|
URI à partir duquel charger le modèle 3D.
|
Obligatoire
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
L'élément du modèle doit être initialisé au préalable à l'aide d'addPVS.
|
setProperties
Définit les propriétés d'effet visuel et de rendu d'un élément spécifique.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
name
|
Chaîne
|
ID Studio de l'élément à mettre à jour.
|
Obligatoire
|
|
|
params
|
Objet
|
Objet contenant les propriétés de rendu à appliquer.
|
Obligatoire
|
|
|
params.occlude
|
Booléen
|
Active ou désactive l'occlusion des autres objets dans le modèle.
|
Facultatif
|
true
|
|
params.billboard
|
Booléen
|
Active ou désactive les panneaux d'affichage (s'applique uniquement aux widgets d'image 3D (Image 3D, Jauge 3D et Etiquette 3D).
|
Facultatif
|
true
|
|
params.hidden
|
Booléen
|
Active ou désactive le masquage de l'élément (s'applique à tous les widgets de modèle non-3D, principalement les sous-assemblages).
|
Facultatif
|
true
|
|
params.opacity
|
Nombre
|
Définit l'opacité de l'élément (0.0 = transparent, 1.0 = opaque).
|
Facultatif
|
1.0
|
|
params.decal
|
Booléen
|
Active ou désactive le mode de rendu toujours visible des décalques.
|
Facultatif
|
true
|
|
params.shader
|
Chaîne
|
Chaîne de définition du nuanceur constituée du nom du nuanceur et des paramètres facultatifs (séparés par des points-virgules). Exemple : "highlight; r f 1; g f 0; b f 0; a f 1"
|
Facultatif
|
""
|
|
params.phantom
|
Booléen
|
Active ou désactive la semi-transparence de l'élément (s'applique uniquement aux widgets Modèle 3D).
|
Facultatif
|
true
|
|
params.forceHidden
|
Booléen
|
Active ou désactive le masquage forcé de l'élément (s'applique uniquement aux widgets Modèle 3D).
|
Facultatif
|
true
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Vous pouvez appliquer plusieurs propriétés simultanément en les combinant dans l'objet params.
• Les propriétés qui ne sont pas spécifiées seront définies sur leur valeur par défaut.
|
loadPVI
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
params
|
Objet
|
Objet contenant la référence du modèle et l'URI du fichier PVI.
|
Obligatoire
|
|
params.modelID
|
Chaîne
|
ID Studio du modèle pour lequel charger le fichier PVI.
|
Obligatoire
|
|
params.url
|
Chaîne
|
URI du fichier PVI utilisé pour charger les données d'animation. En cas d'omission, les données d'animation du modèle précédemment chargées seront déchargées.
|
Obligatoire
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Si une URL est fournie, l'animation est chargée à partir du fichier spécifié.
• Si l'URL est omise ou s'il s'agit d'une chaîne vide, toutes les données PVI précédemment chargées seront supprimées du modèle.
|
playStep
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
params
|
Objet
|
Objet contenant les informations du modèle et de l'étape.
|
Obligatoire
|
|
params.modelID
|
Chaîne
|
ID Studio du modèle pour lequel lire l'étape d'animation.
|
Obligatoire
|
|
params.stepNumber
|
Nombre
|
Numéro de l'étape à lire.
|
Obligatoire
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
Le modèle doit posséder un fichier PVI chargé avec des étapes d'animation valides (voir loadPVI).
|
gotoStep
Passe à une étape d'animation spécifique pour le modèle donné et le définit sur la position indiquée.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
|---|---|---|---|
|
params
|
Objet
|
Objet contenant les informations du modèle et de l'étape.
|
Obligatoire
|
|
params.modelID
|
Chaîne
|
ID Studio du modèle pour lequel lire l'étape d'animation.
|
Obligatoire
|
|
params.stepNumber
|
Nombre
|
Numéro de l'étape à atteindre.
|
Obligatoire
|
|
params.position
|
Chaîne
|
Position à l'intérieur de l'étape : "début" ou "fin".
|
Obligatoire
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
Nécessite que le modèle possède des données d'animation PVI chargées (voir loadPVI).
|
add3DImage
Ajoute une image dans l'espace 3D.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
params
|
Objet
|
Objet contenant des informations sur le placement et l'affichage des images.
|
Obligatoire
|
|
|
params.tracker
|
Chaîne
|
ID de suivi auquel cette image doit être associée.
|
Obligatoire
|
|
|
params.id
|
Chaîne
|
ID Studio du widget.
|
Obligatoire
|
|
|
params.src
|
Chaîne
|
URI ou chaîne Base64 de l'image à afficher.
|
Obligatoire
|
|
|
params.width
|
Nombre
|
Largeur de l'image dans l'espace 3D (en mètres).
|
Facultatif
|
NaN
|
|
params.height
|
Nombre
|
Hauteur de l'image dans l'espace 3D (en mètres).
|
Facultatif
|
NaN
|
|
params.pivot
|
Nombre
|
Point pivot pour le positionnement. Les valeurs de pivot sont les suivantes :
• 1 : pivot dans le coin supérieur gauche
• 2 : pivot en haut au centre
• 3 : pivot dans le coin supérieur droit
• 4 : pivot à l'arête médiane gauche
• 5 : pivot au centre (par défaut)
• 6 : pivot à l'arête médiane droite
• 7 : pivot dans le coin inférieur gauche
• 8 : pivot en bas au centre
• 9 : pivot dans le coin inférieur droit
|
Facultatif
|
5
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
• Si la largeur ou la hauteur est omise ou définie sur NaN, la valeur manquante sera calculée en fonction de l'autre dimension fournie tout en conservant le rapport d'aspect d'origine.
• Si la largeur et la hauteur sont omises ou définies sur NaN, les dimensions sont déterminées automatiquement à partir de la taille d'origine de l'image.
|
setWayfinderProperties
Définit les propriétés d'un widget Guide d'orientation. Nécessite setWaypoint pour être appelé pour démarrer la navigation.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
params
|
Objet
|
Objet contenant les paramètres de configuration du Guide d'orientation.
|
Obligatoire
|
|
|
params.widgetId
|
Chaîne
|
ID Studio du widget Guide d'orientation à configurer.
|
Obligatoire
|
|
|
params.active
|
Booléen
|
Active ou désactive le Guide d'orientation.
|
Facultatif
|
true
|
|
params.showReticle
|
Booléen
|
Active ou désactive l'affichage du réticule.
|
Facultatif
|
true
|
|
params.showRibbon
|
Booléen
|
Active ou désactive l'affichage du chemin du ruban menant à un point de cheminement.
|
Facultatif
|
true
|
|
params.showWaypoints
|
Booléen
|
Active ou désactive l'affichage des points de cheminement.
|
Facultatif
|
true
|
|
params.showLabels
|
Booléen
|
Active ou désactive l'affichage des étiquettes de point de cheminement.
|
Facultatif
|
true
|
|
params.labelsOnTop
|
Booléen
|
Active ou désactive le rendu des étiquettes au-dessus des autres éléments de la scène.
|
Facultatif
|
true
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
setWaypoint
Définit ou met à jour les propriétés du point de cheminement actif, y compris sa position et son apparence. Nécessite un appel préalable à setWayfinderProperties.
|
Nom
|
Type
|
Description
|
Obligatoire/Facultatif
|
Par défaut
|
|---|---|---|---|---|
|
params
|
Objet
|
Objet contenant une configuration de point de cheminement.
|
Obligatoire
|
|
|
params.position
|
Chaîne
|
Position 3D du point de cheminement sous forme d'objet avec des propriétés x, y, z. Exemple : {"x": 0.1995, "y": 0.0617, "z": 0.2545}
|
Obligatoire
|
|
|
params.gaze
|
Chaîne
|
Vecteur de direction du regard 3D sous forme d'objet avec des propriétés x, y, z. Exemple : {"x": 0, "y": 0, "z": -1}
|
Obligatoire
|
|
|
params.eventRadius
|
Nombre
|
Distance (en mètres) à laquelle les événements (par exemple, avance automatique) sont déclenchés.
|
Facultatif
|
0
|
|
params.wayfinderDisplayBoundary
|
Nombre
|
Rayon (en mètres) dans lequel le Guide d'orientation devient masqué.
|
Facultatif
|
0
|
|
params.color
|
Chaîne
|
Couleur du point de cheminement et du ruban. Il doit s'agir de l'une des valeurs RVBA prédéfinies suivantes : orange, rouge, vert, bleu, jaune, rose, cyan, noir, blanc. Toute couleur non prise en charge sera orange par défaut. Exemple : "rgba(255, 165, 0, 1)") Les valeurs suivantes sont prises en charge :
• Orange : rgba(255, 165, 0, 1)
• Rouge : rgba(255, 0, 0, 1)
• Vert : rgba(0, 255, 0, 1)
• Bleu : rgba(0, 0, 255, 1)
• Jaune : rgba(255, 255, 0, 1)
• Rose : rgba(255, 0, 255, 1)
• Cyan : rgba(0, 255, 255, 1)
• Noir : rgba(0, 0, 0, 1)
• Blanc : rgba(255, 255, 255, 1)
Si une autre couleur est adoptée, la couleur orange par défaut (rgba(255, 165, 0, 1)) est utilisée automatiquement.
|
Facultatif
|
black
|
|
params.label
|
Chaîne
|
Etiquette de texte à afficher en regard du point de cheminement.
|
Facultatif
|
""
|
|
successCallback
|
Fonction
|
Appelée lorsque l'opération se termine avec succès.
|
Facultatif
|
|
|
errorCallback
|
Fonction
|
Appelée en cas d'échec de l'opération.
|
Facultatif
|
|
|
Les paramètres de position et de regard doivent être des objets vectoriels 3D (par exemple, {"x": 0.1995, "y": 0.0617, "z": 0.2545}).
|