Search Results for

    Show / Hide Table of Contents

    Class EditorWindow

    Base class for all windows in Editor.

    Inheritance
    System.Object
    Control
    ContainerControl
    FlaxEngine.GUI.ScrollableControl
    Panel
    DockWindow
    EditorWindow
    AssetEditorWindow
    VideoWindow
    ContentWindow
    DebugLogWindow
    EditorOptionsWindow
    GameCookerWindow
    GameWindow
    GraphicsQualityWindow
    OutputLogWindow
    PluginsWindow
    ProfilerWindow
    RenameWindow
    SceneEditorWindow
    StyleEditorWindow
    ToolboxWindow
    VisualScriptDebuggerWindow
    Implements
    System.IComparable
    IDrawable
    Inherited Members
    DockWindow._masterPanel
    DockWindow._dockedTo
    DockWindow.InputActions
    DockWindow.ShowFloating()
    DockWindow.ShowFloating(WindowStartPosition)
    DockWindow.ShowFloating(Float2, WindowStartPosition)
    DockWindow.ShowFloating(Float2, Float2, WindowStartPosition)
    DockWindow.Show(DockState, DockPanel, Boolean, Nullable<Single>)
    DockWindow.Show(DockState, DockWindow)
    DockWindow.FocusOrShow()
    DockWindow.FocusOrShow(DockState)
    DockWindow.Hide()
    DockWindow.Close(ClosingReason)
    DockWindow.SelectTab(Boolean)
    DockWindow.BringToFront()
    DockWindow.OnUnlink()
    DockWindow.Undock()
    DockWindow.OnClosing(ClosingReason)
    DockWindow.OnClose()
    DockWindow.OnShow()
    DockWindow.OnLayoutSerialize(XmlWriter)
    DockWindow.OnLayoutDeserialize(XmlElement)
    DockWindow.OnLayoutDeserialize()
    DockWindow.LayoutSerializeSplitter(XmlWriter, String, SplitPanel)
    DockWindow.LayoutDeserializeSplitter(XmlElement, String, SplitPanel)
    DockWindow.Focus()
    DockWindow.PerformLayoutBeforeChildren()
    DockWindow.OnShowContextMenu(ContextMenu)
    DockWindow.HideOnClose
    DockWindow.MasterPanel
    DockWindow.ParentDockPanel
    DockWindow.IsDocked
    DockWindow.IsSelected
    DockWindow.IsHidden
    DockWindow.DefaultSize
    DockWindow.SerializationTypename
    DockWindow.Title
    DockWindow.Icon
    DockWindow.TitleSize
    DockWindow.UseLayoutData
    Panel.SetViewOffset(Float2)
    Panel.FastScroll()
    Panel.ScrollViewTo(Control, Boolean)
    Panel.ScrollViewTo(Float2, Boolean)
    Panel.ScrollViewTo(Rectangle, Boolean)
    Panel.OnMouseDown(Float2, MouseButton)
    Panel.OnMouseWheel(Float2, Single)
    Panel.RemoveChildren()
    Panel.DisposeChildren()
    Panel.OnChildResized(Control)
    Panel.Draw()
    Panel.ContainsPoint(Float2, Boolean)
    Panel.IntersectsChildContent(Control, Float2, Float2)
    Panel.PerformLayout(Boolean)
    Panel.ArrangeAndGetBounds()
    Panel.Arrange()
    Panel.GetDesireClientArea(Rectangle)
    Panel.OnDragMove(Float2, DragData)
    Panel.ViewBottom
    Panel.ControlsBounds
    Panel.ScrollBars
    Panel.ScrollBarsSize
    Panel.AlwaysShowScrollbars
    Panel.ScrollMargin
    Panel.ScrollbarTrackColor
    Panel.ScrollbarThumbColor
    Panel.ScrollbarThumbSelectedColor
    ContainerControl._children
    ContainerControl._containsFocus
    ContainerControl._isLayoutLocked
    ContainerControl.LockChildrenRecursive()
    ContainerControl.UnlockChildrenRecursive()
    ContainerControl.AddChild<T>()
    ContainerControl.AddChild<T>(T)
    ContainerControl.RemoveChild(Control)
    ContainerControl.GetChild(Int32)
    ContainerControl.GetChild<T>()
    ContainerControl.GetChildIndex(Control)
    ContainerControl.GetChildIndexAt(Float2)
    ContainerControl.GetChildAt(Float2)
    ContainerControl.GetChildAt(Float2, Func<Control, Boolean>)
    ContainerControl.GetChildAtRecursive(Float2)
    ContainerControl.GetClientArea()
    ContainerControl.SortChildren()
    ContainerControl.SortChildrenRecursive()
    ContainerControl.OnChildrenChanged()
    ContainerControl.OnNavigate(NavDirection, Float2, Control, List<Control>)
    ContainerControl.CanNavigateChild(Control)
    ContainerControl.NavigationWrap(NavDirection, Float2, List<Control>, Float2)
    ContainerControl.UpdateContainsFocus()
    ContainerControl.UpdateChildrenBounds()
    ContainerControl.PerformLayoutAfterChildren()
    ContainerControl.Update(Single)
    ContainerControl.ClearState()
    ContainerControl.DrawSelf()
    ContainerControl.DrawChildren()
    ContainerControl.RayCast(Float2, Control)
    ContainerControl.OnMouseEnter(Float2)
    ContainerControl.OnMouseMove(Float2)
    ContainerControl.OnMouseLeave()
    ContainerControl.OnMouseUp(Float2, MouseButton)
    ContainerControl.OnMouseDoubleClick(Float2, MouseButton)
    ContainerControl.IsTouchPointerOver(Int32)
    ContainerControl.OnTouchEnter(Float2, Int32)
    ContainerControl.OnTouchDown(Float2, Int32)
    ContainerControl.OnTouchMove(Float2, Int32)
    ContainerControl.OnTouchUp(Float2, Int32)
    ContainerControl.OnTouchLeave(Int32)
    ContainerControl.OnCharInput(Char)
    ContainerControl.OnKeyUp(KeyboardKeys)
    ContainerControl.OnDragEnter(Float2, DragData)
    ContainerControl.OnDragLeave()
    ContainerControl.OnDragDrop(Float2, DragData)
    ContainerControl.OnSizeChanged()
    ContainerControl.Children
    ContainerControl.ChildrenCount
    ContainerControl.HasChildren
    ContainerControl.ContainsFocus
    ContainerControl.ClipChildren
    ContainerControl.CullChildren
    ContainerControl.IsTouchOver
    Control.Resize(Float2)
    Control.UpdateBounds()
    Control.UpdateTransform()
    Control.SetAnchorPreset(AnchorPresets, Boolean, Boolean)
    Control.Dispose()
    Control.Defocus()
    Control.OnGotFocus()
    Control.OnLostFocus()
    Control.OnStartContainsFocus()
    Control.OnEndContainsFocus()
    Control.Focus(Control)
    Control.StartMouseCapture(Boolean)
    Control.EndMouseCapture()
    Control.OnEndMouseCapture()
    Control.GetNavTarget(NavDirection)
    Control.GetNavOrigin(NavDirection)
    Control.NavigationFocus()
    Control.OnSubmit()
    Control.OnTouchLeave()
    Control.DoDragDrop(DragData)
    Control.LinkTooltip(String, Tooltip)
    Control.UnlinkTooltip()
    Control.OnShowTooltip(String, Float2, Rectangle)
    Control.OnTooltipShown(Tooltip)
    Control.OnTestTooltipOverControl(Float2)
    Control.IntersectsContent(Float2, Float2)
    Control.PointToParent(ContainerControl, Float2)
    Control.PointToParent(Float2)
    Control.PointToParent(Float2)
    Control.PointFromParent(Float2)
    Control.PointFromParent(Float2)
    Control.PointFromParent(ContainerControl, Float2)
    Control.PointToWindow(Float2)
    Control.PointFromWindow(Float2)
    Control.PointToScreen(Float2)
    Control.PointFromScreen(Float2)
    Control.OnLocationChanged()
    Control.SetScaleInternal(Float2)
    Control.SetPivotInternal(Float2)
    Control.SetShearInternal(Float2)
    Control.SetRotationInternal(Single)
    Control.OnVisibleChanged()
    Control.OnParentChangedInternal()
    Control.AddUpdateCallbacks(RootControl)
    Control.RemoveUpdateCallbacks(RootControl)
    Control.SetUpdate(Control.UpdateDelegate, Control.UpdateDelegate)
    Control.OnParentResized()
    Control.CompareTo(Object)
    Control.Compare(Control)
    Control.Top
    Control.Bottom
    Control.Left
    Control.Right
    Control.UpperLeft
    Control.UpperRight
    Control.BottomRight
    Control.BottomLeft
    Control.Scale
    Control.Pivot
    Control.Shear
    Control.Rotation
    Control.HasParent
    Control.BackgroundColor
    Control.BackgroundBrush
    Control.Enabled
    Control.EnabledInHierarchy
    Control.Visible
    Control.VisibleInHierarchy
    Control.IsDisposing
    Control.Root
    Control.RootWindow
    Control.DpiScale
    Control.ScreenPos
    Control.AutoFocus
    Control.IsFocused
    Control.IsNavFocused
    Control.IsMouseOver
    Control.IsDragOver
    Control.Tooltip
    Control.ShowTooltip
    Control.EditorBounds
    Control.LocationChanged
    Control.SizeChanged
    Control.ParentChanged
    Control.VisibleChanged
    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
    DockWindow.OnDestroy()

    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
    DockWindow.OnKeyDown(KeyboardKeys)

    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()

    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

    Extensions.ReflectiveCompare<T>(T, T)
    Extensions.RawClone<T>(T)

    See Also

    DockWindow
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat