Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/FViewportClient
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool InputAxis
(
const FInputKeyEventArgs& Args |
Check an axis movement received by the viewport. | ViewportClient.h | |
virtual bool InputAxis
(
FViewport* Viewport, |
Check an axis movement received by the viewport. | ViewportClient.h |
InputAxis(const FInputKeyEventArgs &)
Description
Check an axis movement received by the viewport. If this viewport client uses this input and wants to consume it (stop it from being passed along to further viewports) then it should return true.
| Name | InputAxis |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Public/ViewportClient.h |
| Include Path | #include "ViewportClient.h" |
virtual bool InputAxis
(
const FInputKeyEventArgs & Args
)
True to consume the axis movement, false to pass it on.
Parameters
| Name | Remarks |
|---|---|
| Args | The input event arguments for this axis movement. |
InputAxis(FViewport *, FInputDeviceId, FKey, float, float, int32, bool)
Description
Check an axis movement received by the viewport. If the viewport client uses the movement, it should return true to consume it.
| Name | InputAxis |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Public/ViewportClient.h |
| Include Path | #include "ViewportClient.h" |
| Source | /Engine/Source/Runtime/Engine/Private/UnrealClient.cpp |
virtual bool InputAxis
(
FViewport * Viewport,
FInputDeviceId InputDevice,
FKey Key,
float Delta,
float DeltaTime,
int32 NumSamples,
bool bGamepad
)
True to consume the axis movement, false to pass it on.
Parameters
| Name | Remarks |
|---|---|
| Viewport | The viewport which the axis movement is from. |
| InputDevice | The input device that triggered this axis movement |
| Key | The name of the axis which moved. |
| Delta | The axis movement delta. |
| DeltaTime | The time since the last axis update. |
| NumSamples | The number of device samples that contributed to this Delta, useful for things like smoothing |
| bGamepad | input came from gamepad (ie xbox controller) |