Version: 2020.2
Batching with the AssetDatabase
Importer Consistency

스크립트된 임포터

Scripted Importers are part of the Unity Scripting API. You can use Scripted Importers to write custom Asset importers in C# for file formats not natively supported by Unity.

Create a custom importer by specializing the abstract class ScriptedImporter and applying the ScriptedImporter attribute. This registers your custom importer to handle one or more file extensions. When a file matching the registered file extensions is detected by the Asset pipeline as being new or changed, Unity invokes the method OnImportAsset of your custom importer.

Note: Scripted Importers cannot handle a file extension that is already natively handled by Unity.

예제

다음은 스크립트된 임포터의 간단한 예제입니다. 이 예제에서는 확장자가 “cube”인 에셋 파일을 큐브 프리미티브가 주 에셋인 Unity 프리팹과 에셋 파일에서 페치한 컬러의 기본 머티리얼로 임포트합니다.

using UnityEngine;
using UnityEditor.AssetImporters;
using System.IO;

[ScriptedImporter(1, "cube")]
public class CubeImporter : ScriptedImporter
{
    public float m_Scale = 1;

    public override void OnImportAsset(AssetImportContext ctx)
    {
        var cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
        var position = JsonUtility.FromJson<Vector3>(File.ReadAllText(ctx.assetPath));

        cube.transform.position = position;
        cube.transform.localScale = new Vector3(m_Scale, m_Scale, m_Scale);

        // 'cube' is a a GameObject and will be automatically converted into a prefab
        // (Only the 'Main Asset' is elligible to become a Prefab.)
        ctx.AddObjectToAsset("main obj", cube);
        ctx.SetMainObject(cube);

        var material = new Material(Shader.Find("Standard"));
        material.color = Color.red;

        // Assets must be assigned a unique identifier string consistent across imports
        ctx.AddObjectToAsset("my Material", material);

        // Assets that are not passed into the context as import outputs must be destroyed
        var tempMesh = new Mesh();
        DestroyImmediate(tempMesh);
    }
}

참고:

  • 임포터는 Unity 에디터의 ScriptedImporter 속성을 CubeImporter 클래스에 배치하여 에셋 파이프라인에 등록됩니다.
  • CubeImporter 클래스는 추상 ScriptedImporter 기본 클래스(base class)를 구현합니다.
  • OnImportAsset의 ctx 인수는 임포트 이벤트의 입력 및 출력 데이터를 모두 포함합니다.
  • 각 임포트 이벤트는 SetMainAsset 호출을 하나만 생성해야 합니다.
  • 각 임포트 이벤트는 AddSubAsset 호출을 필요한 수만큼 생성할 수 있습니다.
  • Please refer to the Scripting API documentation for more details.

You may also implement a custom Import Settings Editor by specializing ScriptedImporterEditor class and decorating it with the class attribute CustomEditor to tell it what type of importer it is used for.

예제:

using UnityEditor;
using UnityEditor.AssetImporters;
using UnityEditor.SceneManagement;
using UnityEngine;

[CustomEditor(typeof(CubeImporter))]
public class CubeImporterEditor: ScriptedImporterEditor
{
    public override void OnInspectorGUI()
    {
        var colorShift = new GUIContent("Color Shift");
        var prop = serializedObject.FindProperty("m_ColorShift");
        EditorGUILayout.PropertyField(prop, colorShift);
        base.ApplyRevertGUI();
    }
}

스크립트된 임포터 사용

스크립트된 임포터 클래스를 프로젝트에 추가한 후 Unity 에디터에서 지원되는 기타 네이티브 파일 유형과 똑같이 사용할 수 있습니다.

  • 지원되는 파일을 에셋 디렉토리 계층 구조에 끌어다 놓아 임포트합니다.
  • Unity 에디터를 다시 시작하면 최근 업데이트 후에 변경된 파일이 다시 임포트됩니다.
  • 디스크에 있는 에셋 파일을 편집하고 Unity 에디터로 돌아가면 임포트가 다시 실행됩니다.
  • Asset > Import New Asset… 을 선택하여 새 에셋을 임포트합니다.
  • Asset > Reimport 메뉴를 사용하여 다시 임포트하도록 실행합니다.
  • 에셋을 클릭하여 인스펙터 창에서 에셋의 설정을 확인합니다. 설정을 수정하려면 인스펙터 창에서 편집한 후 Apply 를 클릭합니다.

스크립트된 임포터로 임포트한 에셋(An Alembic Girl)의 인스펙터 창
스크립트된 임포터로 임포트한 에셋(An Alembic Girl)의 인스펙터 창

스크립트된 임포터의 실제 사용

  • Alembic: Alembic 임포터 플러그인은 스크립트된 임포터를 사용하도록 업데이트되었습니다. 자세한 내용은 Unity github: AlembicImporter 페이지를 참조하십시오.

  • USD: USD 임포터 플러그인은 스크립트된 임포터를 사용하도록 업데이트되었습니다. 자세한 내용은 Unity github:: USDForUnity 페이지를 참조하십시오.

Batching with the AssetDatabase
Importer Consistency