Unity Sprite Editor 데이터 공급자 API 사용 가이드

이 문서는 Unity의 Sprite Editor 데이터 공급자 API를 사용하는 방법에 대한 간단한 해설입니다. 스프라이트 데이터를 추가, 변경, 제거하는 방법에 대해 설명하고, 활용 예제도 포함하였습니다.

개요

Unity의 Sprite Editor 데이터 공급자 API를 사용하면 사용자가 커스텀 임포터 또는 에디터 툴에서 스프라이트 데이터를 관리할 수 있습니다. 이 API는 스프라이트 데이터와 관련된 다양한 기능을 제공합니다.

환경 설정

이 코드는 Unity 2021.2 이상에서 사용 가능하며, 이전 버전을 사용할 경우에는 일부 코드를 제거해야 합니다.

ISpriteEditorDataProvider 인스턴스 얻기

다음 코드 예시는 ISpriteEditorDataProvider 인스턴스를 얻는 방법을 보여줍니다.

using UnityEditor;
using UnityEditor.U2D.Sprites;
using UnityEngine;

public class MyAssetPostProcessor : AssetPostprocessor
{
    private void OnPreprocessTexture()
    {
        var factory = new SpriteDataProviderFactories();
        factory.Init();
        var dataProvider = factory.GetSpriteEditorDataProviderFromObject(assetImporter);
        dataProvider.InitSpriteEditorDataProvider();

        /* Use the data provider */

        // Apply the changes made to the data provider
        dataProvider.Apply();
    }
}

텍스처 업데이트

다음은 선택한 텍스처의 스프라이트 설정을 업데이트하는 방법입니다.

using UnityEditor;
using UnityEditor.U2D.Sprites;
using UnityEngine;

public static class MyCustomTool
{
    [MenuItem("Custom/Update Sprite Settings")]
    static void UpdateSettings()
    {
        foreach (var obj in Selection.objects)
        {
            if (obj is Texture2D)
            {
                var factory = new SpriteDataProviderFactories();
                factory.Init();
                var dataProvider = factory.GetSpriteEditorDataProviderFromObject(obj);
                dataProvider.InitSpriteEditorDataProvider();

                /* Use the data provider */

                // Apply the changes made to the data provider
                dataProvider.Apply();

                // Reimport the asset to have the changes applied
                var assetImporter = dataProvider.targetObject as AssetImporter;
                assetImporter.SaveAndReimport();
            }
        }
    }
}

스프라이트 추가, 변경, 제거하기

스프라이트 추가

스프라이트를 추가하는 방법은 다음과 같습니다.

static void AddSprite(ISpriteEditorDataProvider dataProvider)
{
    // Define the new Sprite Rect
    var newSprite = new SpriteRect()
    {
        name = "MyNewSprite",
        spriteID = GUID.Generate(),
        rect = new Rect(0, 0, 32, 32)
    };

    // Add the Sprite Rect to the list of existing Sprite Rects
    var spriteRects = dataProvider.GetSpriteRects().ToList();
    spriteRects.Add(newSprite);

    // Write the updated data back to the data provider
    dataProvider.SetSpriteRects(spriteRects.ToArray());

    // Apply the changes
    dataProvider.Apply();
}

스프라이트 데이터 변경

스프라이트의 피벗을 변경하는 방법은 아래와 같습니다.

static void SetPivot(ISpriteEditorDataProvider dataProvider)
{
    // Get all the existing Sprites
    var spriteRects = dataProvider.GetSpriteRects();

    // Loop over all Sprites and update the pivots
    foreach (var rect in spriteRects)
    {
        rect.pivot = new Vector2(0.1f, 0.2f);
        rect.alignment = SpriteAlignment.Custom;
    }

    // Write the updated data back to the data provider
    dataProvider.SetSpriteRects(spriteRects);

    // Apply the changes
    dataProvider.Apply();
}

스프라이트 제거

스프라이트를 제거하는 방법은 다음과 같습니다.

static void RemoveSprite(ISpriteEditorDataProvider dataProvider, string spriteName)
{
    // Get all the existing Sprites and look for the Sprite with the selected name
    var spriteRects = dataProvider.GetSpriteRects().ToList();
    var index = spriteRects.FindIndex(x => x.name == spriteName);

    // Remove the entry of the Sprite if found
    if (index >= 0)
        spriteRects.RemoveAt(index);

    // Write the updated data back to the data provider
    dataProvider.SetSpriteRects(spriteRects.ToArray());

    // Apply the changes
    dataProvider.Apply();
}

아웃라인 데이터 업데이트

스프라이트의 아웃라인을 업데이트하는 방법은 다음과 같습니다.

static void SetOutline(ISpriteEditorDataProvider dataProvider)
{
    // Get the ISpriteOutlineDataProvider
    var outlineDataProvider = dataProvider.GetDataProvider<ISpriteOutlineDataProvider>();

    // Loop over all Sprites and set their outline to a quad
    var spriteRects = dataProvider.GetSpriteRects();
    foreach (var spriteRect in spriteRects)
    {
        var halfWidth = spriteRect.rect.width / 2f;
        var halfHeight = spriteRect.rect.height / 2f;

        var quadOutline = new Vector2[4]
        {
            new Vector2(-halfWidth, -halfHeight),
            new Vector2(-halfWidth, halfHeight),
            new Vector2(halfWidth, halfHeight),
            new Vector2(halfWidth, -halfHeight)
        };

        var outlines = new List<Vector2[]>();
        outlines.Add(quadOutline);

        var spriteGuid = spriteRect.spriteID;
        outlineDataProvider.SetOutlines(spriteGuid, outlines);
    }

    // Apply the changes
    dataProvider.Apply();
}

추가 자료

더 많은 예제와 API 정보를 확인하려면 Unity의 공식 문서에서 Sprite Editor 스크립팅 API 관련 섹션을 방문하시기 바랍니다.

결론

이 문서에서는 Unity의 Sprite Editor 데이터 공급자 API를 사용하여 스프라이트 데이터의 다양한 작업을 수행하는 방법에 대해 설명했습니다. 이 API를 활용하여 여러분의 프로젝트에 맞는 스프라이트 관리를 구현해 보시기 바랍니다.