realvirtual.OverlaySectionBase Class Reference

Base class for creating custom overlay sections with multiple controls. More...

Inheritance diagram for realvirtual.OverlaySectionBase:

Public Member Functions
VisualElement	CreateContent ()
	Creates the content for this section Return a VisualElement containing all the controls for this section.
virtual bool	ShouldShow (GameObject selectedObject)
	Optional: Determines if the section should be shown based on current selection.
virtual bool	ShouldEnable ()
	Optional: Determines if the section should be enabled.
virtual VisualElement	CreateButton ()
	Creates the complete section visual element with optional title and separator.

Protected Member Functions
VisualElement	CreateSeparator ()
	Helper method to create a separator line.
VisualElement	CreateButtonRow ()
	Helper method to create a button row container.
Button	CreateButton (string text, string tooltip, System.Action onClick, string cssClass=null)
	Helper method to create a button.
Button	CreateIconButton (Texture icon, string tooltip, System.Action onClick, string cssClass=null)
	Helper method to create an icon button.
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.
Label	CreateLabel (string text, FontStyle fontStyle=FontStyle.Normal)
	Helper method to create a label.
void	AddComponent (System.Type componentType)
	Helper method to add a component to selected object (similar to QuickEdit)

Properties
virtual string	SectionTitle [get]
	Title of the section (optional, can be null)
virtual Texture	SectionIcon [get]
	Icon for the section header (optional, can be null)
virtual bool	ShowSeparator [get]
	Whether to show a separator line above this section.
virtual string	CssClass [get]
	Additional CSS class names to apply to the section container.

Detailed Description

Base class for creating custom overlay sections with multiple controls.

Inherit from this class to create complex UI sections with multiple buttons, labels, fields, and other visual elements organized in your own layout.

Example usage:

[OverlayButton(typeof(QuickEditOverlay), order: 200.0, section: "Custom")]
public class AdvancedToolsSection : OverlaySectionBase
{
    public override string SectionTitle => "Advanced Tools";
    public override Texture SectionIcon => LoadIcon("d_Settings");
 
    public override VisualElement CreateContent()
    {
        var container = new VisualElement();
        container.style.flexDirection = FlexDirection.Column;
 
        // Add a header
        var header = new Label("Advanced Tools");
        header.style.unityFontStyleAndWeight = FontStyle.Bold;
        container.Add(header);
 
        // Add a row of buttons
        var row1 = CreateButtonRow();
        row1.Add(CreateButton("Tool 1", "First tool", OnTool1Click));
        row1.Add(CreateButton("Tool 2", "Second tool", OnTool2Click));
        container.Add(row1);
 
        // Add a full-width button
        container.Add(CreateButton("Process All", "Process all items", OnProcessAll));
 
        return container;
    }
 
    private void OnTool1Click() { /* ... *‍/ }
    private void OnTool2Click() { /* ... *‍/ }
    private void OnProcessAll() { /* ... *‍/ }
}

Member Function Documentation

AddComponent()

void realvirtual.OverlaySectionBase.AddComponent ( System::Type  componentType )

protected

Helper method to add a component to selected object (similar to QuickEdit)

CreateButton() [1/2]

virtual VisualElement realvirtual.OverlaySectionBase.CreateButton ( )

virtual

Creates the complete section visual element with optional title and separator.

Implements realvirtual.IOverlayButton.

CreateButton() [2/2]

Button realvirtual.OverlaySectionBase.CreateButton ( string  text, string  tooltip, System::Action  onClick, string  cssClass = null  )

protected

Helper method to create a button.

CreateButtonRow()

VisualElement realvirtual.OverlaySectionBase.CreateButtonRow ( )

protected

Helper method to create a button row container.

CreateContent()

VisualElement realvirtual.OverlaySectionBase.CreateContent ( )

abstract

Creates the content for this section Return a VisualElement containing all the controls for this section.

CreateIconButton()

Button realvirtual.OverlaySectionBase.CreateIconButton ( Texture  icon, string  tooltip, System::Action  onClick, string  cssClass = null  )

protected

Helper method to create an icon button.

CreateIconElement()

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

protected

Helper method to create an icon element.

CreateLabel()

Label realvirtual.OverlaySectionBase.CreateLabel ( string  text, FontStyle  fontStyle = FontStyle::Normal  )

protected

Helper method to create a label.

CreateSeparator()

VisualElement realvirtual.OverlaySectionBase.CreateSeparator ( )

protected

Helper method to create a separator line.

LoadIcon()

Texture realvirtual.OverlaySectionBase.LoadIcon ( string  path )

protected

Helper method to load an icon from the project.

ShouldEnable()

virtual bool realvirtual.OverlaySectionBase.ShouldEnable ( )

virtual

Optional: Determines if the section should be enabled.

Implements realvirtual.IOverlayButton.

ShouldShow()

virtual bool realvirtual.OverlaySectionBase.ShouldShow ( GameObject  selectedObject )

virtual

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

Implements realvirtual.IOverlayButton.

Property Documentation

CssClass

virtual string realvirtual.OverlaySectionBase.CssClass

get

Additional CSS class names to apply to the section container.

SectionIcon

virtual Texture realvirtual.OverlaySectionBase.SectionIcon

get

Icon for the section header (optional, can be null)

SectionTitle

virtual string realvirtual.OverlaySectionBase.SectionTitle

get

Title of the section (optional, can be null)

ShowSeparator

virtual bool realvirtual.OverlaySectionBase.ShowSeparator

get

Whether to show a separator line above this section.