| FCommonViewportClient | ||||
| FViewElementDrawer | ||||
| FGCObject
|
Module |
|
Header |
/Engine/Source/Editor/UnrealEd/Public/LevelEditorViewport.h |
Include |
#include "LevelEditorViewport.h" |
class FLevelEditorViewportClient : public FEditorViewportClient
Name | Description | ||
---|---|---|---|
|
bool |
bAlwaysShowModeWidgetAfterSelectionChanges |
When enabled, the Unreal transform widget will become visible after an actor is selected, even if it was turned off via a show flag |
|
bool |
bDrawBaseInfo |
Indicates whether, of not, the base attachment volume should be drawn for this viewport. |
|
bool |
bDuplicateActorsInProgress |
BDuplicateActorsOnNextDrag will not be set again while bDuplicateActorsInProgress is true. |
|
bool |
bDuplicateOnNextDrag |
Used for drag duplication. |
|
bool |
bEnableColorScaling |
|
|
bool |
bEnableFading |
|
|
bool |
bHasBegunGizmoManipulation |
True if gizmo manipulation was started from a tracking event |
|
bool |
bIsTrackingBrushModification |
True when a brush is being transformed by its Widget |
|
bool |
bLockedCameraView |
True if this viewport is to change its view (aspect ratio, post processing, FOV etc) to match that of the currently locked camera, if applicable |
|
bool |
bNeedToRestoreComponentBeingMovedFlag |
True if the viewport needs to restore the flag when tracking ends |
|
bool |
bOnlyMovedPivot |
True if only the pivot position has been moved |
|
bool |
bReceivedFocusRecently |
Whether this viewport recently received focus. |
|
FVector |
ColorScale |
|
|
float |
FadeAmount |
|
|
FadeColor |
||
|
FVector |
LastEditorViewLocation |
The viewport location that is restored when exiting PIE |
|
FRotator |
LastEditorViewRotation |
The viewport orientation that is restored when exiting PIE |
|
TWeakPtr< class... |
ParentLevelEditor |
Parent level editor that owns this viewport. |
|
ViewHiddenLayers |
List of layers that are hidden in this view |
|
|
VolumeActorVisibility |
Special volume actor visibility settings. |
Name | Description | |
---|---|---|
|
FLevelEditorViewportClient ( |
Constructor |
Name | Description | |
---|---|---|
|
~FLevelEditorViewportClient() |
Destructor |
Name | Description | ||
---|---|---|---|
|
void |
AddHoverEffect ( |
Static: Adds a hover effect to the specified object |
|
void |
ApplyDeltaToActor ( |
|
|
void |
ApplyDeltaToActors ( |
|
|
void |
ApplyDeltaToComponent ( |
|
|
void |
ApplyDeltaToElement ( |
|
|
void |
ApplyDeltaToSelectedElements ( |
|
|
bool |
CanApplyMaterialToHitProxy ( |
Called to check if a material can be applied to an object, given the hit proxy |
|
bool |
CanDropBlueprintAsset ( |
Checks the viewport to see if the given blueprint asset can be dropped on the viewport. |
|
void |
ClearHoverFromObjects() |
Static: Clears viewport hover effects from any objects that currently have that |
|
void |
CopyLayoutFromViewport ( |
Copies layout and camera settings from the specified viewport |
|
void |
DrawTextureStreamingBounds ( |
Draw the texture streaming bounds. |
|
UActorCompon... |
FindViewComponentForActor ( |
Find a view component to use for the specified actor. |
|
TWeakObjectP... |
GetActiveActorLock() |
Access the 'active' actor lock. |
|
const FLevel... |
GetActorLock() |
Gets the actor lock. This is the actor locked to the viewport via the viewport menus. |
|
FLevelViewpo... |
GetActorLock() |
Gets the actor lock. This is the actor locked to the viewport via the viewport menus. |
|
UCameraCompo... |
GetCameraComponentForView() |
Find the camera component that is driving this viewport, in the following order of preference: |
|
const FLevel... |
GetCinematicActorLock() |
Get the actor locked to the viewport by cinematic tools like Sequencer. |
|
FLevelViewpo... |
GetCinematicActorLock() |
Get the actor locked to the viewport by cinematic tools like Sequencer. |
|
const TArray... |
GetDropPreviewActors() |
|
|
FVector2D |
GetDropPreviewLocation() |
|
|
FTypedElemen... |
GetElementsToManipulate ( |
Get the elements (from the current selection set) that this viewport can manipulate (eg, via the transform gizmo). |
|
bool |
GetFocusBounds ( |
|
|
EAxisList::T... |
GetHorizAxis() |
Returns the horizontal axis for this viewport. |
|
bool |
GetIsCameraCut() |
|
|
UObject *... |
GetOrCreateMaterialFromTexture ( |
Static: Given a texture, returns a material for that texture, creating a new asset if necessary. |
|
const FLevel... |
GetPreviousActorLock() |
Gets the previous actor lock. This is the actor locked to the viewport via the viewport menus. |
|
const FLevel... |
GetPreviousCinematicActorLock() |
Get the previous actor locked to the viewport by cinematic tools like Sequencer. |
|
bool |
GetSpriteCategoryVisibility ( |
Returns whether the provided unlocalized sprite category is visible in the viewport or not |
|
bool |
GetSpriteCategoryVisibility ( |
Returns whether the sprite category specified by the provided index is visible in the viewport or not |
|
EAxisList::T... |
GetVertAxis() |
Returns the vertical axis for this viewport. |
|
void |
HandleViewportSettingChanged ( |
Callback for when an editor user setting has changed |
|
void |
InitializeViewportInteraction() |
Initialize viewport interaction |
|
void |
InitializeVisibilityFlags() |
Initialize visibility flags |
|
bool |
IsActorLocked ( |
Check to see if this actor is locked by the viewport |
|
bool |
IsAnyActorLocked() |
Check to see if any actor is locked by the viewport |
|
bool |
IsDroppingPreviewActor() |
Returns true if creating a preview actor in the viewport. |
|
bool |
IsLockedToActor ( |
Check whether this viewport is locked to the specified actor |
|
bool |
IsLockedToCinematic() |
Check whether this viewport is locked to display a cinematic camera, like a Sequencer camera. |
|
bool |
IsVolumeVisibleInViewport ( |
Returns true if the passed in volume is visible in the viewport (due to volume actor visibility flags) |
|
void |
MirrorSelectedActors ( |
|
|
void |
MirrorSelectedElements ( |
|
|
void |
MoveCameraToLockedActor() |
Moves the viewport camera according to the locked actors location and rotation |
|
void |
OnActorMoved ( |
Delegate handler for ActorMoved events |
|
void |
OnEditorCleanse() |
Called when editor cleanse event is triggered |
|
void |
OnMapChanged ( |
Callback for when a map is created or destroyed |
|
void |
OnPreBeginPIE ( |
Called before the editor tries to begin PIE |
|
void |
PrepareCameraForPIE() |
Stores camera settings that may be adversely affected by PIE, so that they may be restored later |
|
void |
RemoveHoverEffect ( |
Static: Removes a hover effect to the specified object |
|
void |
RemoveReferenceToWorldContext ( |
|
|
void |
ResetCamera() |
Reset the camera position and rotation. Used when creating a new level. |
|
void |
ResetViewForNewMap() |
Reset the view for a new map |
|
void |
RestoreCameraFromPIE() |
Restores camera settings that may be adversely affected by PIE |
|
void |
SetActorLock ( |
Set the actor lock. This is the actor locked to the viewport via the viewport menus. |
|
void |
SetActorLock ( |
Set the actor lock. This is the actor locked to the viewport via the viewport menus. |
|
void |
SetAllSpriteCategoryVisibility ( |
Sets the visibility of all sprite categories to the provided value |
|
void |
SetCinematicActorLock ( |
Set the actor locked to the viewport by cinematic tools like Sequencer. |
|
void |
SetCinematicActorLock ( |
Set the actor locked to the viewport by cinematic tools like Sequencer. |
|
void |
SetCurrentViewport() |
Set the global ptr to the current viewport |
|
void |
SetEditingThroughMovementWidget() |
Informs the renderer that the view is being interactively edited. |
|
void |
SetIsCameraCut() |
Sets a flag for this frame indicating that the camera has been cut, and temporal effects (such as motion blur) should be reset |
|
void |
SetIsDroppingPreviewActor ( |
Sets the state of creating a preview actor in the viewport. |
|
void |
SetLastKeyViewport() |
Set the global ptr to the last viewport to receive a key press |
|
void |
SetReferenceToWorldContext ( |
|
|
void |
SetSpriteCategoryVisibility ( |
Sets the visibility of the provided unlocalized category to the provided value |
|
void |
SetSpriteCategoryVisibility ( |
Sets the visibility of the category specified by the provided index to the provided value |
|
void |
SetViewportTypeFromTool ( |
Calling SetViewportType from Dragtool_ViewportChange |
|
bool |
ShouldUseMoveCanvasMovement() |
Determines if the new MoveCanvas movement should be used |
|
TryPlacingActorFromObject ( |
Static: Attempts to place the specified object in the level, returning one or more newly-created actors if successful. |
|
|
void |
UpdateAudioListener ( |
Updates the audio listener for this viewport |
|
void |
UpdateHoveredObjects ( |
|
|
void |
UpdateViewForLockedActor ( |
Updates or resets view properties such as aspect ratio, FOV, location etc to match that of any actor we are locked to |
Name | Description | ||
---|---|---|---|
|
void |
AbortTracking() |
Aborts mouse tracking (stop and cancel) |
|
void |
BeginCameraMovement ( |
Handle the camera about to be moved or stopped |
|
FSceneView &... |
CalcSceneView ( |
Configures the specified FSceneView object with the view and projection matrices for this viewport. |
|
CanDropObjectsAtCoordinates ( |
Checks the viewport to see if the given object can be dropped using the given mouse coordinates local to this viewport |
|
|
void |
CheckHoveredHitProxy ( |
Checks if the mouse is hovered over a hit proxy and decides what to do. |
|
void |
DestroyDropPreviewActors() |
If dragging an actor for placement, this function destroys the actor. |
|
void |
DrawCanvas ( |
Called to draw onto the viewports 2D canvas |
|
bool |
DropObjectsAtCoordinates ( |
Attempts to intelligently drop the given objects in the viewport, using the given mouse coordinates local to this viewport |
|
void |
EndCameraMovement() |
|
|
bool |
GetActiveSafeFrame ( |
Helper used by DrawSafeFrames to get the current safe frame aspect ratio. |
|
GetBackgroundColor() |
||
|
float |
GetCameraSpeedScalar() |
Get the camera speed scalar for this viewport |
|
int32 |
GetCameraSpeedSetting() |
Get the camera speed setting for this viewport |
|
bool |
GetPivotForOrbit ( |
Get the custom pivot point around which the camera should orbit for this viewport |
|
ELevelViewpo... |
GetViewportType() |
Returns the effective viewport type (taking into account any actor locking or camera possession) |
|
FMatrix |
GetWidgetCoordSystem() |
|
|
FVector |
GetWidgetLocation() |
|
|
UE::Widget::... |
GetWidgetMode() |
|
|
bool |
HasDropPreviewActors() |
Returns true if a placement dragging actor exists |
|
bool |
InputWidgetDelta ( |
Called to give the viewport client a chance to handle widgets being moved |
|
bool |
IsLevelEditorClient() |
If true, this is a level editor viewport |
|
TSharedPtr< ... |
MakeDragTool ( |
Called to make a drag tool when the user starts dragging in the viewport |
|
void |
NudgeSelectedObjects ( |
|
|
void |
OverridePostProcessSettings ( |
Called to override any post process settings for the view |
|
void |
PerspectiveCameraMoved() |
Called when the perspective viewport camera moves |
|
void |
ProcessClick ( |
Called when the user clicks in the viewport |
|
void |
RedrawAllViewportsIntoThisScene() |
Invalidates this and other linked viewports (anything viewing the same scene) |
|
void |
RotateViewportType() |
Rotate through viewport view options |
|
void |
SetCameraSpeedScalar ( |
Set the camera speed scalar for this viewport |
|
void |
SetCameraSpeedSetting ( |
Set the speed setting for the camera in this viewport |
|
void |
SetupViewForRendering ( |
Called to do any additional set up of the view for rendering |
|
void |
SetViewportType ( |
Set the viewport type of the client |
|
void |
SetVREditView ( |
|
|
bool |
ShouldLockPitch() |
|
|
bool |
ShouldScaleCameraSpeedByDistance() |
|
|
void |
Tick ( |
Ticks this viewport client |
|
void |
TrackingStarted ( |
Called when mouse movement tracking begins |
|
void |
TrackingStopped() |
Called when mouse movement tracking stops |
|
bool |
UpdateDropPreviewActors ( |
If dragging an actor for placement, this function updates its position. |
|
void |
UpdateLinkedOrthoViewports ( |
FEditorViewportClient Interface |
|
bool |
UseAppTime() |
Should this viewport use app time instead of world time. |
Name | Description | ||
---|---|---|---|
|
void |
CapturedMouseMove ( |
Called when the mouse is moved while a window input capture is in effect |
|
void |
ConditionalRestoreWorld ( |
Restores GWorld to InWorld |
|
UWorld * |
ConditionalSetWorld() |
Sets GWorld to the appropriate world for this client |
|
EMouseCursor... |
GetCursor ( |
Retrieves the cursor that should be displayed by the OS |
|
UWorld * |
GetWorld() |
Use the viewports Scene to get a world. |
|
bool |
InputAxis ( |
Check an axis movement received by the viewport. |
|
bool |
InputKey ( |
Check a key event received by the viewport. |
|
void |
LostFocus ( |
|
|
void |
MouseMove ( |
|
|
bool |
OverrideHighResScreenshotCaptureRegion ( |
Allow viewport client to override the current capture region |
|
void |
ReceivedFocus ( |
|
|
void |
SetIsSimulateInEditorViewport ( |
Name | Description | ||
---|---|---|---|
|
void |
Draw ( |
FViewElementDrawer interface |
Name | Description | ||
---|---|---|---|
|
void |
AddReferencedObjects ( |
GC references. Serialization. |
Name |
Description |
---|---|
bIsDroppingPreviewActor |
If currently creating a preview actor. |
DropPreviewActors |
The actors that are currently being placed in the viewport via dragging |
HoveredObjects |
Static: List of objects we're hovering over |
ViewComponentForActorCache |
Caching for expensive FindViewComponentForActor. Invalidated once per Tick. |