UPlayerViewportClient

A Viewport Client that renders a single [ULocalPlayer](API\Runtime\Engine\ULocalPlayer) using their camera manager.

API > API/Plugins > API/Plugins/ModularViewports

A Viewport Client that renders a single ULocalPlayer using their camera manager.

Halfway between FCameraViewportClient (raw camera, no input) and UGameViewportClient (all players, split-screen). Routes input to the player's controller.

Must be constructed via the static Create() factory — direct NewObject<> construction trips an ensure.

   
Name UPlayerViewportClient
Type class
Header File /Engine/Plugins/Runtime/ModularViewports/Source/ModularViewports/Public/GameFramework/PlayerViewportClient.h
Include Path #include "GameFramework/PlayerViewportClient.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UPlayerViewportClient : public UScriptViewportClient

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPlayerViewportClient ( const FObjectInitializer& ObjectInitializer
)

   GameFramework/PlayerViewportClient.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bFilterInputByPlayer bool   GameFramework/PlayerViewportClient.h  
Player TWeakObjectPtr< ULocalPlayer >   GameFramework/PlayerViewportClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetFilterInputByPlayer()

   GameFramework/PlayerViewportClient.h  

const TWeakObjectPtr< ULocalPlayer > & GetLocalPlayer()

   GameFramework/PlayerViewportClient.h  

void SetFilterInputByPlayer ( bool bFilter
)

 When true, gamepad input from devices assigned to other players is ignored. GameFramework/PlayerViewportClient.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GameFramework/PlayerViewportClient.h  

Overridden from FViewportClient

Name Remarks Include Path Unreal Specifiers

virtual void Draw ( FViewport* Viewport,
FCanvas* Canvas
)

   GameFramework/PlayerViewportClient.h  

virtual EMouseCursor::Type GetCursor ( FViewport* Viewport,
int32 X,
int32 Y
)

   GameFramework/PlayerViewportClient.h  

virtual UWorld * GetWorld()

   GameFramework/PlayerViewportClient.h  

virtual bool InputAxis ( const FInputKeyEventArgs& Args
)

   GameFramework/PlayerViewportClient.h  

virtual bool InputGesture ( FViewport* Viewport,
const FInputDeviceId DeviceId,
EGestureEvent GestureType,
EGesturePhase GesturePhase,
const FVector2D& GestureDelta,
bool bIsDirectionInvertedFromDevice,
const uint64 Timestamp
)

   GameFramework/PlayerViewportClient.h  

virtual bool InputKey ( const FInputKeyEventArgs& EventArgs
)

   GameFramework/PlayerViewportClient.h  

virtual bool InputMotion ( FViewport* Viewport,
const FInputDeviceId DeviceId,
const FVector& Tilt,
const FVector& RotationRate,
const FVector& Gravity,
const FVector& Acceleration,
const uint64 Timestamp
)

   GameFramework/PlayerViewportClient.h  

virtual bool InputTouch ( FViewport*const Viewport,
const FTouchId TouchId,
const ETouchType::Type Type,
const FVector2D& TouchLocation,
const float Force,
const uint64 Timestamp
)

   GameFramework/PlayerViewportClient.h  

virtual void LostFocus ( FViewport* Viewport
)

   GameFramework/PlayerViewportClient.h  

virtual bool RequiresUncapturedAxisInput()

   GameFramework/PlayerViewportClient.h  

Static

Name Remarks Include Path Unreal Specifiers

static UPlayerViewportClient * Create ( ULocalPlayer& Player,
UObject* Outer
)

 Creates a UPlayerViewportClient bound to Player. GameFramework/PlayerViewportClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page