SCR_BaseToggleToolbarAction.c

Go to the documentation of this file.

//------------------------------------------------------------------------------------------------
[BaseContainerProps(), SCR_BaseContainerCustomTitleUIInfo("m_Info")]
class SCR_BaseToggleToolbarAction : SCR_EditorToolbarAction
{
    [Attribute(desc: "When defined, this info will be used when the action is toggled on.")]
    protected ref SCR_UIInfo m_InfoToggled;
 
    protected ref ScriptInvoker m_OnToggleChanged = new ScriptInvoker();
 
    protected int m_iCurrentValue = -1;
    protected bool m_bCurrentHighlight = false;

    ScriptInvoker GetOnToggleChange()
    {
        return m_OnToggleChanged;
    }

    protected void Toggle(int value, bool highlight = false)
    {
        if (value == m_iCurrentValue && highlight == m_bCurrentHighlight)
            return;
 
        m_iCurrentValue = value;
        m_bCurrentHighlight = highlight;
        m_OnToggleChanged.Invoke(value, highlight);
    }

    int GetCurrentValue()
    {
        return m_iCurrentValue;
    }

    int GetCurrentHighlight()
    {
        return m_bCurrentHighlight;
    }
    
    void Track()
    {
    }

    void Untrack()
    {
    }
 
    /*
    Get UI info representing toggled state of the action.
    When not defined, default UI info will be returned.
    \return UI info
    */
    SCR_UIInfo GetInfoToggled()
    {
        if (m_InfoToggled)
            return m_InfoToggled;
        else
            return GetInfo();
    }
}