Class SceneTreeWindow

Windows used to present loaded scenes collection and whole scene graph.

System.Object
Control
ContainerControl
FlaxEngine.GUI.ScrollableControl
Panel
DockWindow
EditorWindow
SceneEditorWindow
SceneTreeWindow
Namespace: FlaxEditor.Windows
Assembly: FlaxEngine.CSharp.dll
Syntax
public class SceneTreeWindow : SceneEditorWindow, IComparable, IDrawable, ISceneEditingContext

Constructors

SceneTreeWindow(Editor)

Initializes a new instance of the SceneTreeWindow class.

Declaration
public SceneTreeWindow(Editor editor)
Parameters
Editor editor

The editor.

Properties

SceneTreePanel

Scene tree panel.

Declaration
public Panel SceneTreePanel { get; }
Property Value
Panel

Methods

Draw()

Draw the control and the children.

Declaration
public override void Draw()
Overrides

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides

OnDragDrop(ref Float2, DragData)

When mouse dragging drops on control's area

Declaration
public override DragDropEffect OnDragDrop(ref Float2 location, DragData data)
Parameters
Float2 location

Mouse location in Control Space
DragData data

The data. See DragDataText and DragDataFiles.
Returns
DragDropEffect

The drag event result effect.
Overrides

OnDragEnter(ref Float2, DragData)

When mouse dragging enters control's area

Declaration
public override DragDropEffect OnDragEnter(ref Float2 location, DragData data)
Parameters
Float2 location

Mouse location in Control Space
DragData data

The data. See DragDataText and DragDataFiles.
Returns
DragDropEffect

The drag event result effect.
Overrides

OnDragLeave()

When mouse dragging leaves control's area

Declaration
public override void OnDragLeave()
Overrides

OnDragMove(ref Float2, DragData)

When mouse dragging moves over control's area

Declaration
public override DragDropEffect OnDragMove(ref Float2 location, DragData data)
Parameters
Float2 location

Mouse location in Control Space
DragData data

The data. See DragDataText and DragDataFiles.
Returns
DragDropEffect

The drag event result effect.
Overrides

OnEditorStateChanged()

Called when Editor state gets changed.

Declaration
public override void OnEditorStateChanged()
Overrides

OnInit()

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

Declaration
public override void OnInit()
Overrides

OnLostFocus()

When control losts input focus

Declaration
public override void OnLostFocus()
Overrides

OnMouseDown(Float2, MouseButton)

When mouse goes down over control's area

Declaration
public override bool OnMouseDown(Float2 location, MouseButton buttons)
Parameters
Float2 location

Mouse location in Control Space
MouseButton buttons

Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnMouseUp(Float2, MouseButton)

When mouse goes up over control's area

Declaration
public override bool OnMouseUp(Float2 location, MouseButton buttons)
Parameters
Float2 location

Mouse location in Control Space
MouseButton buttons

Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnPlayBegin()

Called when Editor is entering play mode.

Declaration
public override void OnPlayBegin()
Overrides

OnPlayBeginning()

Called before Editor will enter play mode.

Declaration
public override void OnPlayBeginning()
Overrides

OnPlayEnd()

Called when Editor leaves the play mode.

Declaration
public override void OnPlayEnd()
Overrides

OnPlayEnding()

Called when Editor will leave the play mode.

Declaration
public override void OnPlayEnding()
Overrides

ScrollingOnSceneTreeView(Boolean)

Enables or disables vertical and horizontal scrolling on the scene tree panel.

Declaration
public void ScrollingOnSceneTreeView(bool enabled)
Parameters
System.Boolean enabled

The state to set scrolling to

ScrollToSelectedNode()

Scrolls to the selected node in the scene tree.

Declaration
public void ScrollToSelectedNode()

Events

ContextMenuShow

Occurs when scene tree window wants to show the context menu. Allows to add custom options.

Declaration
public event Action<ContextMenu> ContextMenuShow
Event Type
System.Action<FlaxEditor.GUI.ContextMenu.ContextMenu>

Extension Methods

See Also