Anpassung des Datasmith-Importprozesses

Das Ziel des Datasmith-Importprozesses ist es, einen Satz 3D-Objekte, den Sie in einem Inhaltserstellungswerkzeug eingerichtet haben, reibungslos in den Unreal Editor zu importieren. Dazu übersetzt es Objekte wie Meshs, Lichter, Kameras und Oberflächenmaterialien automatisch in ihre Unreal Engine-Äquivalente, wobei die Absicht Ihres Designs bestmöglich berücksichtigt wird, und füllt für Sie automatisch ein Level mit Instanzen dieser Assets. Weitere Details finden Sie unter Übersicht über Datasmith

Manchmal möchten Sie jedoch vielleicht in den Importprozess eingreifen und die Art und Weise ändern, wie Ihre ursprüngliche Szene in Unreal Engine-Assets übersetzt wird, oder ändern, was mit diesen Assets geschieht. Wenn Sie beispielsweise wissen, dass Sie Teile Ihrer ursprünglichen Szene in Ihrem Unreal Engine-Projekt nicht benötigen, möchten Sie diese Objekte möglicherweise herausfiltern, bevor Sie Ihre Assets erstellen. Dadurch wird die Anzahl unterschiedlicher Inhalte reduziert, mit denen Sie im Unreal Editor arbeiten müssen, und der Import großer Szenen kann beschleunigt werden.

Auf dieser Seite erfahren Sie, wie Sie Blueprint- oder Python-Scripting verwenden können, um den Datasmith-Importprozess zu steuern.

Grundlegendes zum Importprozess

Wenn Sie eine Szene mit einem der Datasmith Importer in der Werkzeugleiste des Unreal Editor importieren, wie unter Importieren von Datasmith-Inhalten in die Unreal Engine beschrieben, führt der Importer intern einen zweistufigen Prozess aus, um Ihre Daten aus einer .udatasmith-, CAD- oder anderen Quelldatei auf der Festplatte zu nehmen und sie im Unreal Editor in Assets und Actors umzuwandeln:

1. Der Importer liest die Inhalte der Datei in eine Datenstruktur im Arbeitsspeicher ein, die Datasmith-Szene genannt wird. Diese enthält eine Repräsentation der 3D-Objekte in der Szene, ihrer Beziehungen sowie aller Eigenschaften dieser Objekte, die Datasmith aus Ihrer ursprünglichen Szene extrahieren konnte.
2. Wenn die Datasmith-Szene im Speicher bereit steht, werden in einer zweiten Stufe des Importprozesses die Szenenelemente in Unreal Engine-Assets im Inhaltsbrowser finalisiert. Sobald das Datasmith-Szenen-Asset fertig ist, wird sie vom Importprozess im aktuellen Level gespawnt. Dadurch werden wiederum alle Children gespawnt: Actors, Statisches-Mesh-Actors, Lichter, Kameras und so weiter.

Optionen zum Anpassen des Importprozesses

Wenn Sie zum Starten des Datasmith-Importprozesses ein Blueprint- oder Python-Script verwenden, können Sie den obigen Vorgang dekonstruieren und die beiden Schritte separat ausführen. Dies erlaubt Ihnen, Ihre eigene Verarbeitung einzufügen, nachdem Sie die Datasmith-Szene im Speicher erstellt haben, aber bevor Sie diese Szene in Assets und Actors finalisieren.

Der Gesamtprozess ist für Blueprint und Python gleich:

1. Konstruieren Sie eine neue speicherinterne Datasmith-Szene vom Speicherort einer .udatasmith-Datei, CAD-Datei oder einem anderen unterstützten Dateityp auf der Festplatte.

2. Nehmen Sie zusätzliche Szenenmodifikationen vor, um die Art und Weise zu beeinflussen, wie Ihre Szene in Unreal-Assets transformiert wird.

   Sie können die Identifizierung der zu ändernden Objekte unter anderem dadurch erleichtern, dass Sie sich Metadaten zu den Objekten in Ihrer Szene zunutze machen. Detaillierte Informationen zum Zugriff auf Metadaten in der Datasmith-Szene finden Sie unter Verwendung von Datasmith-Metadaten.

3. Legen Sie die Optionen für den Importprozess fest. Diese Optionen entsprechen im Grunde denen, die Sie in der Benutzeroberfläche des Unreal Editors einrichten, wenn Sie die Schaltfläche Datasmith importieren verwenden, um den Import zu starten. Sie legen beispielsweise den Pfad fest, wo der Importer Ihre importierten Assets in Ihrem Projekt platzieren soll, welche Objekttypen er aus der Datasmith-Szene erstellen soll, Tesselierungseinstellungen für parametrische CAD-Formate und so weiter.
4. Schließen Sie den Importprozess ab, um Ihre Datasmith-Szene in Unreal-Assets zu finalisieren.
5. Wenn Sie die Datasmith-Szene, die Sie oben erstellt haben, nicht mehr benötigen, sollten Sie die Szene zerstören, um die von ihr belegten Speicherressourcen freizugeben.
6. Nun, da der Importprozess abgeschlossen ist, sind Ihre neuen Assets im Inhaltsbrowser und Ihre neuen Actors im aktuellen Level verfügbar (wenn Sie deren Hinzufügen zu Ihren Importoptionen angefordert haben). Wenn Sie eine zusätzliche Nachbearbeitung an den generierten Unreal-Assets durchführen möchten, wie z. B. die automatische Erstellung von Kollisionsdaten oder LODs, dann ist jetzt der perfekte Zeitpunkt dafür. Weitere Informationen finden Sie auch unter Scripting and Automating the Editor.

Bevor Sie loslegen

• Stellen Sie sicher, dass das Plugin Datasmith Importer für Ihr Projekt aktiviert ist.
• Hintergrundinformationen über den Einsatz von Blueprint- und Python-Scripts im Editor finden Sie auf den Seiten unter Scripting and Automating the Editor (Scripting und Automatisierung im Editor).

Beispiele

Die folgenden Beispiele zeigen Ihnen, wie Sie Blueprint und Python verwenden können, um den Importprozess einer .udatasmith-Datei und einer CAD-Datei in den Unreal Editor anzupassen.

    import unreal

    ds_file_on_disk = "C:\\scenes\\building.udatasmith"
    ds_scene_in_memory = unreal.DatasmithSceneElement.construct_datasmith_scene_from_file(ds_file_on_disk)

    if ds_scene_in_memory is None:
        print "Laden der Szene fehlgeschlagen."
        quit()

    # Die Daten in der Szene modifizieren, um Elemente Herausfiltern oder zu kombinieren ...

    # Alle Mesh entfernen, deren Name ein bestimmtes Stichwort enthält.
    remove_keyword = "exterior" # wir entfernen alle Actors, die diesen String im Namen haben.
    meshes_to_skip = set([])         # wir verwenden dieses Set, um temporär die Meshs zu speichern, die wir nicht benötigen.

    # Alle Mesh-Actors aus der Szene entfernen, deren Namen dem oben festgelegten String-Set übereinstimmen.
    for mesh_actor in ds_scene_in_memory.get_all_mesh_actors():
        actor_label = mesh_actor.get_label()
        if remove_keyword in actor_label:
            print("Entfernen des Actors mit dem Namen: " + actor_label)
            # füge das Mesh-Asset dieses Actors zur Liste der zu überspringenden Meshs hinzu
            mesh = mesh_actor.get_mesh_element()
            meshes_to_skip.add(mesh)
            ds_scene_in_memory.remove_mesh_actor(mesh_actor)

    # Entfernen aller Meshs, die wir nicht importieren müssen.
    for mesh in meshes_to_skip:
        mesh_name = mesh.get_element_name()
        print("Entfernen des Mesh mit dem Namen: " + mesh_name)
        ds_scene_in_memory.remove_mesh(mesh)

    # Importoptionen festlegen.
    import_options = ds_scene_in_memory.get_options(unreal.DatasmithImportOptions)
    import_options.base_options.scene_handling = unreal.DatasmithImportScene.NEW_LEVEL

    # Finalisieren des Prozesses durch Erstellung von Assets und Actors.

    # Ihr Zielordner muss mit /Game/ beginnen
    result = ds_scene_in_memory.import_scene("/Game/MyStudioScene")

    if not result.import_succeed:
        print "Import fehlgeschlagen."
        quit()

    # Datasmith-Szene aufräumen.
    ds_scene_in_memory.destroy_scene()
    print "Benutzerdefinierter Importprozess abgeschlossen!"

Copy full snippet

    import unreal

    # Konstruieren der Datasmith-CAD-Szene aus einer Datei auf der Festplatte.
    # Ihr Zielordner muss mit /Game/ beginnen
    ds_file_on_disk = "C:\\designs\\Clutch assembly.SLDASM"
    ds_scene_in_memory = unreal.DatasmithSceneElement.construct_datasmith_scene_from_file(ds_file_on_disk)

    if ds_scene_in_memory is None:
        print "Laden der Szene fehlgeschlagen."
        quit()

    # Die Daten in der Szene verändern, um Elemente herauszufiltern oder um Elemente zu kombinieren.
    remove_keyword = "_BODY"         # wir entfernen alle Actors mit diesem String in ihrem Namen.
    meshes_to_skip = set([])         # wir verwenden dieses Set, um temporär die Meshs zu speichern, die wir nicht benötigen.

    # Alle Mesh-Actors aus der Szene entfernen, deren Namen dem oben festgelegten String-Set übereinstimmen.
    for mesh_actor in ds_scene_in_memory.get_all_mesh_actors():
        actor_label = mesh_actor.get_label()
        if remove_keyword in actor_label:
            print("Entfernen des Actors mit dem Namen: " + actor_label)
            # füge das Mesh-Asset dieses Actors zur Liste der zu überspringenden Meshs hinzu
            mesh = mesh_actor.get_mesh_element()
            meshes_to_skip.add(mesh)
            ds_scene_in_memory.remove_mesh_actor(mesh_actor)

    # Entfernen aller Meshs, die wir nicht importieren müssen.
    for mesh in meshes_to_skip:
        mesh_name = mesh.get_element_name()
        print("Entfernen des Mesh mit dem Namen: " + mesh_name)
        ds_scene_in_memory.remove_mesh(mesh)

    # Importoptionen festlegen.

    # Hauptimportoptionen:
    import_options = ds_scene_in_memory.get_options(unreal.DatasmithImportOptions)
    import_options.base_options.scene_handling = unreal.DatasmithImportScene.NEW_LEVEL

    # Nur CAD-Oberflächentesselierungsoptionen
    tessellation_options = ds_scene_in_memory.get_options(unreal.DatasmithCommonTessellationOptions)
    tessellation_options.options.chord_tolerance = 0.1
    tessellation_options.options.max_edge_length = 0
    tessellation_options.options.normal_tolerance = 30
    tessellation_options.options.stitching_technique = unreal.DatasmithCADStitchingTechnique.STITCHING_SEW

    # Zusätzliche Nur-CAD-Optionen:
    cad_import_options = ds_scene_in_memory.get_options(unreal.DatasmithCADImportOptions)
    cad_import_options.uv_generation = unreal.CADUVGeneration.KEEP
    cad_import_options.num_threads = 8

    # Finalisieren des Prozesses durch Erstellung von Assets und Actors.
    ds_scene_in_memory.import_scene("/Game/MyCADScene")

    # Datasmith-Szene aufräumen.
    ds_scene_in_memory.destroy_scene()
    print "Benutzerdefinierter Importprozess abgeschlossen!"

Copy full snippet

Zugriff auf Importoptionen

Wenn Sie mit verschiedenen Typen von Datasmith-Quelldateien arbeiten, besteht der einzige Unterschied in der API darin, dass verschiedene Dateitypen Ihnen unterschiedliche Optionen zur Steuerung des Importprozesses bieten.

– Für .udatasmith-Dateien zeigt das erste Beispiel oben, wie Sie auf ein DatasmithImportOptions-Objekt zugreifen können, das Zugang zu Ziel-Asset- und Pfadnamen bietet, welche Datentypen Sie importieren möchten, Lightmap-Auflösungseinstellungen usw. Das funktioniert bei allen Dateitypen, die Sie mit Datasmith importieren können.

– Für CAD-Dateien zeigt das zweite Beispiel, wie Sie auch auf ein DatasmithCommonTessellationOptions-Objekt zugreifen können, das die im Tesselierungsprozess verwendeten Einstellungen steuert, und auf ein DatasmithCADImportOptions-Objekt, das Zugang auf andere interne Debugeinstellungen bietet, die Sie eventuell nützlich finden.

– Andere von Datasmith unterstützte Dateitypen kapseln ihre Import-Einstellungen in anderen Klassen, wie z. B. DatasmithC4DImportOptions für Cinema 4D.

Abgesehen vom Zugriff auf diese Importoptionen sind die restlichen Scripts für die Arbeit mit der Datasmith-Szene und den Elementen innerhalb der Szene exakt gleich.

Weitere Details zu diesen Importoptionsklassen und deren Einstellungen finden Sie in den entsprechenden Einträgen in der Python API-Referenz oder der Blueprint API-Referenz.

Als Alternative zur Verwendung von DatasmithSceneElement.get_options() in Python oder Datasmith > Scene > Get Options in Blueprint können Sie DatasmithSceneElement.get_all_options() oder Datasmith > Scene > Get All Options verwenden, um alle Optionsklassen für die Datasmith-Szene abzurufen, die Sie in einer einzelnen Map erstellt haben. Der Schlüsselwert jedes Eintrags in der Map ist eine Optionsklasse, die dem Datasmith-Szenenelement gehört, das Sie aus Ihrer Datei erstellt haben, und der Wert des Eintrags ist die Instanz dieser Klasse, die dem Datasmith-Szenenelement gehört. Wenn Sie nicht wissen, welche Art von Datei Ihr Script verarbeiten wird und daher nicht, welche Arten von Optionsklassen das DatasmithSceneElement enthalten soll, können Sie diesen Ansatz verwenden, um sie alle abzurufen und durch sie zu iterieren.

Über die Datasmith-Szene

Um zu erkunden, was Sie mit der Datasmith-Szene in der Vorimport-Phase tun können, ist es hilfreich, ein wenig über den Aufbau der Szene zu wissen.

Szeneninhalte

Eine Datasmith-Szene ist meistens ein Container für verschiedene Typen von Elementen. Jedes dieser Elemente repräsentiert entweder ein Asset, das nach dem Import im Inhaltsbrowser erstellt wird, oder ein Actor, der in Ihrem Level mit seiner eigenen Transformation im 3D-Raum gespawnt wird.

Die wichtigsten Asset-Elementtypen umfassen:

• Meshs: Jedes Mesh-Element repräsentiert einen Block mit 3D-Geometrie. Wenn Sie den Import abgeschlossen haben, wird jedes Mesh-Element als separates statisches Mesh-Objekt im Ordner „Geometry“ gespeichert. Jedes Mesh-Element weist eine Anzahl von Material-Slots auf, die jeweils durch ihren Namen einem Materialelement assoziiert sind.
• Materialien: Jedes Materialelement repräsentiert einen eindeutigen Typ von Oberfläche, die für Ihre Geometrien benötigt wird. Wenn Sie den Import abgeschlossen haben, wird jedes Materialelement als separates Materialobjekt im Ordner „Materials“ gespeichert.
• Texturen: Jedes Texturelement repräsentiert ein einzelnes 2D-Bild, das von mindestens einem Ihrer Materialien verwendet wird. Wenn Sie den Import abschließen, landet jedes Element als separates Texturobjekt im Texturen-Ordner.

Die Haupt-Actor-Elementtypen umfassen Folgendes:

• Mesh-Actors: Jedes Mesh-Actor-Element repräsentiert eine Instanz einer Mesh-Geometrie in Ihrem Level. Wenn Sie den Import abschließen, wird jedes Mesh-Actor-Element als Statisches-Mesh-Actor in Ihrem Welt-Outliner angezeigt.
• Licht-Actors: Jedes Licht-Actor-Element repräsentiert einen Lichtemitter in Ihrer Szene. Wenn Sie den Import abschließen, wird jedes Licht-Actor-Element in Ihrem Level als Instanz eines Unreal-Basislichttyps, wie z. B. Punktlicht oder Scheinwerferlicht, oder als benutzerdefinierter Datasmith-Actor, der ein Bereichslicht simuliert, angezeigt. Sie können eine Reihe von Eigenschaften für diese Lichter holen und festlegen, darunter Intensität, Farbe, IES-Profil-Texturdateien und so weiter.
• Kamera-Actors: Jede Kamera repräsentiert eine Perspektive, die in Ihrer Quellszene eingerichtet wird. Wenn Sie den Import abschließen, wird jedes Kamera-Actor-Element als CineCameraActor in Ihrem Level angezeigt. Sie können einige grundlegende Eigenschaften dieser Kamera-Actors holen und festlegen, z. B. das Seitenverhältnis.

Die in der Datasmith-Szene im Speicher enthaltenen Daten sind den Daten sehr ähnlich, die Sie in einer .udatasmith-Datei sehen, wenn Sie diese öffnen. Wenn Sie 3ds Max oder Sketchup verwenden, können Sie jede exportierte .udatasmith-Datei öffnen, um eine Vorstellung davon zu bekommen, wie das Datasmith-Szenenobjekt aufgebaut ist:

Arbeiten mit der Datasmith-Szene

Sie interagieren hauptsächlich mit der Datasmith-Szene, um Listen der oben beschriebenen Elemente abzurufen. Dazu verwenden Sie in Python die Funktionen, die in der Klasse DatasmithSceneElementBase definiert sind, von der Ihr DatasmithSceneElementableitet. In Blueprint verwenden Sie die Knoten Datasmith > Scene, wie im obigen Beispiel gezeigt.

Sobald Sie eine Liste von Elementen haben, können Sie durch die Liste iterieren, um ein bestimmtes Element abzurufen. Verwenden Sie dann die Python-API für dieses Element (z. B. DatasmithMeshActorElement) oder die Knoten Datasmith > Element in Blueprint, um Informationen über das bestimmte Element zu holen und festzulegen. Wenn Ihr Element ein Actor-Typ ist, können auch dessen Child-Actor-Elemente holen, mit denen Sie die Szenenhierarchie nach unten durchsuchen können.

Wenn Sie bestehende Elemente aus der Szene entfernen (wie in den obigen Beispielen gezeigt) oder neue Elemente hinzufügen möchten, können Sie das ebenfalls mithilfe der an denselben Stellen exponierten Funktionen tun. Sie können beispielsweise die Hierarchie der Actors neu ordnen, indem Sie sie entfernen und unter anderen Parents erneut hinzufügen. Dazu verwenden Sie Funktionen, die von Ihrer Klasse DatasmithSceneElement in Python bereitgestellt werden, oder Knoten aus der Kategorie Datasmith > Scene in Blueprint.