Class EditorWindow

Base class for all windows in Editor.

System.IComparable
Namespace: FlaxEditor.Windows
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class EditorWindow : DockWindow, IComparable, IDrawable

Constructors

EditorWindow(Editor, Boolean, ScrollBars)

Initializes a new instance of the EditorWindow class.

Declaration
protected EditorWindow(Editor editor, bool hideOnClose, ScrollBars scrollBars)
Parameters
Editor editor

The editor.
System.Boolean hideOnClose

True if hide window on closing, otherwise it will be destroyed.
ScrollBars scrollBars

The scroll bars.

Fields

Editor

Gets the editor object.

Declaration
public readonly Editor Editor
Field Value
Editor

Properties

CanOpenContentFinder

Gets a value indicating whether this window can open content finder popup.

Declaration
protected virtual bool CanOpenContentFinder { get; }
Property Value
System.Boolean

CanUseNavigation

Gets a value indicating whether this window can use UI navigation (tab/enter).

Declaration
protected virtual bool CanUseNavigation { get; }
Property Value
System.Boolean

Methods

IsEditingItem(ContentItem)

Determines whether this window is holding reference to the specified item.

Declaration
public virtual bool IsEditingItem(ContentItem item)
Parameters
FlaxEditor.Content.ContentItem item

The item.
Returns
System.Boolean

true if window is editing the specified item; otherwise, false.

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides

OnEditorStateChanged()

Called when Editor state gets changed.

Declaration
public virtual void OnEditorStateChanged()

OnExit()

Called when editor is being closed and window should perform release data operations.

Declaration
public virtual void OnExit()

OnInit()

Called when window should be initialized. At this point, main window, content database, default editor windows are ready.

Declaration
public virtual void OnInit()

OnKeyDown(KeyboardKeys)

When key goes down

Declaration
public override bool OnKeyDown(KeyboardKeys key)
Parameters
KeyboardKeys key

Key value
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnPlayBegin()

Called when Editor is entering play mode.

Declaration
public virtual void OnPlayBegin()

OnPlayBeginning()

Called before Editor will enter play mode.

Declaration
public virtual void OnPlayBeginning()

OnPlayEnd()

Called when Editor leaves the play mode.

Declaration
public virtual void OnPlayEnd()

OnPlayEnding()

Called when Editor will leave the play mode.

Declaration
public virtual void OnPlayEnding()

OnSceneLoaded(Scene, Guid)

Fired when scene gets loaded

Declaration
public virtual void OnSceneLoaded(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneLoadError(Scene, Guid)

Fired when scene cannot be loaded

Declaration
public virtual void OnSceneLoadError(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneLoading(Scene, Guid)

Fired when scene starts loading

Declaration
public virtual void OnSceneLoading(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneSaved(Scene, Guid)

Fired when scene gets saved

Declaration
public virtual void OnSceneSaved(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneSaveError(Scene, Guid)

Fired when scene gets saving error

Declaration
public virtual void OnSceneSaveError(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneSaving(Scene, Guid)

Fired when scene starts saving

Declaration
public virtual void OnSceneSaving(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneUnloaded(Scene, Guid)

Fired when scene gets unloaded

Declaration
public virtual void OnSceneUnloaded(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnSceneUnloading(Scene, Guid)

Fired when scene gets unloading

Declaration
public virtual void OnSceneUnloading(Scene scene, Guid sceneId)
Parameters
Scene scene

The scene object. It may be null!
System.Guid sceneId

The scene ID.

OnUpdate()

Called when every engine update. Note: Update(Single) may be called at the lower frequency than the engine updates.

Declaration
public virtual void OnUpdate()

Extension Methods

See Also