Funzioni per la gestione di contenuti 3D
setViewProperties
Configura le opzioni di rendering a livello di vista.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
Default
|
|---|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente le proprietà della vista da configurare.
|
Obbligatorio
|
|
|
params.dropshadow
|
Booleano
|
Attiva o disattiva l'ombreggiatura.
|
Opzionale
|
true
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
 |
Al momento è supportata solo l'ombreggiatura nell'oggetto params.
|
addPVS
Aggiunge un modello 3D all'esperienza.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
|---|---|---|---|
|
trackerName
|
Stringa
|
ID del tracker a cui deve essere associato il modello.
|
Obbligatorio
|
|
name
|
Stringa
|
ID di Studio del widget del modello.
|
Obbligatorio
|
|
url
|
Stringa
|
URI per il caricamento del modello 3D.
|
Opzionale
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
Se la stringa url viene lasciata vuota o non è definita, viene creato un segnaposto di modello vuoto.
|
setModelURL
Imposta un nuovo URL per un modello e carica il modello.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente il riferimento del modello e l'URI.
|
Obbligatorio
|
|
params.modelID
|
Stringa
|
ID Studio dell'elemento modello da aggiornare.
|
Obbligatorio
|
|
params.modelURL
|
Stringa
|
URI da cui caricare il modello 3D.
|
Obbligatorio
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
L'elemento modello deve essere prima inizializzato utilizzando la funzione addPVS.
|
setProperties
Imposta le proprietà degli effetti visivi e di rendering di un elemento specifico.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
Default
|
|---|---|---|---|---|
|
name
|
Stringa
|
ID Studio dell'elemento da aggiornare.
|
Obbligatorio
|
|
|
params
|
Oggetto
|
Oggetto contenente le proprietà di rendering da applicare.
|
Obbligatorio
|
|
|
params.occlude
|
Booleano
|
Attiva o disattiva l'occlusione del modello di altri oggetti.
|
Opzionale
|
true
|
|
params.billboard
|
Booleano
|
Attiva o disattiva la visualizzazione frontale (si applica solo ai widget Immagine 3D (Immagine 3D, Indicatore 3D ed Etichetta 3D).
|
Opzionale
|
true
|
|
params.hidden
|
Booleano
|
Attiva o disattiva la possibilità di nascondere l'elemento (si applica a tutti i widget di modello non 3D, principalmente ai sottoassiemi).
|
Opzionale
|
true
|
|
params.opacity
|
Numero
|
Imposta l'opacità dell'elemento (0.0 = trasparente, 1.0 = opaco).
|
Opzionale
|
1.0
|
|
params.decal
|
Booleano
|
Attiva o disattiva la modalità di rendering sempre visibile per le decalcomanie.
|
Opzionale
|
true
|
|
params.shader
|
Stringa
|
Stringa di definizione dello shader costituita dal nome dello shader e da parametri opzionali separati da punti e virgola. Esempio: "highlight; r f 1; g f 0; b f 0; a f 1"
|
Opzionale
|
""
|
|
params.phantom
|
Booleano
|
Attiva o disattiva la semitrasparenza dell'elemento (si applica solo ai widget Modello 3D).
|
Opzionale
|
true
|
|
params.forceHidden
|
Booleano
|
Attiva o disattiva la possibilità di nascondere forzatamente l'elemento (si applica solo ai widget Modello 3D).
|
Opzionale
|
true
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
• È possibile applicare più proprietà contemporaneamente combinandole nell'oggetto params.
• Per le proprietà non specificate vengono ripristinati i valori di default.
|
loadPVI
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente il riferimento del modello e l'URI del file PVI.
|
Obbligatorio
|
|
params.modelID
|
Stringa
|
ID Studio del modello per cui caricare il file PVI.
|
Obbligatorio
|
|
params.url
|
Stringa
|
URI del file PVI utilizzato per caricare i dati di animazione. Se omesso, i dati di animazione caricati in precedenza per il modello vengono scaricati.
|
Obbligatorio
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
• Se l'URL è indicato, l'animazione viene caricata dal file specificato.
• Se l'URL è omesso o è una stringa vuota, tutti i dati PVI caricati in precedenza vengono rimossi dal modello.
|
playStep
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente le informazioni del modello e del passo.
|
Obbligatorio
|
|
params.modelID
|
Stringa
|
ID Studio del modello per cui riprodurre il passo dell'animazione.
|
Obbligatorio
|
|
params.stepNumber
|
Numero
|
Numero del passo da riprodurre.
|
Obbligatorio
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
Il modello deve avere un file PVI caricato con passi di animazione validi (vedere la funzione loadPVI).
|
gotoStep
Salta a un passo specifico dell'animazione per il modello specificato e lo imposta sulla posizione indicata.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente le informazioni del modello e del passo.
|
Obbligatorio
|
|
params.modelID
|
Stringa
|
ID Studio del modello per cui riprodurre il passo dell'animazione.
|
Obbligatorio
|
|
params.stepNumber
|
Numero
|
Numero del passo da raggiungere.
|
Obbligatorio
|
|
params.position
|
Stringa
|
Posizione all'interno del passo: "inizio" o "fine".
|
Obbligatorio
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
Richiede che il modello abbia caricato i dati di animazione PVI (vedere la funzione loadPVI).
|
add3DImage
Aggiunge un'immagine nello spazio 3D.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
Default
|
|---|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente informazioni sul posizionamento e sulla visualizzazione dell'immagine.
|
Obbligatorio
|
|
|
params.tracker
|
Stringa
|
ID del tracker a cui deve essere associata l'immagine.
|
Obbligatorio
|
|
|
params.id
|
Stringa
|
ID Studio del widget.
|
Obbligatorio
|
|
|
params.src
|
Stringa
|
URI o stringa con codifica base64 dell'immagine da visualizzare.
|
Obbligatorio
|
|
|
params.width
|
Numero
|
Larghezza dell'immagine nello spazio 3D (in metri).
|
Opzionale
|
NaN
|
|
params.height
|
Numero
|
Altezza dell'immagine nello spazio 3D (in metri).
|
Opzionale
|
NaN
|
|
params.pivot
|
Numero
|
Punto di rotazione per il posizionamento. I valori di rotazione sono i seguenti:
• 1 - Ruota in corrispondenza dell'angolo in alto a sinistra
• 2 - Ruota in alto al centro
• 3 - Ruota in corrispondenza dell'angolo in alto a destra
• 4 - Ruota in corrispondenza dello spigolo al centro a sinistra
• 5 - Ruota al centro (valore di default)
• 6 - Ruota in corrispondenza dello spigolo al centro a destra
• 7 - Ruota in corrispondenza dell'angolo in basso a sinistra
• 8 - Ruota in basso al centro
• 9 - Ruota in corrispondenza dell'angolo in basso a destra
|
Opzionale
|
5
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
• Se la larghezza o l'altezza è omessa o impostata su NaN, il valore mancante viene calcolato in base all'altra dimensione specificata mantenendo le proporzioni originali.
• Se sia la larghezza che l'altezza sono omesse o impostate su NaN, le dimensioni vengono determinate automaticamente dalle dimensioni originali dell'immagine.
|
setWayfinderProperties
Imposta le proprietà di un widget Wayfinder. Richiede una chiamata successiva a setWaypoint per avviare la navigazione.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
Default
|
|---|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente le impostazioni di configurazione del wayfinder.
|
Obbligatorio
|
|
|
params.widgetId
|
Stringa
|
ID Studio del widget Wayfinder da configurare.
|
Obbligatorio
|
|
|
params.active
|
Booleano
|
Attiva o disattiva il wayfinder.
|
Opzionale
|
true
|
|
params.showReticle
|
Booleano
|
Attiva o disattiva la visualizzazione del reticolo.
|
Opzionale
|
true
|
|
params.showRibbon
|
Booleano
|
Attiva o disattiva la visualizzazione del percorso che conduce a un waypoint.
|
Opzionale
|
true
|
|
params.showWaypoints
|
Booleano
|
Attiva o disattiva la visualizzazione dei waypoint.
|
Opzionale
|
true
|
|
params.showLabels
|
Booleano
|
Attiva o disattiva la visualizzazione delle etichette dei waypoint.
|
Opzionale
|
true
|
|
params.labelsOnTop
|
Booleano
|
Attiva o disattiva il rendering delle etichette sovrapposte ad altri elementi della scena.
|
Opzionale
|
true
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
setWaypoint
Imposta o aggiorna le proprietà del waypoint attivo corrente, tra cui la posizione e l'aspetto visivo. Richiede una chiamata precedente a setWayfinderProperties.
|
Nome
|
Tipo
|
Descrizione
|
Obbligatorio/Opzionale
|
Default
|
|---|---|---|---|---|
|
params
|
Oggetto
|
Oggetto contenente la configurazione del waypoint.
|
Obbligatorio
|
|
|
params.position
|
Stringa
|
Posizione 3D del waypoint come oggetto con proprietà x, y, z. Ad esempio: {"x": 0.1995, "y": 0.0617, "z": 0.2545}
|
Obbligatorio
|
|
|
params.gaze
|
Stringa
|
Vettore di direzione dello sguardo 3D come oggetto con proprietà x, y, z. Ad esempio: {"x": 0, "y": 0, "z": -1}
|
Obbligatorio
|
|
|
params.eventRadius
|
Numero
|
Distanza (in metri) alla quale vengono attivati gli eventi, ad esempio l'avanzamento automatico.
|
Opzionale
|
0
|
|
params.wayfinderDisplayBoundary
|
Numero
|
Raggio (in metri) all'interno del quale il wayfinder diventa nascosto.
|
Opzionale
|
0
|
|
params.color
|
Stringa
|
Colore del waypoint e del relativo percorso. Deve essere uno dei seguenti valori rgba predefiniti: arancione, rosso, verde, blu, giallo, rosa, ciano, nero, bianco. Per i colori non supportati viene utilizzato di default l'arancione. Esempio: "rgba(255, 165, 0, 1)"). Valori supportati:
• Arancione - rgba(255, 165, 0, 1)
• Rosso - rgba(255, 0, 0, 1)
• Verde - rgba(0, 255, 0, 1)
• Blu - rgba(0, 0, 255, 1)
• Giallo - rgba(255, 255, 0, 1)
• Rosa - rgba(255, 0, 255, 1)
• Ciano - rgba(0, 255, 255, 1)
• Nero - rgba(0, 0, 0, 1)
• Bianco - rgba(255, 255, 255, 1)
Se si adotta un altro colore, viene utilizzato automaticamente il colore di default arancione: rgba(255, 165, 0, 1).
|
Opzionale
|
black
|
|
params.label
|
Stringa
|
Etichetta di testo da visualizzare accanto al waypoint.
|
Opzionale
|
""
|
|
successCallback
|
Funzione
|
Chiamata quando l'operazione viene completata correttamente.
|
Opzionale
|
|
|
errorCallback
|
Funzione
|
Chiamata quando l'operazione ha esito negativo.
|
Opzionale
|
|
|
I parametri di posizione e sguardo devono essere oggetti vettoriali 3D (ad esempio, {"x": 0.1995, "y": 0.0617, "z": 0.2545}).
|