Class VisualOptions

Visual editor options data container.

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

Constructors

VisualOptions()

Declaration
public VisualOptions()

Fields

ColorDebugLogText

Gets or sets a value wether the Debug Log entry text color should use the set color.

Declaration
[EditorDisplay("Log", "Color Debug Log Text")]
[EditorOrder(1503)]
[Tooltip("Wether to use the set colors in the text of a Debug Log entry.")]
public bool ColorDebugLogText
Field Value
System.Boolean

Properties

EnableMSAAForDebugDraw

Gets or sets a value indicating whether enable MSAA for DebugDraw primitives rendering. Helps with pixel aliasing but reduces performance.

Declaration
[EditorDisplay("Quality", "Enable MSAA For Debug Draw")]
[EditorOrder(500)]
[Tooltip("Determines whether enable MSAA for DebugDraw primitives rendering. Helps with pixel aliasing but reduces performance.")]
public bool EnableMSAAForDebugDraw { get; set; }
Property Value
System.Boolean

EnableParticlesPreview

Gets or sets a value indicating whether show looping particle effects in Editor viewport to simulate in-game look.

Declaration
[EditorDisplay("Preview", null)]
[EditorOrder(1000)]
public bool EnableParticlesPreview { get; set; }
Property Value
System.Boolean

GizmoSize

Gets or sets the transform gizmo size.

Declaration
[Limit(0.01F, 100F, 0.01F)]
[EditorDisplay("Transform Gizmo", null)]
[EditorOrder(110)]
[Tooltip("The transform gizmo size.")]
public float GizmoSize { get; set; }
Property Value
System.Single

HighlightColor

Gets or sets the color used to highlight selected meshes and CSG surfaces.

Declaration
[EditorDisplay("Transform Gizmo", null)]
[EditorOrder(200)]
[Tooltip("The color used to highlight selected meshes and CSG surfaces.")]
public Color HighlightColor { get; set; }
Property Value
Color

LogErrorColor

Gets or sets the output log text color for errors

Declaration
[EditorDisplay("Log", "Error Color")]
[EditorOrder(1502)]
[Tooltip("The color used for errors in the Debug and Output Log.")]
public Color LogErrorColor { get; set; }
Property Value
Color

LogInfoColor

Gets or sets the output log text color.

Declaration
[EditorDisplay("Log", "Info Color")]
[EditorOrder(1500)]
[Tooltip("The color used for info messages in the Debug and Output Log.")]
public Color LogInfoColor { get; set; }
Property Value
Color

LogWarningColor

Gets or sets the output log text color for warnings

Declaration
[EditorDisplay("Log", "Warning Color")]
[EditorOrder(1501)]
[Tooltip("The color used for warnings in the Debug and Output Log.")]
public Color LogWarningColor { get; set; }
Property Value
Color

SelectionOutlineColor0

Gets or sets the first outline color.

Declaration
[EditorDisplay("Transform Gizmo", null)]
[EditorOrder(100)]
[Tooltip("The first color of the selection outline gradient.")]
public Color SelectionOutlineColor0 { get; set; }
Property Value
Color

SelectionOutlineColor1

Gets or sets the second outline color.

Declaration
[EditorDisplay("Transform Gizmo", null)]
[EditorOrder(101)]
[Tooltip("The second color of the selection outline gradient.")]
public Color SelectionOutlineColor1 { get; set; }
Property Value
Color

ShowSelectionOutline

Gets or sets the selection outline enable flag.

Declaration
[EditorDisplay("Gizmo", null)]
[EditorOrder(99)]
[Tooltip("If checked, the selection outline will be visible.")]
public bool ShowSelectionOutline { get; set; }
Property Value
System.Boolean

TransformGizmoBrightness

Gets or set a value indicating how bright the transform gizmo is. Value over 1 will result in the gizmo emitting light.

Declaration
[Range(0F, 5F)]
[EditorDisplay("Transform Gizmo", "Gizmo Brightness")]
[EditorOrder(210)]
public float TransformGizmoBrightness { get; set; }
Property Value
System.Single

TransformGizmoOpacity

Gets or set a value indicating the opacity of the transform gizmo.

Declaration
[Range(0F, 1F)]
[EditorDisplay("Transform Gizmo", "Gizmo Opacity")]
[EditorOrder(211)]
public float TransformGizmoOpacity { get; set; }
Property Value
System.Single

UIAnchorColor

Gets or sets the anchor color for the UI Gizmo.

Declaration
[EditorDisplay("UI Gizmo", "Anchor Color")]
[EditorOrder(103)]
[Tooltip("The color of the anchors for the UI Gizmo.")]
public Color UIAnchorColor { get; set; }
Property Value
Color

UIPivotColor

Gets or sets the pivot color for the UI Gizmo.

Declaration
[EditorDisplay("UI Gizmo", "Pivot Color")]
[EditorOrder(103)]
[Tooltip("The color of the pivot for the UI Gizmo.")]
public Color UIPivotColor { get; set; }
Property Value
Color

UISelectionOutlineSize

Gets or sets the selection outline size for UI controls.

Declaration
[EditorDisplay("UI Gizmo", "UI Control Outline Size")]
[EditorOrder(103)]
[Tooltip("The size of the selection outline for UI controls.")]
public float UISelectionOutlineSize { get; set; }
Property Value
System.Single

Extension Methods