RequireSpriteDataProviderAttribute

Description

Use this attribute on a class that inherits from SpriteEditorModuleBase to indicate what data provider it needs.

When you use this attribute, Sprite Editor Window will only make the module available for selection if ISpriteEditorDataProvider.HasDataProvider returns true for all the data providers the module needs.

#pragma strict
@RequireSpriteDataProvider(ISpriteOutlineDataProvider, ITextureDataProvider)
public class MySpriteEditorCustomModule extends SpriteEditorModuleBase {
	StringmoduleName {
		return "MySpriteEditorCustomModule";
	}
	public override function ApplyRevert(apply: boolean) {
		return true;
	}
	public override function CanBeActivated() {
		return true;
	}
	public override function DoMainGUI() {
	}
	public override function DoToolbarGUI(drawArea: Rect) {
	}
	public override function OnModuleActivate() {
		var outlineProvider: var = spriteEditor.GetDataProvider.<ISpriteOutlineDataProvider>();
		var spriteRects: var = spriteEditor.GetDataProvider.<ISpriteEditorDataProvider>().GetSpriteRects();
		for (var spriteRect: var in spriteRects) {
			// Access outline data
			Debug.Log(outlineProvider.GetOutlines(spriteRect.spriteID));
		}
	}
	public override function OnModuleDeactivate() {
	}
	public override function DoPostGUI() {
	}
}

using UnityEditor.Experimental.U2D;
using UnityEngine;

[RequireSpriteDataProvider(typeof(ISpriteOutlineDataProvider), typeof(ITextureDataProvider))]
public class MySpriteEditorCustomModule : SpriteEditorModuleBase
{
    public override string moduleName
    {
        get { return "MySpriteEditorCustomModule"; }
    }

    public override bool ApplyRevert(bool apply)
    {
        return true;
    }

    public override bool CanBeActivated()
    {
        return true;
    }

    public override void DoMainGUI() {}

    public override void DoToolbarGUI(Rect drawArea) {}

    public override void OnModuleActivate()
    {
        var outlineProvider = spriteEditor.GetDataProvider<ISpriteOutlineDataProvider>();
        var spriteRects = spriteEditor.GetDataProvider<ISpriteEditorDataProvider>().GetSpriteRects();
        foreach (var spriteRect in spriteRects)
        {
            // Access outline data
            Debug.Log(outlineProvider.GetOutlines(spriteRect.spriteID));
        }
    }

    public override void OnModuleDeactivate() {}

    public override void DoPostGUI() {}
}

Constructors