1. Epic GamesDeveloper
  3. ULevelEditorViewportSettings

ULevelEditorViewportSettings

Implements the Level Editor's view port settings.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Settings

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/Settings/LevelEditorViewportSettings.h
Include #include "Settings/LevelEditorViewportSettings.h"

Syntax

class ULevelEditorViewportSettings : public UObject

Remarks

Implements the Level Editor's view port settings.

Variables

  Type Name Description
Public variable int32 ActiveSnapLayerIndex The index of the snap plane to use when 2D Layer Snapping is enabled, from the array of Snap Layers set for the project.
Public variable float ActorSnapDistance Global actor snap distance setting for the editor
Public variable float ActorSnapScale Global actor snap scale for the editor
Public variable TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint How to constrain perspective view port FOV
Public variable float BackgroundDropDistance Distance from the camera to place actors which are dropped on nothing in the view port.
Public variable uint32: 1 bAllowArcballRotate Allow arcball rotation with rotate widget
Public variable uint32: 1 bAllowScreenRotate Allow screen rotation with rotate widget
Public variable uint32: 1 bAllowTranslateRotateZWidget Allow translate/rotate widget
Public variable uint32: 1 bCenterZoomAroundCursor If checked, in orthographic view ports zooming will center on the mouse position.
Public variable uint32: 1 bClickBSPSelectsBrush If true, Clicking a BSP selects the brush and ctrl+shift+click selects the surface.
Public variable uint32: 1 bEnableActorSnap If true actor snap will be enabled in the editor
Public variable uint32: 1 bEnableLayerSnap If enabled, new Actors that you drag into the viewport snap to the active 2D layer.
Public variable uint32: 1 bEnableViewportCameraToUpdateFromPIV Enables the editor perspective camera to be dropped at the last PlayInViewport cam position
Public variable uint32: 1 bEnableViewportHoverFeedback Enables real-time hover feedback when mousing over objects in editor view ports
Public variable uint32: 1 bHighlightWithBrackets If enabled, selected objects will be highlighted with brackets in all modes rather than a special highlight color.
Public variable float BillboardScale  
Public variable bool bInvertMiddleMousePan Whether or not to invert the direction of middle mouse panning in viewports
Public variable bool bInvertMouseLookYAxis Whether or not to invert mouse on the y axis in free look mode
Public variable bool bInvertOrbitYAxis Whether or not to invert mouse on y axis in orbit mode
Public variable bool bInvertRightMouseDollyYAxis Whether or not to invert the direction of right mouse dolly on the Y axis in orbit mode
Public variable bool bLevelEditorJoystickControls Enables joystick-based camera movement in 3D level editing viewports
Public variable bool bLevelStreamingVolumePrevis If enabled, the viewport will stream in levels automatically when the camera is moved.
Public variable bool bOrbitCameraAroundSelection If enabled, the camera will orbit around the current selection in the viewport
Public variable uint32: 1 bPanMovesCanvas If true, moves the canvas and shows the mouse. If false, uses original camera movement.
Public variable uint32: 1 bPreviewSelectedCameras 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.
Public variable uint32: 1 bSaveEngineStats When enabled, engine stats that are enabled in level viewports are preserved between editor sessions
Public variable uint32: 1 bShowActorEditorContext If true, viewport will show actor editor context (current level, current data layer(s), current folder)
Public variable bool bSnapVertices  
Public variable float BSPSelectionHighlightIntensity Sets the intensity of the overlay displayed when an object is selected
Public variable uint32: 1 bStrictBoxSelection True if viewport box selection requires objects to be fully encompassed by the selection box to be selected
Public variable uint32: 1 bTransparentBoxSelection True if viewport box selection also selects occluded objects, false if only objects with visible pixels are selected
Public variable uint32: 1 bUseAbsoluteTranslation Whether to use mouse position as direct widget position.
Public variable bool bUseDistanceScaledCameraSpeed If enabled, scale the perspective camera speed based on the distance between the camera and its look-at position
Public variable uint32: 1 bUseLegacyCameraMovementNotifications Camera movement notification toggle to switch back to the behavior that caused camera notifications to be sent during gizmo movement.
Public variable uint32: 1 bUseLinkedOrthographicViewports If checked all orthographic view ports are linked to the same position and move together.
Public variable bool bUsePowerOf2SnapSize If enabled will use power of 2 grid settings (e.g, 1,2,4,8,16,...,1024) instead of decimal grid sizes
Public variable uint32: 1 bUseSelectionOutline Whether to show selection outlines for selected Actors
Public variable bool bUseUE3OrbitControls 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
Public variable float CameraPreviewSize Affects the size of 'picture in picture' previews if they are enabled
Public variable int32 CameraSpeed How fast the perspective camera moves when flying through the world.
Public variable float CameraSpeedScalar Scalar applied to perspective camera movement to increase movement range.
Public variable TArray< float > CommonRotGridSizes User defined grid intervals for rotations
Public variable int32 CurrentPosGridSize  
Public variable TEnumAsByte< ERotationGridMode > CurrentRotGridMode Controls which array of rotation grid values we are using
Public variable int32 CurrentRotGridSize  
Public variable int32 CurrentScalingGridSize  
Public variable TArray< float > DecimalGridIntervals The number of lines between each major line interval for decimal grids
Public variable TArray< float > DecimalGridSizes Decimal grid sizes (for translation snapping and grid rendering)
Public variable TArray< float > DivisionsOf360RotGridSizes Preset grid intervals for rotations
Public variable TMap< TSoftObjectPtr< UWorld >, FLevelEditorViewporEditorViews > EditorViews Store the last camera settings for all the viewport of each world loaded in the editor.
Public variable bool FlightCameraControlExperimentalNavigation Enable the use of the experimental navigation in the flight camera controls.
Public variable TEnumAsByte< EWASDType > FlightCameraControlType Enable the use of flight camera controls under various circumstances.
Public variable ELandscapeFoliageEditorControlType FoliageEditorControlType Choose the control scheme for foliage tools
Public variable uint32: 1 GridEnabled If enabled, actor positions will snap to the grid.
Public variable ELandscapeFoliageEditorControlType LandscapeEditorControlType Choose the control scheme for landscape tools (ignored for pen input)
Public variable FVector2D LastInViewportMenuLocation  
Public variable TSoftObjectPtr< class UMaterialInterface > MaterialForDroppedTextures When dropping a texture in the viewport, create an instance of this material instead of creating a new material.
Public variable TMap< EMaterialKind, FName > MaterialParamsForDroppedTextures When dropping a texture in the viewport, determines which material parameter to assign for each found texture type.
Public variable TEnumAsByte< EMeasuringToolUnits > MeasuringToolUnits Specify the units used by the measuring tool
Public variable float MinimumOrthographicZoom The closest possible distance allowed when viewing through an orthographic camera
Public variable int32 MouseScrollCameraSpeed How fast the perspective camera moves through the world when using mouse scroll.
Public variable float MouseSensitivty The sensitivity of mouse movement when rotating the camera.
Public variable TArray< float > Pow2GridIntervals The number of lines between each major line interval for pow2 grids
Public variable TArray< float > Pow2GridSizes Power of 2 grid sizes (for translation snapping and grid rendering)
Public variable bool PreserveNonUniformScale  
Public variable TArray< FSoftObjectPath > PreviewMeshes A list of meshes that can be used as preview mesh in the editor view port by holding down the backslash key
Public variable uint32: 1 RotGridEnabled If enabled, actor rotations will snap to the grid.
Public variable TArray< float > ScalingGridSizes Grid sizes for scaling
Public variable EScrollGestureDirection ScrollGestureDirectionFor3DViewports Direction of the scroll gesture for 3D viewports
Public variable EScrollGestureDirection ScrollGestureDirectionForOrthoViewports Direction of the scroll gesture for orthographic viewports
Public variable float SelectedSplinePointSizeAdjustment The size adjustment to apply to selected spline points (in screen space units).
Public variable float SelectionHighlightIntensity Sets the intensity of the overlay displayed when an object is selected
Public variable float SnapDistance  
Public variable uint32: 1 SnapScaleEnabled If enabled, actor sizes will snap to the grid.
Public variable FSnapToSurfaceSettings SnapToSurface If enabled, actors will snap to surfaces in the viewport when dragged around
Public variable float SplineLineThicknessAdjustment The size adjustment to apply to spline line thickness which increases the spline's hit tolerance.
Public variable float SplineTangentHandleSizeAdjustment The size adjustment to apply to spline tangent handle (in screen space units).
Public variable float SplineTangentScale The scale to apply to spline tangent lengths
Public variable int32 TransformWidgetSizeAdjustment The size adjustment to apply to the translate/rotate/scale widgets (in Unreal units).

Constructors

  Type Name Description
Public function  

ULevelEditorViewportSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const const FLevelEditorViewportInstanceSettings *

GetViewportInstanceSettings ( const FString& InConfigName
)

  
Public function FSettingChangedEvent &  
Public function void

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

 Set the instance settings for the given viewport
Public function Const bool Checks whether percentage based scaling should be used for view ports.

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

  Type Name Description
Public class FSettingChangedEvent Returns an event delegate that is executed when a setting has changed.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page