Version: 2022.3
LanguageEnglish
  • C#

IMGUIOverlay

class in UnityEditor.Overlays

/

Inherits from:Overlays.Overlay

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

IMGUIOverlay is an implementation of Overlay that provides a IMGUIContainer.

Inherit IMGUIOverlay to author Overlay elements implemented using the legacy IMGUI controls.

Public Methods

CreatePanelContentCreatePanelContent is invoked by the OverlayCanvas when this Overlay is shown.
OnGUIImplement IMGUI controls and logic in this method.

Inherited Members

Static Properties

ussClassNameUSS class name of elements of this type.

Properties

collapsedDefines whether the overlay is in collapsed form.
collapsedIconDefines a custom icon to use when that overlay is in collapsed form.
containerWindowEditorWindow the overlay is contained within.
displayedShows or hides the overlay.
displayNameName of overlay used as title.
floatingReturns true if overlay is floating, returns false if overlay is docked in a corner or in a toolbar.
floatingPositionLocal position of closest overlay corner to closest dockposition when floating.
idOverlay unique ID.
isInToolbarReturns true if overlay is docked in a toolbar.
layoutDescribes the presentation mode for an Overlay.
maxSizeMaximum size of the Overlay.
minSizeMinimum size of the Overlay.
sizeSize of the Overlay.

Public Methods

CloseRemove the Overlay from its OverlayCanvas.
CreateContentCreate a new VisualElement containing the contents of this Overlay.
OnCreatedOnCreated is invoked when an Overlay is instantiated in an Overlay Canvas.
OnWillBeDestroyedCalled when an Overlay is about to be destroyed.
UndockIf this Overlay is currently in a toolbar, it will be removed and return to a floating state.

Events

collapsedChangedInvoked when Overlay.collapsed value is changed.
displayedChangedThis callback is invoked when the Overlay.displayed value has been changed.
floatingChangedCalled when the value of floating has changed.
floatingPositionChangedThis event is invoked when Overlay.floatingPosition is changed.
layoutChangedSubscribe to this event to be notified when the Overlay.Layout property is modified.