Datasmith のメタデータを使用する

必要なノードは [Datasmith] > [Scene (シーン)] および [Datasmith] > [Element (要素)] にあります。

Datasmith Metadata Element オブジェクトを返す上記のノードの場合、[Datasmith] > [Element (要素)> [Get Properties (プロパティの取得)]、[Get Property (プロパティの取得)]、[Get Properties Count (プロパティ数の取得)] を使用して、メタデータ オブジェクトからキー/値を取得できます。

使用例

この例では、メタデータ キーに割り当てられた値を使用して、プロジェクトに不要であることがわかっているジオメトリを識別して、Static Mesh アセットを作成する前に Datasmith シーンからそのジオメトリを削除する方法を示しています。

Datasmith のインポート プロセス中に、unreal.DatasmithSceneElement オブジェクトを使用してシーンのオブジェクトに関するメタデータを取得できます。次の関数の詳細については、「Python API リファレンス」 を参照してください。

使用例

この例では、メタデータ キーに割り当てられた値を使用して、プロジェクトに不要であることがわかっているジオメトリを識別して、Static Mesh アセットを作成する前に Datasmith シーンからそのジオメトリを削除する方法を示しています。

    key_name = "name"
    remove_keyword = "Clutch"
    meshes_to_skip = set([])
    # "name" キーをもつすべてのシーン要素を取得します。
    objects_and_values = ds_scene_in_memory.get_all_objects_and_values_for_key(key_name, unreal.DatasmithMeshActorElement)
    objects = objects_and_values[0]
    values = objects_and_values[1]
    # 値がキーワードと一致するものを探して繰り返し処理します
    for index, value in enumerate(values):
        if remove_keyword in value:
            print("removing actor named: " + value)
            # シーンからメッシュのアクター要素を削除し、後で削除するためにメッシュ要素をリストに入れます
            mesh_actor = objects[index]
            mesh = mesh_actor.get_mesh_element()
            meshes_to_skip.add(mesh)
            ds_scene_in_memory.remove_mesh_actor(mesh_actor)
    # インポートする必要ないメッシュをすべて除去する
    for mesh in meshes_to_skip:
        mesh_name = mesh.get_element_name()
        print("removing mesh named " + mesh_name)
        ds_scene_in_memory.remove_mesh(mesh)

Copy full snippet

次のノードは 1 つの特定のアクタのメタデータにアクセスします。これらはパフォーマンスへの影響はほとんどありません。そのため、プロジェクトのランタイム時でもいつでも、使用できます。使用するシーン (コールアウトやプロジェクトのランタイム UI のメニュー) にある 1 つ以上の選択されたオブジェクトのインポートされたメタデータを視覚化したい場合は、以下がランタイムのブループリント グラフで使用する必要のあるノードです。

これらのノードは [Datasmith User Data (Datasmith ユーザー データ)] カテゴリにあります。  

対照的に次のノードは、現在のレベル (または特定のクラスを共有するすべて) にあるすべての Static Mesh アクタのメタデータにアクセスします。レベルには多数のアクタが含まれていることがあるため、これらの関数は CPU リソースを大量に消費することがあり、ランタイム ゲームプレイで使用するとパフォーマンスが低下する可能性があります。そのため、これらのノードは、エディタ専用ブループリント クラスで作成するグラフでのみ使用できます。

これらのノードは、[Editor Scripting (エディタ スクリプティング)] > [Datasmith User Data (Datasmith ユーザー データ)] カテゴリにあります。

上記の Get Datasmith User Data ノードおよび Get All Datasmith User Data ノードでは、Datasmith ユーザー データ オブジェクトのリファレンスを返します。このオブジェクトには、オブジェクトの Datasmith のメタデータを構成するすべてのキーと値/ペアのマップである、メタデータと呼ばれるアクセス可能な変数が 1 つあります。このタイプのオブジェクトを操作するには、出力ピンをドラッグして、[Variables (変数)] > [Get Metadata (メタデータの取得)] を選択します。

これにより、キー/値がマップとして提供されます。これで、[Utilities (ユーティリティ)]> [Map (マップ)] カテゴリのユーティリティ ノードを使用して、データを操作できます。例えば、このグラフはすべてのキーを 1 つずつ繰り返し処理して、各キーに関連付けられた値を取得します。

詳細については、「ブループリント API リファレンス」を参照してください。

使用例

このセクションでは、レベルでプレイヤーが選択するオブジェクトの、ランタイム時のアセット メタデータをどのように視覚化する方法の簡単な例を示します。

テキストは、それぞれが文字列変数に関連付けられている 2 つのテキスト フィールドを含む UMG ウィジェットにより記述されます。ウィジェット用のブループリント グラフでは、カスタム イベントに渡す、アクタから Datasmith のメタデータの 2 つのアイテムをカスタム アクションが抽出し、それらのアイテムを関連付けられている変数に保存します。

次のレベル ブループリントでは、プレイが開始されたときにこのようなウィジェットを追加する方法、およびユーザーがマウス ボタンを押すたびにカーソルの下にあるアクタとともに取り込む方法の例を示します。

UMG でのユーザー インターフェースのビルドの詳細については、「UMG UI デザイナー クイック スタート ガイド」 およびその関連セクションを参照してください。

Datasmith のインポート プロセスが完了したら、unreal.DatasmithContentLibrary クラスを使用して、すべてのアクタまたは選択したアクタのメタデータにアクセスできます。次の関数の詳細については、「Python API リファレンス」 を参照してください。

使用例

Unreal Editor 内で実行する Python スクリプトでは、インポート後に Datasmith のメタデータを使用して、特定の特殊な処理を適用したいレベル内の Static Mesh アクタを特定できます。

    import unreal
    new_actor_name = "Exterior Walls"
    metadata_key = "Type"
    metadata_value = "Wall:Exterior"
    meshes_to_join = set([])
    # 現在のレベルのアクタを繰り返し処理する
    all_actors = unreal.EditorLevelLibrary.get_all_level_actors()
    for actor in all_actors:
        # 上記で設定したキーに対応するこのアクタのDatasmithメタデータの値があれば、それを取得する
        actor_value = unreal.DatasmithContentLibrary.get_datasmith_user_data_value_for_key(actor, metadata_key)
        # キーが存在し、その値が上記のキーワードを含む場合、リストにアクタを追加する
        if actor_value and metadata_value in actor_value:
            print("found a matching actor: " + actor_value)
            meshes_to_join.add(actor)
    # 上記で見つかったすべてのアクタを、多くのコンポーネントを持つ1つのアクタに結合します
    options = unreal.EditorScriptingJoinStaticMeshActorsOptions(destroy_source_actors=True, new_actor_label=new_actor_name, rename_components_from_source=True)
    unreal.EditorLevelLibrary.join_static_mesh_actors(meshes_to_join, options)
    print "Merged all actors!"

Copy full snippet