Class EditGameWindow

Main editor window used to modify scene objects. Provides Gizmos and camera viewport navigation.

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

Constructors

EditGameWindow(Editor)

Initializes a new instance of the EditGameWindow class.

Declaration
public EditGameWindow(Editor editor)
Parameters
Editor editor

The editor.

Fields

Viewport

The viewport control.

Declaration
public readonly MainEditorGizmoViewport Viewport
Field Value
MainEditorGizmoViewport

Properties

ActorToPilot

Gets the current actor that is during pilot action.

Declaration
public Actor ActorToPilot { get; }
Property Value
Actor

IsPilotActorActive

Gets a value indicating whether actor pilot feature is active and in use.

Declaration
public bool IsPilotActorActive { get; }
Property Value
System.Boolean

UseLayoutData

Gets a value indicating whether window uses custom layout data.

Declaration
public override bool UseLayoutData { get; }
Property Value
System.Boolean

Overrides

Methods

EndPilot()

Ends the actor piloting mode.

Declaration
public void EndPilot()

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides

OnEditorStateChanged()

Called when Editor state gets changed.

Declaration
public override void OnEditorStateChanged()
Overrides

OnLayoutDeserialize()

Called when during windows layout deserialization if window has no layout data to load. Can be used to restore default UI layout.

Declaration
public override void OnLayoutDeserialize()
Overrides

OnLayoutDeserialize(XmlElement)

Called when during windows layout deserialization. Each window can use it to load custom interface data (eg. splitter position).

Declaration
public override void OnLayoutDeserialize(XmlElement node)
Parameters
System.Xml.XmlElement node

The Xml document node.
Overrides

OnLayoutSerialize(XmlWriter)

Called when during windows layout serialization. Each window can use it to store custom interface data (eg. splitter position).

Declaration
public override void OnLayoutSerialize(XmlWriter writer)
Parameters
System.Xml.XmlWriter writer

The Xml writer.
Overrides

OnSceneUnloading(Scene, Guid)

Fired when scene gets unloading

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

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

The scene ID.
Overrides

PilotActor(Actor)

Moves viewport to the actor and attaches actor to the viewport to pilot it over the scene.

Declaration
public void PilotActor(Actor actor)
Parameters
Actor actor

The actor to pilot.

Update(Single)

Perform control update and all its children

Declaration
public override void Update(float deltaTime)
Parameters
System.Single deltaTime

Delta time in seconds
Overrides

Extension Methods

See Also