1. Epic GamesDeveloper
  3. ULevelEditorViewportSettings

ULevelEditorViewportSettings

Implements the Level Editor's view port settings.

API > API/Editor > API/Editor/UnrealEd

Implements the Level Editor's view port settings.

   
Name ULevelEditorViewportSettings
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Settings/LevelEditorViewportSettings.h
Include Path #include "Settings/LevelEditorViewportSettings.h"

Syntax

UCLASS (Config=EditorPerProjectUserSettings, MinimalAPI)  
class ULevelEditorViewportSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ULevelEditorViewportSettings ( const FObjectInitializer& ObjectInitializer
)

   Settings/LevelEditorViewportSettings.h  

Classes

Name Remarks
FSettingChangedEvent Returns an event delegate that is executed when a setting has changed.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActiveSnapLayerIndex int32 The index of the snap plane to use when 2D Layer Snapping is enabled, from the array of Snap Layers set for the project. Settings/LevelEditorViewportSettings.h
  • Config
ActorSnapDistance float Global actor snap distance setting for the editor Settings/LevelEditorViewportSettings.h
  • Config
ActorSnapScale float Global actor snap scale for the editor Settings/LevelEditorViewportSettings.h
  • Config
  • Category=GridSnapping
  • VisibleDefaultsOnly
  • AdvancedDisplay
AspectRatioAxisConstraint TEnumAsByte< enum EAspectRatioAxisConstraint > How to constrain perspective view port FOV Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
BackgroundDropDistance float Distance from the camera to place actors which are dropped on nothing in the view port. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(DisplayName="Background Drop Distance")
bAllowArcballRotate uint32 Allow arcball rotation with rotate widget Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Enable Arcball Rotate")
bAllowEditWidgetAxisDisplay uint32 If true, the Edit widget of a transform will display the axis Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Enable Axis drawing for transform Edit Widget")
bAllowScreenRotate uint32 Allow screen rotation with rotate widget Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Enable Screen Rotate")
bAllowTranslateRotateZWidget uint32 Allow translate/rotate widget Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Enable Combined Translate/Rotate Widget")
bCenterZoomAroundCursor uint32 If checked, in orthographic view ports zooming will center on the mouse position. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Orthographic Zoom to Cursor Position")
bClickBSPSelectsBrush uint32 If true, Clicking a BSP selects the brush and ctrl+shift+click selects the surface. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Clicking BSP Enables Brush")
  • AdvancedDisplay
bEnableActorSnap uint32 If true actor snap will be enabled in the editor Settings/LevelEditorViewportSettings.h
  • Config
  • Category=GridSnapping
  • VisibleDefaultsOnly
  • AdvancedDisplay
bEnableLayerSnap uint32 If enabled, new Actors that you drag into the viewport snap to the active 2D layer. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
  • Meta=(DisplayName="Enable 2D Layer Snapping")
bEnableViewportCameraToUpdateFromPIV uint32 Enables the editor perspective camera to be dropped at the last PlayInViewport cam position Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Use Camera Location from Play-In-Viewport")
bEnableViewportHoverFeedback uint32 Enables real-time hover feedback when mousing over objects in editor view ports Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Highlight Objects Under Mouse Cursor")
bHighlightWithBrackets uint32 If enabled, selected objects will be highlighted with brackets in all modes rather than a special highlight color. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(DisplayName="Highlight Selected Objects with Brackets")
BillboardScale float   Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=LookAndFeel
  • Meta=(ClampMin="0.01", UIMin="0.01", UIMax="5")
bInvertMiddleMousePan bool Whether or not to invert the direction of middle mouse panning in viewports Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
bInvertMouseLookYAxis bool Whether or not to invert mouse on the y axis in free look mode Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Invert Mouse Look Y Axis")
bInvertOrbitYAxis bool Whether or not to invert mouse on y axis in orbit mode Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Invert Orbit Y Axis")
bInvertRightMouseDollyYAxis bool Whether or not to invert the direction of right mouse dolly on the Y axis in orbit mode Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
bLevelEditorJoystickControls bool Enables joystick-based camera movement in 3D level editing viewports Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Level Editor Joystick Controls")
bLevelStreamingVolumePrevis bool If enabled, the viewport will stream in levels automatically when the camera is moved. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Stream in Levels Automatically when Camera is Moved")
  • AdvancedDisplay
bOrbitCameraAroundSelection bool If enabled, the camera will orbit around the current selection in the viewport Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Orbit camera around selection")
  • AdvancedDisplay
bPanMovesCanvas uint32 If true, moves the canvas and shows the mouse. If false, uses original camera movement. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Grab and Drag to Move Orthographic Cameras")
  • AdvancedDisplay
bPreviewSelectedCameras uint32 When enabled, selecting a camera actor will display a live 'picture in picture' preview from the camera's perspective within the current editor view port. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
bSaveEngineStats uint32 When enabled, engine stats that are enabled in level viewports are preserved between editor sessions Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=LookAndFeel
bShowActorEditorContext uint32 If true, viewport will show actor editor context (current level, current data layer(s), current folder) Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(AdvancedDisplay)
bShowBrushMarkerPolys uint32 If true, show translucent marker polygons on the builder brush and volumes. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
bSnapVertices bool   Settings/LevelEditorViewportSettings.h
  • Config
BSPSelectionHighlightIntensity float Sets the intensity of the overlay displayed when an object is selected Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(DisplayName="BSP Surface Highlight Intensity", ClampMin="0", UIMin="0", UIMax="1")
bStrictBoxSelection uint32 True if viewport box selection requires objects to be fully encompassed by the selection box to be selected Settings/LevelEditorViewportSettings.h
  • Config
bTransparentBoxSelection uint32 True if viewport box selection also selects occluded objects, false if only objects with visible pixels are selected Settings/LevelEditorViewportSettings.h
  • Config
bUseAbsoluteTranslation uint32 Whether to use mouse position as direct widget position. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • AdvancedDisplay
bUseDistanceScaledCameraSpeed bool If enabled, scale the perspective camera speed based on the distance between the camera and its look-at position Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Use distance-scaled camera speed")
  • AdvancedDisplay
bUseLegacyCameraMovementNotifications uint32 Camera movement notification toggle to switch back to the behavior that caused camera notifications to be sent during gizmo movement. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
bUseLinkedOrthographicViewports uint32 If checked all orthographic view ports are linked to the same position and move together. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Link Orthographic Viewport Movement")
bUseLODViewLocking uint32 BUseLODViewLocking is added to keep around a legacy command from FLevelEditorCommands, as we are removing the Level Editor Settings menu. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Enable LOD View Locking")
bUsePowerOf2SnapSize bool If enabled will use power of 2 grid settings (e.g, 1,2,4,8,16,...,1024) instead of decimal grid sizes Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
  • Meta=(DisplayName="Use Power of Two Snap Size")
bUseSelectionOutline uint32 Whether to show selection outlines for selected Actors Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Use Selection Outline")
bUseUE3OrbitControls bool When checked, orbit the camera by using the L or U keys when unchecked, Alt and Left Mouse Drag will orbit around the look at point Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Use UE3 Orbit Controls")
  • AdvancedDisplay
bWorldSpaceVerticalPan bool If enabled, vertical movements of the mouse while panning with the middle mouse button will move the camera vertically in world space. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
CameraPreviewSize float Affects the size of 'picture in picture' previews if they are enabled Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(ClampMin="1", UIMin="1", UIMax="10")
CameraSpeedSettings FEditorViewportCameraSpeedSettings The camera speed settings for level viewports. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
CommonRotGridSizes TArray< float > User defined grid intervals for rotations Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
CurrentPosGridSize int32   Settings/LevelEditorViewportSettings.h
  • Config
CurrentRotGridMode TEnumAsByte< ERotationGridMode > Controls which array of rotation grid values we are using Settings/LevelEditorViewportSettings.h
  • Config
CurrentRotGridSize int32   Settings/LevelEditorViewportSettings.h
  • Config
CurrentScalingGridSize int32   Settings/LevelEditorViewportSettings.h
  • Config
DecimalGridIntervals TArray< float > The number of lines between each major line interval for decimal grids Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
DecimalGridSizes TArray< float > Decimal grid sizes (for translation snapping and grid rendering) Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
DivisionsOf360RotGridSizes TArray< float > Preset grid intervals for rotations Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
EditorViews TMap< TSoftObjectPtr< UWorld >, FLevelEditorViewporEditorViews > Store the last camera settings for all the viewport of each world loaded in the editor. Settings/LevelEditorViewportSettings.h
  • Config
FlightCameraControlExperimentalNavigation bool Enable the use of the experimental navigation in the flight camera controls. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
FlightCameraControlType TEnumAsByte< EWASDType > Enable the use of flight camera controls under various circumstances. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
FoliageEditorControlType ELandscapeFoliageEditorControlType Choose the control scheme for foliage tools Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
GridEnabled uint32 If enabled, actor positions will snap to the grid. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
  • Meta=(DisplayName="Enable Grid Snapping")
LandscapeEditorControlType ELandscapeFoliageEditorControlType Choose the control scheme for landscape tools (ignored for pen input) Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
LastInViewportMenuLocation FVector2D   Settings/LevelEditorViewportSettings.h
  • Config
MarqueeSelectionMode EMarqueeSelectionMode Sets how marquee selection should behave. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Behavior
MaterialForDroppedTextures TSoftObjectPtr< class UMaterialInterface > When dropping a texture in the viewport, create an instance of this material instead of creating a new material. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Behavior
MaterialParamsForDroppedTextures TMap< EMaterialKind, FName > When dropping a texture in the viewport, determines which material parameter to assign for each found texture type. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Behavior
MeasuringToolUnits TEnumAsByte< EMeasuringToolUnits > Specify the units used by the measuring tool Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
MinimumOrthographicZoom float The closest possible distance allowed when viewing through an orthographic camera Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(UIMin="1.0", ClampMin="1.0")
MouseScrollCameraSpeed int32 How fast the perspective camera moves through the world when using mouse scroll. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(UIMin="1", UIMax="8", ClampMin="1", ClampMax="8")
MouseSensitivty float The sensitivity of mouse movement when rotating the camera. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Mouse Sensitivity", ClampMin="0.01", ClampMax="1.0")
Pow2GridIntervals TArray< float > The number of lines between each major line interval for pow2 grids Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
Pow2GridSizes TArray< float > Power of 2 grid sizes (for translation snapping and grid rendering) Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
PreserveNonUniformScale bool   Settings/LevelEditorViewportSettings.h
  • Config
PreviewMeshes TArray< FSoftObjectPath > A list of meshes that can be used as preview mesh in the editor view port by holding down the backslash key Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Preview
  • Meta=(AllowedClasses="/Script/Engine.StaticMesh")
PropertyColorationColorForMatchingObjects FColor Property coloration color for matching objects Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
RotGridEnabled uint32 If enabled, actor rotations will snap to the grid. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
  • Meta=(DisplayName="Enable Rotation Snapping")
ScalingGridSizes TArray< float > Grid sizes for scaling Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • AdvancedDisplay
  • Category=GridSnapping
ScrollGestureDirectionFor3DViewports EScrollGestureDirection Direction of the scroll gesture for 3D viewports Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Scroll gesture direction for 3D viewports")
ScrollGestureDirectionForOrthoViewports EScrollGestureDirection Direction of the scroll gesture for orthographic viewports Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=Controls
  • Meta=(DisplayName="Scroll gesture direction for orthographic viewports")
SelectedSplinePointSizeAdjustment float The size adjustment to apply to selected spline points (in screen space units). Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(ClampMin="-5.00", ClampMax="20.00")
SelectionHighlightIntensity float Sets the intensity of the overlay displayed when an object is selected Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • Meta=(DisplayName="Selection Highlight Intensity", ClampMin="0", UIMin="0", UIMax="1")
SnapDistance float   Settings/LevelEditorViewportSettings.h
  • Config
SnapScaleEnabled uint32 If enabled, actor sizes will snap to the grid. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
  • Meta=(DisplayName="Enable Scale Snapping")
SnapToSurface FSnapToSurfaceSettings If enabled, actors will snap to surfaces in the viewport when dragged around Settings/LevelEditorViewportSettings.h
  • Config
SplineLineThicknessAdjustment float The size adjustment to apply to spline line thickness which increases the spline's hit tolerance. Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(ClampMin="0.00")
SplineTangentHandleSizeAdjustment float The size adjustment to apply to spline tangent handle (in screen space units). Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(ClampMin="-5.00", ClampMax="20.00")
SplineTangentScale float The scale to apply to spline tangent lengths Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=LookAndFeel
  • AdvancedDisplay
  • Meta=(ClampMin="0.00")

Protected

Name Type Remarks Include Path Unreal Specifiers
bUsePercentageBasedScaling uint32 If enabled, use the old-style multiplicative/percentage scaling method instead of the new additive/fraction method Settings/LevelEditorViewportSettings.h
  • EditAnywhere
  • Config
  • Category=GridSnapping
PerInstanceSettings TArray< FLevelEditorViewportInstanceSettingsKeyValuePair > Per-instance viewport settings. Settings/LevelEditorViewportSettings.h
  • Config
SettingChangedEvent FSettingChangedEvent Holds an event delegate that is executed when a setting has changed. Settings/LevelEditorViewportSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FLevelEditorViewportInstanceSettings * GetViewportInstanceSettings ( const FString& InConfigName
) const

   Settings/LevelEditorViewportSettings.h  

FSettingChangedEvent & OnSettingChanged()

   Settings/LevelEditorViewportSettings.h  

void SetViewportInstanceSettings ( const FString& InConfigName,
const FLevelEditorViewportInstanceSettings& InConfigSettings
)

 Set the instance settings for the given viewport Settings/LevelEditorViewportSettings.h  

bool UsePercentageBasedScaling()

 Checks whether percentage based scaling should be used for view ports. Settings/LevelEditorViewportSettings.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Settings/LevelEditorViewportSettings.h  

virtual void PostInitProperties()

   Settings/LevelEditorViewportSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
CameraSpeed_DEPRECATED int32 How fast the perspective camera moves when flying through the world. Settings/LevelEditorViewportSettings.h
  • Config
  • Meta=(UIMin="1", UIMax="8", ClampMin="1", ClampMax="8")
CameraSpeedScalar_DEPRECATED float Scalar applied to perspective camera movement to increase movement range. Settings/LevelEditorViewportSettings.h
  • Config
  • Meta=(ClampMin="1", UIMax="128")
TransformWidgetSizeAdjustment_DEPRECATED int32 The size adjustment to apply to the translate/rotate/scale widgets (in Unreal units). Settings/LevelEditorViewportSettings.h
  • Config

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page