class in UnityEditor.Experimental.U2D
/
Implemented in:UnityEditor
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.
CloseBase class the Sprite Editor Window custom module inherits from.
Sprite Editor Window functionality can be extended by providing custom module. By inheriting from SpriteEditorModuleBase, user will be able to activate the module's functionality from Sprite Editor Window.
using UnityEditor.Experimental.U2D; using UnityEngine;
public class MySpriteEditorCustomModule : SpriteEditorModuleBase { // The name of the module that will be shown in Sprite Editor Window drop down menu public override string moduleName { get { return "MySpriteEditorCustomModule"; } }
// This is called when user clicks on the Apply or Revert button in Sprite Editor Window public override bool ApplyRevert(bool apply) { return true; }
// Indicates if the module can be activated with the current ISpriteEditor state public override bool CanBeActivated() { return true; }
// Called after SpriteEditorWindow drawn the sprite. // UnityEditor.Handles draw calls will operate in Texture space public override void DoMainGUI() {}
// Draw user tool bar public override void DoToolbarGUI(Rect drawArea) {}
// Called when the module is activated by user public override void OnModuleActivate() {}
// Called when user switches to another module public override void OnModuleDeactivate() {}
// Any last GUI draw. This is in the SpriteEditorWindow's space. // Any GUI draw will appear on top public override void DoPostGUI() {} }
moduleName | The module name to display in Sprite Editor Window. |
spriteEditor | The ISpriteEditor instance that instantiated the module. |
ApplyRevert | This is called when user clicks on the Apply or Revert button in Sprite Editor Window. |
CanBeActivated | Indicates if the module can be activated with the current ISpriteEditor state. |
DoMainGUI | Implement this to draw on the Sprite Editor Window. |
DoPostGUI | Implement this to draw widgets in Sprite Editor Window. |
DoToolbarGUI | Implement this to create a custom toolbar. |
OnModuleActivate | This is called when the user activates the module. |
OnModuleDeactivate | This is called when user switches to another module. |
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!