スプライトエディターデータプロバイダー API を使用することで、カスタムインポーターやエディターツールにスプライトデータの追加、変更、削除を行うことができます。API がどのように適用されるかは、以下のコード例を参照してください。
重要: 以下の例の一部には、Unity 2021.2 以降を使用している場合に必要なコードの追加セクションが含まれています。Unity 2021.1 またはそれ以前のバージョンを使用している場合は、コードが正しくコンパイルされるように、指定されたセクションを削除する必要があります。
以下の例では、API を使ってそれぞれのインスタンスを取得する方法を示しています。
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());
// Note: This section is only for Unity 2021.2 and newer
// Register the new Sprite Rect's name and GUID with the ISpriteNameFileIdDataProvider
var spriteNameFileIdDataProvider = dataProvider.GetDataProvider<ISpriteNameFileIdDataProvider>();
var nameFileIdPairs = spriteNameFileIdDataProvider.GetNameFileIdPairs().ToList();
nameFileIdPairs.Add(new SpriteNameFileIdPair(newSprite.name, newSprite.spriteID));
spriteNameFileIdDataProvider.SetNameFileIdPairs(nameFileIdPairs);
// End of Unity 2021.2 and newer section
// 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());
// Note: This section is only for Unity 2021.2 and newer
// Get all the existing SpriteName & FileId pairs and look for the Sprite with the selected name
var spriteNameFileIdDataProvider = dataProvider.GetDataProvider<ISpriteNameFileIdDataProvider>();
var nameFileIdPairs = spriteNameFileIdDataProvider.GetNameFileIdPairs().ToList();
index = nameFileIdPairs.FindIndex(x => x.name == spriteName);
// Remove the entry of the Sprite if found
if (index >= 0)
nameFileIdPairs.RemoveAt(index);
spriteNameFileIdDataProvider.SetNameFileIdPairs(nameFileIdPairs);
// End of Unity 2021.2 and newer section
// 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();
}
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.