Zum Hauptinhalt springen

Splat Transform Anleitung

Diese Anleitung hilft dir bei der Installation von splat-transform und bietet eine Reihe nützlicher Befehle, die du in verschiedenen Situationen verwenden kannst.

Voraussetzung​

Um die folgenden Befehle zu verwenden, benötigst du npm. Installiere es für dein Gerät mithilfe der offiziellen Anleitung:

NPM Installationsanleitung

Wenn du npm bereits installiert hast, öffne deine Shell oder dein Terminal und überprüfe die Installation mit folgendem Befehl:

npm -v

Wenn die Ausgabe eine Versionsnummer wie z.B. 11.4.2 anzeigt, ist npm korrekt installiert. Wenn der Befehl nicht erkannt wird, wurde npm nicht ordnungsgemäß installiert.

Zusätzlich benötigst du das SplatTransform CLI-Tool von PlayCanvas. Du kannst splat-transform mit folgendem Befehl global installieren:

npm install -g @playcanvas/splat-transform

Überprüfe deine Installation anschließend mit dem Befehl

splat-transform --version

Die Ausgabe sollte wieder eine Versionsnummer wie z.B. 0.15 sein.

Bevor du beginnst​

Bevor du mit deinen Assets arbeitest, beachte folgende Punkte, um die Nutzung des CLI-Tools zu erleichtern:

  1. Vermeide Leerzeichen in Ordner- und Dateinamen, damit du keine Sonderzeichen escapen musst.
  2. Öffne das Terminal/die Shell im Zielordner, damit du keine vollständigen Pfade eingeben musst (Windows/macOS: Rechtsklick -> Terminal öffnen).
  3. Versuche, den -w-Parameter zu vermeiden, da er Dateien überschreiben kann, die du nicht ersetzen wolltest.

Grundlegende Verwendung​

Allgemeine Verwendung von splat-transform:

splat-transform input [AKTIONEN VORHER] output [AKTIONEN NACHHER]
  • AKTIONEN VORHER sind alle Filter oder Operationen, die vor der Konvertierung oder Dateierstellung ausgeführt werden.
  • AKTIONEN NACHHER sind alle Filter oder Operationen, die nach der Konvertierung oder Dateierstellung ausgeführt werden.

Nützliche Aktionen​

Parameterübersicht anzeigen​

Wenn du eine Übersicht aller verfügbaren Parameter in der Konsole benötigst, verwende folgenden Befehl:

splat-transform -h

NaN-Gaussians filtern​

Es wird empfohlen, das Flag --filter-nan oder -N hinzuzufuegen, um Gaussians zu entfernen, die NaN- oder Inf-Werte enthalten.

Beispiel:

splat-transform your-file.ply -N  your-output-filename.ply

Bestehende Dateien überschreiben​

Wenn du einen Parameter vergessen hast oder eine bereits generierte Datei oder einen Ordner schnell ersetzen musst, kannst du sie entweder manuell löschen oder einfach überschreiben mit:

splat-transform your-file.ply -w your-file.ply

Harmonische filtern​

Wenn du eine niedrig aufgelöste PLY für Kollisionen generierst, wird empfohlen, alle Harmonischen zu entfernen. Der folgende Befehl entfernt alle SH-Harmonischen:

splat-transform your-file.ply -H 0 your-output-file.ply
Mehr erfahren?

Weitere Parameterbeschreibungen findest du auf der offiziellen Seite des SplatTransform CLI-Tools von PlayCanvas.

SOG-Generierung​

Öffne das Terminal oder die Shell in deinem aktuellen Verzeichnis, andernfalls musst du zum Ordner navigieren, in dem sich die PLY befindet.

Folgender Befehl konvertiert deine PLY in eine SOG, wenn du dich im aktuellen Verzeichnis befindest:

splat-transform your-file.ply your-output-filename.sog

Folgender Befehl konvertiert deine .compressed.ply in eine SOG, wenn du dich im aktuellen Verzeichnis befindest:

splat-transform your-file.compressed.ply your-output-filename.sog

LOD-Generierung​

Eine Schritt-für-Schritt-Anleitung findest du im Abschnitt LOD-Erstellungsanleitung.

Kollision für LCC und LOD generieren​

Um eine Kollision zu erstellen, ist derzeit ein kleiner Workaround erforderlich, da die Integration der .lci-Kollisionsdatei noch nicht implementiert wurde.

important

Dieser Workaround funktioniert sowohl für LOD als auch für LCC.

Workaround mit LCC-Datensatz:

  1. Öffne die LCC in einem Texteditor (Windows: Notepad, Mac: Notizen oder TextEdit)
  2. Suche nach dem Begriff totalLevel
  3. Verwende diese Zahl und subtrahiere 1 davon (z.B. totalLevel: 7 waere 6)
  4. Verwende folgenden Befehl, um eine niedrig aufgelöste PLY zu generieren
splat-transform your-lcc-data.lcc -O 6 low-resolution.ply

Optional: Wenn du auch deine Umgebung einschließen möchtest, verwende diesen Befehl:

splat-transform your-lcc-data.lcc -O 6 -E environment.bin low-resolution.ply
  1. Lade die niedrig aufgelöste Version deines Splats als separate Entität hoch und generiere eine Kollision
  2. Lade die Kollision herunter und füge sie deinem LCC hinzu

Workaround mit PLY-Datensatz:

  1. Generiere eine niedrig aufgelöste Version deines Splats.
  2. Lade eine niedrig aufgelöste Version deines Splats (ca. 1-2 Millionen Splats) als separate Entität hoch (vorzugsweise in einem separaten Space)
  3. Verwende die Schaltflaeche "Kollision generieren" bei dieser Entitaet, um das Kollisions-Mesh zu erstellen.
  4. Lade die generierte Kollisionsdatei herunter oder suche sie.
  5. Lade diese Kollisionsdatei zu deiner LOD-Entität hoch.