Funktionen für die Handhabung von 3D-Inhalten
setViewProperties
Konfiguriert Rendering-Optionen auf Ansichtsebene.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
params
|
Objekt
|
Objekt, das die zu konfigurierenden Ansichtseigenschaften enthält
|
Erforderlich
|
|
|
params.dropshadow
|
Boolesch
|
Aktiviert oder deaktiviert den Schlagschatten
|
Optional
|
true
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
 |
Derzeit werden nur Schlagschatten im params-Objekt unterstützt.
|
addPVS
Fügt dem Erlebnis ein 3D-Modell hinzu.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
trackerName
|
Zeichenfolge
|
Tracker-ID, der dieses Modell zugeordnet werden soll
|
Erforderlich
|
|
name
|
Zeichenfolge
|
Studio ID des Modell-Widgets
|
Erforderlich
|
|
url
|
Zeichenfolge
|
URI zum Laden des 3D-Modells
|
Optional
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
Wenn url leer gelassen wird oder nicht definiert ist, wird ein leerer Modellplatzhalter erstellt.
|
setModelURL
Legt eine neue Modell-URL für ein Modell fest und lädt das Modell.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
params
|
Objekt
|
Objekt, das Modellreferenz und URI enthält
|
Erforderlich
|
|
params.modelID
|
Zeichenfolge
|
Studio ID des zu aktualisierenden Modellelements
|
Erforderlich
|
|
params.modelURL
|
Zeichenfolge
|
URI, aus dem das 3D-Modell geladen werden soll
|
Erforderlich
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
Das Modellelement muss zuvor mit addPVS initialisiert werden.
|
setProperties
Legt visuelle und Rendering-bezogene Effekteigenschaften für ein bestimmtes Element fest.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
name
|
Zeichenfolge
|
Studio ID des zu aktualisierenden Elements
|
Erforderlich
|
|
|
params
|
Objekt
|
Objekt, das anzuwendende Rendering-Eigenschaften enthält
|
Erforderlich
|
|
|
params.occlude
|
Boolesch
|
Aktiviert oder deaktiviert die Okklusion anderer Objekte durch das Modell
|
Optional
|
true
|
|
params.billboard
|
Boolesch
|
Aktiviert oder deaktiviert Billboards (gilt nur für 3D-Bild-Widgets, d.h. 3D-Bild, 3D-Anzeige und 3D-Beschriftung)
|
Optional
|
true
|
|
params.hidden
|
Boolesch
|
Aktiviert oder deaktiviert das Ausblenden des Elements (gilt für alle Nicht-3D-Modell-Widgets, hauptsächlich Unterbaugruppen)
|
Optional
|
true
|
|
params.opacity
|
Zahl
|
Legt die Opazität des Elements (0,0 = transparent, 1,0 = undurchsichtig) fest
|
Optional
|
1.0
|
|
params.decal
|
Boolesch
|
Aktiviert oder deaktiviert den Render-Modus für Decals immer im Vordergrund
|
Optional
|
true
|
|
params.shader
|
Zeichenfolge
|
Shader-Definitionszeichenfolge, bestehend aus dem Shader-Namen und optionalen Parametern, die durch ein Semikolon getrennt sind. Beispiel: "highlight; r f 1; g f 0; b f 0; a f 1"
|
Optional
|
""
|
|
params.phantom
|
Boolesch
|
Aktiviert oder deaktiviert Halbtransparenz für das Element (gilt nur für 3D Model-Widgets)
|
Optional
|
true
|
|
params.forceHidden
|
Boolesch
|
Aktiviert oder deaktiviert das erzwungene Ausblenden des Elements (gilt nur für 3D Model-Widgets)
|
Optional
|
true
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Sie können mehrere Eigenschaften gleichzeitig anwenden, indem Sie sie im params-Objekt kombinieren.
• Nicht festgelegte Eigenschaften werden auf ihre Standardwerte festgelegt.
|
loadPVI
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
params
|
Objekt
|
Objekt, das die Modellreferenz und den URI zur PVI-Datei enthält
|
Erforderlich
|
|
params.modelID
|
Zeichenfolge
|
Studio ID des Modells, für das die PVI-Datei geladen werden soll
|
Erforderlich
|
|
params.url
|
Zeichenfolge
|
URI der PVI-Datei, die zum Laden von Animationsdaten verwendet wird. Wird der URI weggelassen, so werden zuvor geladene Animationsdaten für das Modell entladen.
|
Erforderlich
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Wird die URL angegeben, so wird die Animation aus der angegebenen Datei geladen.
• Wird die URL nicht angegeben oder es es wird eine leere Zeichenfolge angegeben, so werden alle zuvor geladenen PVI-Daten aus dem Modell entfernt.
|
playStep
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
params
|
Objekt
|
Objekt, das Modell- und Schrittinformationen enthält
|
Erforderlich
|
|
params.modelID
|
Zeichenfolge
|
Studio ID des Modells, für das der Animationsschritt wiedergegeben werden soll
|
Erforderlich
|
|
params.stepNumber
|
Zahl
|
Wiederzugebende Schrittnummer
|
Erforderlich
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
Das Modell muss über eine geladene PVI-Datei mit gültigen Animationsschritten verfügen (siehe loadPVI).
|
gotoStep
Springt zu einem bestimmten Animationsschritt für das jeweilige Modell und setzt es auf die angegebene Position.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
|---|---|---|---|
|
params
|
Objekt
|
Objekt, das Modell- und Schrittinformationen enthält
|
Erforderlich
|
|
params.modelID
|
Zeichenfolge
|
Studio ID des Modells, für das der Animationsschritt wiedergegeben werden soll
|
Erforderlich
|
|
params.stepNumber
|
Zahl
|
Schrittnummer, zu der gewechselt werden soll
|
Erforderlich
|
|
params.position
|
Zeichenfolge
|
Position innerhalb des Schritts: "Start" oder "Ende"
|
Erforderlich
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
Erfordert, dass das Modell geladene PVI-Animationsdaten enthält (siehe loadPVI)
|
add3DImage
Fügt ein Bild im 3D-Raum hinzu.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
params
|
Objekt
|
Objekt, das Informationen zur Bildplatzierung und -anzeige enthält
|
Erforderlich
|
|
|
params.tracker
|
Zeichenfolge
|
Tracker-ID, der dieses Bild zugeordnet werden soll
|
Erforderlich
|
|
|
params.id
|
Zeichenfolge
|
Studio ID des Widgets
|
Erforderlich
|
|
|
params.src
|
Zeichenfolge
|
URI oder Base64-Zeichenfolge des anzuzeigenden Bilds
|
Erforderlich
|
|
|
params.width
|
Zahl
|
Breite des Bildes im 3D-Raum (in Metern)
|
Optional
|
NaN
|
|
params.height
|
Zahl
|
Höhe des Bildes im 3D-Raum (in Metern)
|
Optional
|
NaN
|
|
params.pivot
|
Zahl
|
Drehpunkt für die Positionierung. Drehpunktwerte:
• 1 – Drehpunkt in der oberen linken Ecke
• 2 – Drehpunkt oben Mitte
• 3 – Drehpunkt in der oberen rechten Ecke
• 4 – Drehpunkt an der mittleren linken Kante
• 5 – Drehpunkt in der Mitte (Standard)
• 6 – Drehpunkt an der mittleren rechten Kante
• 7 – Drehpunkt in der unteren linken Ecke
• 8 – Drehpunkt unten Mitte
• 9 – Drehpunkt in der unteren rechten Ecke
|
Optional
|
5
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
• Werden entweder Breite oder Höhe weggelassen oder auf NaNfestgelegt, so wird der fehlende Wert auf Grundlage der jeweils anderen bereitgestellten Bemaßungen unter Beibehaltung des ursprünglichen Seitenverhältnisses berechnet.
• Werden sowohl Breite als auch Höhe weggelassen oder auf NaNfestgelegt, so werden die Bemaßungen automatisch anhand der Originalgröße des Bildes ermittelt.
|
setWayfinderProperties
Legt die Eigenschaften des Wayfinder-Widgets fest. Erfordert den Aufruf von setWaypoint, um die Navigation zu starten.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
params
|
Objekt
|
Objekt mit Wayfinder-Konfigurationseinstellungen
|
Erforderlich
|
|
|
params.widgetId
|
Zeichenfolge
|
Studio ID des zu konfigurierenden Wayfinder-Widgets
|
Erforderlich
|
|
|
params.active
|
Boolesch
|
Aktiviert oder deaktiviert den Wayfinder
|
Optional
|
true
|
|
params.showReticle
|
Boolesch
|
Aktiviert oder deaktiviert die Anzeige des Fadennetzes
|
Optional
|
true
|
|
params.showRibbon
|
Boolesch
|
Aktiviert oder deaktiviert die Anzeige des Multifunktionsleisten-Pfads, der zu einem Wegpunkt führt
|
Optional
|
true
|
|
params.showWaypoints
|
Boolesch
|
Aktiviert oder deaktiviert die Anzeige von Wegpunkten
|
Optional
|
true
|
|
params.showLabels
|
Boolesch
|
Aktiviert oder deaktiviert die Anzeige von Wegpunkt-Beschriftungen
|
Optional
|
true
|
|
params.labelsOnTop
|
Boolesch
|
Aktiviert oder deaktiviert das Rendern von Beschriftungen über anderen Szenenelementen
|
Optional
|
true
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
setWaypoint
Legt die Eigenschaften des aktuell aktiven Wegpunkts fest oder aktualisiert diese, einschließlich Position und Erscheinungsbild. Erfordert einen vorherigen Aufruf von setWayfinderProperties.
|
Name
|
Typ
|
Beschreibung
|
Erforderlich/Optional
|
Standard
|
|---|---|---|---|---|
|
params
|
Objekt
|
Objekt mit Wegpunkt-Konfiguration
|
Erforderlich
|
|
|
params.position
|
Zeichenfolge
|
3D-Position des Wegpunkts als Objekt mit x-, y- und z-Eigenschaften Beispiel: {"x": 0.1995, "y": 0.0617, "z": 0.2545}
|
Erforderlich
|
|
|
params.gaze
|
Zeichenfolge
|
3D-Blickrichtungsvektor als Objekt mit x-, y- und z-Eigenschaften Beispiel: {"x": 0, "y": 0, "z": -1}
|
Erforderlich
|
|
|
params.eventRadius
|
Zahl
|
Entfernung (in Metern), bei der Ereignisse (z.B. Automatisch weiter) ausgelöst werden
|
Optional
|
0
|
|
params.wayfinderDisplayBoundary
|
Zahl
|
Radius (in Metern), innerhalb dessen der Wayfinder ausgeblendet wird
|
Optional
|
0
|
|
params.color
|
Zeichenfolge
|
Die Farbe des Wegpunkts und der Multifunktionsleiste. Es muss einer der folgenden vordefinierten RGBA-Werte verwendet werden: Orange, Rot, Grün, Blau, Gelb, Pink, Cyan, Schwarz oder Weiß. Nicht unterstützte Farben werden standardmäßig als Orange angezeigt. Beispiel: "rgba(255, 165, 0, 1)"). Folgende Werte werden unterstützt:
• Orange – rgba(255, 165, 0, 1)
• Rot – rgba(255, 0, 0, 1)
• Grün – rgba(0, 255, 0, 1)
• Blau – rgba(0, 0, 255, 1)
• Gelb – rgba(255, 255, 0, 1)
• Pink – rgba(255, 0, 255, 1)
• Cyan – rgba(0, 255, 255, 1)
• Schwarz – rgba(0, 0, 0, 1)
• Weiß – rgba(255, 255, 255, 1)
Wird eine andere Farbe übergeben, so wird automatisch die Standardfarbe Orange verwendet: rgba(255, 165, 0, 1)
|
Optional
|
black
|
|
params.label
|
Zeichenfolge
|
Textbeschriftung, die neben dem Wegpunkt angezeigt werden soll
|
Optional
|
""
|
|
successCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation erfolgreich abgeschlossen wurde
|
Optional
|
|
|
errorCallback
|
Funktion
|
Wird aufgerufen, wenn die Operation fehlschlägt
|
Optional
|
|
|
Bei den Positions- und Blickrichtungsparametern muss es sich um 3D-Vektorobjekte handeln. (Beispiel: {"x": 0.1995, "y": 0.0617, "z": 0.2545})
|