SpriteEditorModuleBase

Description

Base 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() {}
}

Properties

Public Methods