Class EditorGizmoViewport

Viewport with free camera and gizmo tools.

System.Object
Control
ContainerControl
FlaxEngine.GUI.RenderOutputControl
EditorViewport
EditorGizmoViewport
MainEditorGizmoViewport
System.IComparable
Namespace: FlaxEditor.Viewport
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class EditorGizmoViewport : EditorViewport, IComparable, IDrawable, IGizmoOwner

Constructors

EditorGizmoViewport(SceneRenderTask, Undo, RootNode)

Initializes a new instance of the EditorGizmoViewport class.

Declaration
public EditorGizmoViewport(SceneRenderTask task, Undo undo, RootNode sceneGraphRoot)
Parameters
SceneRenderTask task

The task.
Undo undo

The undo.
FlaxEditor.SceneGraph.RootNode sceneGraphRoot

The scene graph root.

Properties

Gizmos

Declaration
public GizmosCollection Gizmos { get; }
Property Value
FlaxEditor.Gizmo.GizmosCollection

IsAltKeyDown

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

IsControlDown

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

IsControllingMouse

Gets a value indicating whether this viewport is using mouse currently (eg. user moving objects).

Declaration
protected override bool IsControllingMouse { get; }
Property Value
System.Boolean

Overrides

IsLeftMouseButtonDown

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

IsRightMouseButtonDown

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

MouseDelta

Declaration
public Float2 MouseDelta { get; }
Property Value
Float2

RenderTask

Declaration
public SceneRenderTask RenderTask { get; }
Property Value
SceneRenderTask

SceneGraphRoot

Declaration
public RootNode SceneGraphRoot { get; }
Property Value
FlaxEditor.SceneGraph.RootNode

SnapToGround

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

SnapToVertex

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

Undo

Declaration
public Undo Undo { get; }
Property Value
Undo

UseDuplicate

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

UseSnapping

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

ViewFarPlane

Declaration
public float ViewFarPlane { get; }
Property Value
System.Single

Viewport

Declaration
public EditorViewport Viewport { get; }
Property Value
EditorViewport

Methods

AddUpdateCallbacks(RootControl)

Adds the custom control logic update callbacks to the root.

Declaration
protected override void AddUpdateCallbacks(RootControl root)
Parameters
RootControl root

The root.
Overrides

OnDestroy()

Declaration
public override void OnDestroy()
Overrides

OpenContextMenu()

Declaration
public abstract void OpenContextMenu()

RemoveUpdateCallbacks(RootControl)

Removes the custom control logic update callbacks from the root.

Declaration
protected override void RemoveUpdateCallbacks(RootControl root)
Parameters
RootControl root

The root.
Overrides

Select(List<SceneGraphNode>)

Declaration
public abstract void Select(List<SceneGraphNode> nodes)
Parameters
System.Collections.Generic.List<FlaxEditor.SceneGraph.SceneGraphNode> nodes

Spawn(Actor)

Declaration
public abstract void Spawn(Actor actor)
Parameters
Actor actor

Extension Methods

See Also

FlaxEditor.Gizmo.IGizmoOwner