Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEditor.Experimental.U2D
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseUse 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() {} }
RequireSpriteDataProviderAttribute | Use the attribute to indicate the custom data provider that SpriteEditorBaseModule needs. |
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:
Thanks for helping to make the Unity documentation better!