Class ViewportOptions

Editor viewport options data container.

System.Object
ViewportOptions
Namespace: FlaxEditor.Options
Assembly: FlaxEngine.CSharp.dll
Syntax
[CustomEditor]
public class ViewportOptions : Object

Constructors

ViewportOptions()

Declaration
public ViewportOptions()

Properties

CameraEasingDegree

Gets or sets the degree to which the camera will be eased when using camera flight in the editor window.

Declaration
[Limit(1F, 8F, 1F)]
[EditorDisplay("Camera", null)]
[EditorOrder(111)]
[Tooltip("The degree to which the camera will be eased when using camera flight in the editor window (ignored if camera easing degree is enabled).")]
public float CameraEasingDegree { get; set; }
Property Value
System.Single

FarPlane

Gets or sets the default far clipping plane distance for the viewport camera.

Declaration
[Limit(10F, 3.40282347E+38F, 1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(150)]
[Tooltip("The default far clipping plane distance for the viewport camera.")]
public float FarPlane { get; set; }
Property Value
System.Single

FieldOfView

Gets or sets the default field of view angle (in degrees) for the viewport camera.

Declaration
[Limit(35F, 160F, 0.1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(160)]
[Tooltip("The default field of view angle (in degrees) for the viewport camera.")]
public float FieldOfView { get; set; }
Property Value
System.Single

InvertMouseYAxisRotation

Gets or sets whether to invert the Y rotation of the mouse in the editor viewport.

Declaration
[EditorDisplay("General", null)]
[EditorOrder(102)]
[Tooltip("Whether to invert the Y rotation of the mouse in the editor viewport.")]
public bool InvertMouseYAxisRotation { get; set; }
Property Value
System.Boolean

InvertPanning

Gets or sets the default panning direction for the viewport camera.

Declaration
[EditorDisplay("Defaults", null)]
[EditorOrder(190)]
[Tooltip("The default panning direction for the viewport camera.")]
public bool InvertPanning { get; set; }
Property Value
System.Boolean

MaxMovementSpeed

Gets or sets the default maximum camera movement speed.

Declaration
[Limit(16F, 1000F, 1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(122)]
[Tooltip("The default maximum movement speed for the viewport camera.")]
public float MaxMovementSpeed { get; set; }
Property Value
System.Single

MinMovementSpeed

Gets or sets the default minimum camera movement speed.

Declaration
[Limit(0.05F, 32F, 1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(121)]
[Tooltip("The default minimum movement speed for the viewport camera.")]
public float MinMovementSpeed { get; set; }
Property Value
System.Single

MouseSensitivity

Gets or sets the mouse movement sensitivity scale applied when using the viewport camera.

Declaration
[Limit(0.01F, 100F, 1F)]
[EditorDisplay("General", null)]
[EditorOrder(100)]
[Tooltip("The mouse movement sensitivity scale applied when using the viewport camera.")]
public float MouseSensitivity { get; set; }
Property Value
System.Single

MouseWheelSensitivity

Gets or sets the mouse wheel sensitivity applied to zoom in orthographic mode.

Declaration
[Limit(0.01F, 100F, 1F)]
[EditorDisplay("General", null)]
[EditorOrder(101)]
[Tooltip("The mouse wheel sensitivity applied to zoom in orthographic mode.")]
public float MouseWheelSensitivity { get; set; }
Property Value
System.Single

MovementSpeed

Gets or sets the default movement speed for the viewport camera (must be in range between minimum and maximum movement speed values).

Declaration
[Limit(0.05F, 32F, 1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(120)]
[Tooltip("The default movement speed for the viewport camera (must be in range between minimum and maximum movement speed values).")]
public float MovementSpeed { get; set; }
Property Value
System.Single

NearPlane

Gets or sets the default near clipping plane distance for the viewport camera.

Declaration
[Limit(0.001F, 1000F, 1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(140)]
[Tooltip("The default near clipping plane distance for the viewport camera.")]
public float NearPlane { get; set; }
Property Value
System.Single

OrthographicScale

Gets or sets the default camera orthographic scale (if camera uses orthographic mode).

Declaration
[Limit(0.001F, 100000F, 0.1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(180)]
[Tooltip("The default camera orthographic scale (if camera uses orthographic mode).")]
public float OrthographicScale { get; set; }
Property Value
System.Single

PanningSpeed

Gets or sets the default panning speed (ignored if relative panning is speed enabled).

Declaration
[Limit(0.01F, 128F, 0.1F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(210)]
[Tooltip("The default camera panning speed (ignored if relative panning is enabled).")]
public float PanningSpeed { get; set; }
Property Value
System.Single

TotalCameraSpeedSteps

Gets or sets the total amount of steps the camera needs to go from minimum to maximum speed.

Declaration
[Limit(1F, 128F, 1F)]
[EditorDisplay("Camera", null)]
[EditorOrder(110)]
[Tooltip("The total amount of steps the camera needs to go from minimum to maximum speed.")]
public int TotalCameraSpeedSteps { get; set; }
Property Value
System.Int32

UseCameraEasing

Gets or sets the default camera easing mode.

Declaration
[EditorDisplay("Defaults", null)]
[EditorOrder(130)]
[Tooltip("The default camera easing mode.")]
public bool UseCameraEasing { get; set; }
Property Value
System.Boolean

UseOrthographicProjection

Gets or sets the default camera orthographic mode.

Declaration
[EditorDisplay("Defaults", null)]
[EditorOrder(170)]
[Tooltip("The default camera orthographic mode.")]
public bool UseOrthographicProjection { get; set; }
Property Value
System.Boolean

UseRelativePanning

Gets or sets the default relative panning mode.

Declaration
[EditorDisplay("Defaults", null)]
[EditorOrder(200)]
[Tooltip("The default relative panning mode. Uses distance between camera and target to determine panning speed.")]
public bool UseRelativePanning { get; set; }
Property Value
System.Boolean

ViewportGridColor

Gets or sets the grid color.

Declaration
[EditorDisplay("Grid", null)]
[EditorOrder(310)]
[Tooltip("The color for the viewport grid.")]
public Color ViewportGridColor { get; set; }
Property Value
Color

ViewportGridScale

Gets or sets the default editor viewport grid scale.

Declaration
[Limit(25F, 500F, 5F)]
[EditorDisplay("Defaults", null)]
[EditorOrder(220)]
[Tooltip("The default editor viewport grid scale.")]
public float ViewportGridScale { get; set; }
Property Value
System.Single

ViewportGridViewDistance

Gets or sets the view distance you can see the grid.

Declaration
[EditorDisplay("Grid", null)]
[EditorOrder(300)]
[Tooltip("The maximum distance you will be able to see the grid.")]
public float ViewportGridViewDistance { get; set; }
Property Value
System.Single

Extension Methods