realvirtual.OverlayToggleBase Class Reference

Base class for creating custom overlay toggle buttons with persistent state. More...

Inheritance diagram for realvirtual.OverlayToggleBase:

Public Member Functions
void	OnValueChanged (bool newValue)
	Called when the toggle value changes newValue: The new toggle state (true/false)
virtual bool	ShouldShow (GameObject selectedObject)
	Optional: Determines if the toggle should be shown based on current selection.
virtual bool	ShouldEnable ()
	Optional: Determines if the toggle should be enabled.
virtual VisualElement	CreateButton ()
	Creates the visual element for this toggle.
void	RefreshValue ()
	Programmatically refresh the toggle state from preferences.

Protected Member Functions
bool	GetValue ()
	Gets the current toggle value from EditorPrefs (or default if no preference set)
void	SetValue (bool value)
	Sets the toggle value and saves to EditorPrefs.
Texture	LoadIcon (string path)
	Helper method to load an icon from the project.
VisualElement	CreateIconElement (Texture icon, int size=16)
	Helper method to create an icon element.

Properties
virtual string	ButtonText [get]
	Text displayed on the button (can be null if using icon only)
virtual string	Tooltip [get]
	Tooltip text shown on hover.
virtual Texture	Icon [get]
	Icon texture for the button (can be null if using text only)
virtual string	CssClass [get]
	Additional CSS class names to apply to the toggle (for custom styling)
virtual bool	IconOnly [get]
	Whether this button uses icon only (no text)
virtual string	PreferenceKey [get]
	EditorPrefs key for storing toggle state (override this for persistent state) If null, state is not persisted across sessions.
virtual bool	DefaultValue [get]
	Default value when no preference is stored.

Detailed Description

Base class for creating custom overlay toggle buttons with persistent state.

Inherit from this class to create toggle buttons that maintain their state across sessions.

Example usage:

[OverlayButton(typeof(QuickEditOverlay), order: 110.0, section: "Custom")]
public class MyToggleButton : OverlayToggleBase
{
    private const string PREF_KEY = "MyToggle_State";
 
    public override string ButtonText => "My Toggle";
    public override string Tooltip => "Toggle my feature";
    public override Texture Icon => LoadIcon("d_Toggle Icon");
 
    protected override string PreferenceKey => PREF_KEY;
 
    public override void OnValueChanged(bool newValue)
    {
        // Handle toggle state change
        if (newValue)
            Debug.Log("Feature enabled");
        else
            Debug.Log("Feature disabled");
    }
}

Member Function Documentation

CreateButton()

virtual VisualElement realvirtual.OverlayToggleBase.CreateButton ( )

virtual

Creates the visual element for this toggle.

Implements realvirtual.IOverlayButton.

CreateIconElement()

VisualElement realvirtual.OverlayToggleBase.CreateIconElement ( Texture  icon, int  size = 16  )

protected

Helper method to create an icon element.

GetValue()

bool realvirtual.OverlayToggleBase.GetValue ( )

protected

Gets the current toggle value from EditorPrefs (or default if no preference set)

LoadIcon()

Texture realvirtual.OverlayToggleBase.LoadIcon ( string  path )

protected

Helper method to load an icon from the project.

OnValueChanged()

void realvirtual.OverlayToggleBase.OnValueChanged ( bool  newValue )

abstract

Called when the toggle value changes newValue: The new toggle state (true/false)

RefreshValue()

void realvirtual.OverlayToggleBase.RefreshValue

(

)

Programmatically refresh the toggle state from preferences.

SetValue()

void realvirtual.OverlayToggleBase.SetValue ( bool  value )

protected

Sets the toggle value and saves to EditorPrefs.

ShouldEnable()

virtual bool realvirtual.OverlayToggleBase.ShouldEnable ( )

virtual

Optional: Determines if the toggle should be enabled.

Implements realvirtual.IOverlayButton.

ShouldShow()

virtual bool realvirtual.OverlayToggleBase.ShouldShow ( GameObject  selectedObject )

virtual

Optional: Determines if the toggle should be shown based on current selection.

Implements realvirtual.IOverlayButton.

Property Documentation

ButtonText

virtual string realvirtual.OverlayToggleBase.ButtonText

get

Text displayed on the button (can be null if using icon only)

CssClass

virtual string realvirtual.OverlayToggleBase.CssClass

get

Additional CSS class names to apply to the toggle (for custom styling)

DefaultValue

virtual bool realvirtual.OverlayToggleBase.DefaultValue

getprotected

Default value when no preference is stored.

Icon

virtual Texture realvirtual.OverlayToggleBase.Icon

get

Icon texture for the button (can be null if using text only)

IconOnly

virtual bool realvirtual.OverlayToggleBase.IconOnly

get

Whether this button uses icon only (no text)

PreferenceKey

virtual string realvirtual.OverlayToggleBase.PreferenceKey

getprotected

EditorPrefs key for storing toggle state (override this for persistent state) If null, state is not persisted across sessions.

Tooltip

virtual string realvirtual.OverlayToggleBase.Tooltip

get

Tooltip text shown on hover.