realvirtual.OverlayButtonAttribute Class Reference

Generic attribute to mark custom overlay buttons for automatic discovery and registration. More...

Inheritance diagram for realvirtual.OverlayButtonAttribute:

Public Member Functions
	OverlayButtonAttribute (Type overlayType, double order=1000.0, string section="Custom")
	Creates a new OverlayButtonAttribute for a specific overlay type.

Properties
Type	OverlayType [get, set]
	Type of overlay this button should appear in (e.g., typeof(QuickEditOverlay))
double	Order [get, set]
	Display order of the button (decimal: integer=row, fractional=position in row) Lower values appear first.
string	Section [get, set]
	Section name for organizing buttons (e.g., "Transform", "Components", "Custom") Each overlay defines its own sections.
bool	FullWidth [get, set]
	Whether this button should take full width of the overlay.
Type	TargetComponentType [get, set]
	Type of component required for this button to be visible (optional) Example: typeof(Drive) - button only shows when Drive component is selected.
bool	RequiresSelection [get, set]
	Whether this button requires an active selection in the scene.
bool	PlayModeOnly [get, set]
	Whether this button is only available in play mode.
bool	EditModeOnly [get, set]
	Whether this button is only available in edit mode.
bool	EnabledByDefault [get, set]
	Whether this button is enabled by default.
string	Group [get, set]
	Optional group name for further organizing buttons within a section.

Detailed Description

Generic attribute to mark custom overlay buttons for automatic discovery and registration.

This attribute can be applied multiple times to register the same button in different overlays.

The decimal order system allows precise control over button placement:

• Integer part (e.g., 100) defines the row
• Decimal part (e.g., 0.1, 0.2) defines position within the row (left to right)

Example usage:

// Single overlay
[OverlayButton(typeof(QuickEditOverlay), order: 100.0, section: "Custom")]
public class MyButton : OverlayButtonBase { }
 
// Multiple overlays (same button in different overlays)
[OverlayButton(typeof(QuickEditOverlay), order: 100.0, section: "Components")]
[OverlayButton(typeof(DesOverlay), order: 50.0, section: "Tools")]
public class UniversalButton : OverlayButtonBase { }
 
// Same row with multiple buttons
[OverlayButton(typeof(QuickEditOverlay), order: 100.0, section: "Custom")]
public class Button1 : OverlayButtonBase { }  // Left-most
 
[OverlayButton(typeof(QuickEditOverlay), order: 100.1, section: "Custom")]
public class Button2 : OverlayButtonBase { }  // Middle
 
[OverlayButton(typeof(QuickEditOverlay), order: 100.2, section: "Custom")]
public class Button3 : OverlayButtonBase { }  // Right-most
 
// New row
[OverlayButton(typeof(QuickEditOverlay), order: 101.0, section: "Custom")]
public class Button4 : OverlayButtonBase { }  // New row

Constructor & Destructor Documentation

OverlayButtonAttribute()

realvirtual.OverlayButtonAttribute.OverlayButtonAttribute	(	Type	overlayType,
		double	order = 1000::0,
		string	section = "Custom"
	)

Creates a new OverlayButtonAttribute for a specific overlay type.

overlayType: Type of overlay (e.g., typeof(QuickEditOverlay)) order: Display order using decimal system (default: 1000.0) section: Section name (default: "Custom")

Property Documentation

EditModeOnly

bool realvirtual.OverlayButtonAttribute.EditModeOnly

getset

Whether this button is only available in edit mode.

EnabledByDefault

bool realvirtual.OverlayButtonAttribute.EnabledByDefault

getset

Whether this button is enabled by default.

FullWidth

bool realvirtual.OverlayButtonAttribute.FullWidth

getset

Whether this button should take full width of the overlay.

Group

string realvirtual.OverlayButtonAttribute.Group

getset

Optional group name for further organizing buttons within a section.

Order

double realvirtual.OverlayButtonAttribute.Order

getset

Display order of the button (decimal: integer=row, fractional=position in row) Lower values appear first.

Examples:

• 100.0, 100.1, 100.2 = same row, positions 0, 1, 2
• 101.0 = new row

OverlayType

Type realvirtual.OverlayButtonAttribute.OverlayType

getset

Type of overlay this button should appear in (e.g., typeof(QuickEditOverlay))

PlayModeOnly

bool realvirtual.OverlayButtonAttribute.PlayModeOnly

getset

Whether this button is only available in play mode.

RequiresSelection

bool realvirtual.OverlayButtonAttribute.RequiresSelection

getset

Whether this button requires an active selection in the scene.

Section

string realvirtual.OverlayButtonAttribute.Section

getset

Section name for organizing buttons (e.g., "Transform", "Components", "Custom") Each overlay defines its own sections.

Use "Custom" for new sections.

TargetComponentType

Type realvirtual.OverlayButtonAttribute.TargetComponentType

getset

Type of component required for this button to be visible (optional) Example: typeof(Drive) - button only shows when Drive component is selected.