1. Epic GamesDeveloper
  3. AGameplayCamerasPlayerCameraManager

AGameplayCamerasPlayerCameraManager

A player camera manager that runs the GameplayCameras camera system.

API > API/Plugins > API/Plugins/GameplayCameras

A player camera manager that runs the GameplayCameras camera system.

Setting the view target does the following:

  • Push a new evaluation context for the provided view target actor.
  • If that actor contains a GameplayCameraComponent, use its evaluation context directly.
  • If that actor contains a CameraComponent, make an evaluation context that wraps it and runs by simply copying that camera's properties (see FCameraActorCameraEvaluationContext).
  • For other actors, do as above, but convert the output of the actor's CalcCamera function.
  • The old view target's evaluation context is immediately removed from the evaluation stack. For other way to handle evaluation contexts, call methods directly on the camera system evaluator instead of going through the base APlayerCameraManager class.

There is only ever one active view target, the "pending" view target isn't used. This is because we may be blending between more than two camera rigs that may belong to more than two actors.

   
Name AGameplayCamerasPlayerCameraManager
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/GameFramework/GameplayCamerasPlayerCameraManager.h
Include Path #include "GameFramework/GameplayCamerasPlayerCameraManager.h"

Syntax

UCLASS (NotPlaceable, MinimalAPI)  
class AGameplayCamerasPlayerCameraManager :  
    public APlayerCameraManager ,  
    public IGameplayCameraSystemHost

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

AGameplayCamerasPlayerCameraManager ( const FObjectInitializer& ObjectInitializer
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOverrideViewRotationMode bool Whether the default view rotation mode setting should be overriden. GameFramework/GameplayCamerasPlayerCameraManager.h
  • EditAnywhere
  • Category="Camera"
ViewRotationMode EGameplayCamerasViewRotationMode The view rotation handling mode to use. GameFramework/GameplayCamerasPlayerCameraManager.h
  • EditAnywhere
  • Category="Camera"
  • Meta=(EditCondition="bOverrideViewRotationMode")

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsSettingNewViewTarget bool   GameFramework/GameplayCamerasPlayerCameraManager.h  
NullContext TSharedPtr< UE::Cameras::FCameraEvaluationContext >   GameFramework/GameplayCamerasPlayerCameraManager.h  
OriginalCameraManager TObjectPtr< APlayerCameraManager >   GameFramework/GameplayCamerasPlayerCameraManager.h
  • Transient
ViewTargetContexts TArray< TSharedRef< UE::Cameras::FCameraEvaluationContext > >   GameFramework/GameplayCamerasPlayerCameraManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActivatePersistentBaseCameraRig ( UCameraRigAsset* CameraRig
)

 Activates the given camera rig prefab in the base layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

void ActivatePersistentGlobalCameraRig ( UCameraRigAsset* CameraRig
)

 Activates the given camera rig prefab in the global layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

void ActivatePersistentVisualCameraRig ( UCameraRigAsset* CameraRig
)

 Activates the given camera rig prefab in the visual layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

bool IsCameraShakeAssetPlaying ( FCameraShakeInstanceID InInstanceID
) const

 Checks if a camera shake is running. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

void ReleasePlayerController()

 Restore an originally stolen camera manager (see StealPlayerController). GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

FCameraShakeInstanceID StartCameraShakeAsset ( const UCameraShakeAsset* CameraShake,
float ShakeScale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRotation
)

 Starts a new camera shake. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

FCameraRigInstanceID StartGlobalCameraModifierRig ( const UCameraRigAsset* CameraRig,
int32 OrderKey
)

 Starts a camera modifier rig on the global layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

FCameraRigInstanceID StartVisualCameraModifierRig ( const UCameraRigAsset* CameraRig,
int32 OrderKey
)

 Starts a camera modifier rig on the visual layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

void StealPlayerController ( APlayerController* PlayerController
)

 Replace the camera manager currently set on the provided controller with this camera manager. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

void StopCameraModifierRig ( FCameraRigInstanceID InstanceID,
bool bImmediately
)

 Stops a camera modifier rig on previously started on the global or visual layer. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

bool StopCameraShakeAsset ( FCameraShakeInstanceID InInstanceID,
bool bImmediately
)

 Stops a running camera shake. GameFramework/GameplayCamerasPlayerCameraManager.h
  • BlueprintCallable
  • Category="Camera"

Overridden from APlayerCameraManager

Name Remarks Include Path Unreal Specifiers

virtual void DisplayDebug ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay,
float& YL,
float& YPos
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

virtual void InitializeFor ( APlayerController* PlayerController
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

virtual void ProcessViewRotation ( float DeltaTime,
FRotator& OutViewRotation,
FRotator& OutDeltaRot
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

virtual void SetViewTarget ( AActor* NewViewTarget,
FViewTargetTransitionParams TransitionParams
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GameFramework/GameplayCamerasPlayerCameraManager.h  

Overridden from IGameplayCameraSystemHost

Name Remarks Include Path Unreal Specifiers

virtual UObject * GetAsObject()

 Should be implemented by the underlying class to return itself as a UObject. GameFramework/GameplayCamerasPlayerCameraManager.h  

Protected

Overridden from APlayerCameraManager

Name Remarks Include Path Unreal Specifiers

virtual void DoUpdateCamera ( float DeltaTime
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   GameFramework/GameplayCamerasPlayerCameraManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page