Navigation
API > API/Editor > API/Editor/UnrealEd
Helper class used by FEditorViewportClient to allow external inputs to move the camera. Used by ITF Viewport interactions. When deltas from this struct are used, they should be reset since they are used and updated on tick. Please use ConsumeTransformDelta(...) and ConsumeImpulseData(...) to do that.
| Name | FViewportClientNavigationHelper |
| Type | struct |
| Header File | /Engine/Source/Editor/UnrealEd/Public/ViewportClientNavigationHelper.h |
| Include Path | #include "ViewportClientNavigationHelper.h" |
Syntax
struct FViewportClientNavigationHelper
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FViewportClientNavigationHelper() |
ViewportClientNavigationHelper.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsMouseLooking | bool | This flag is true when the user is controlling a viewport camera using the mouse | ViewportClientNavigationHelper.h | |
| ImpulseDataDelta | FCameraControllerUserImpulseData | Impulse data used to control rotation, translation and FOV of a camera See FEditorViewportClient::UpdateCameraMovement | ViewportClientNavigationHelper.h | |
| LocationDelta | FVector | A location delta which can be used to move a Viewport camera | ViewportClientNavigationHelper.h | |
| OrbitDelta | FVector | A delta which is used by Editor Viewport Client to compute orbit movement values | ViewportClientNavigationHelper.h | |
| RotationDelta | FRotator | A rotation delta which can be used to rotate a Viewport camera | ViewportClientNavigationHelper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConsumeImpulseData
(
FCameraControllerUserImpulseData& OutImpulseData |
Retrieve current impulse deltas and zero them out | ViewportClientNavigationHelper.h | |
void ConsumeOrbitDelta
(
FVector& OutOrbitDelta |
Retrieve current delta used to generate orbit movement | ViewportClientNavigationHelper.h | |
void ConsumeTransformDelta
(
FVector& OutLocationDelta, |
Retrieve current location and rotation deltas, and zero them out | ViewportClientNavigationHelper.h | |
bool HasTransformDelta () |
Check whether non-zero location or rotation deltas are available. | ViewportClientNavigationHelper.h | |
void ResetImpulseData() |
Sets all impulse data to zero | ViewportClientNavigationHelper.h | |
void ResetTransformDelta() |
Sets Location and Rotation deltas to zero | ViewportClientNavigationHelper.h |