1. Epic GamesDeveloper
  3. APlayerCameraManager

APlayerCameraManager

A PlayerCameraManager is responsible for managing the camera for a particular player.

Unreal Engine C++ API Reference > Runtime > Engine > Camera

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Camera/PlayerCameraManager.h
Include #include "Camera/PlayerCameraManager.h"

Syntax

class APlayerCameraManager : public AActor

Remarks

A PlayerCameraManager is responsible for managing the camera for a particular player. It defines the final view properties used by other systems (e.g. the renderer), meaning you can think of it as your virtual eyeball in the world. It can compute the final camera properties directly, or it can arbitrate/blend between other objects or actors that influence the camera (e.g. blending from one CameraActor to another).

The PlayerCameraManagers primary external responsibility is to reliably respond to various Get*() functions, such as GetCameraViewPoint. Most everything else is implementation detail and overrideable by user projects.

By default, a PlayerCameraManager maintains a "view target", which is the primary actor the camera is associated with. It can also apply various "post" effects to the final view state, such as camera animations, shakes, post-process effects or special effects such as dirt on the lens.

Variables

  Type Name Description
Protected variable TObjectPtr< class ACameraActor > AnimCameraActor Internal. Receives the output of individual camera animations.
Protected variable uint32: 1 bAlwaysApplyModifiers By default camera modifiers are not applied to stock debug cameras (e.g. CameraStyle == "FreeCam").
Protected variable uint32: 1 bAutoAnimateFade  
Public variable uint32: 1 bClientSimulatingViewTarget True if clients are handling setting their own viewtarget and the server should not replicate it.
Public variable uint32: 1 bDebugClientSideCamera For debugging.
Public variable uint32: 1 bDefaultConstrainAspectRatio True if black bars should be added if the destination view has a different aspect ratio (only used when a view target doesn't specify whether or not to constrain the aspect ratio; most of the time the value from a camera component is used instead)
Public variable uint32: 1 bEnableColorScaleInterp True to smoothly interpolate color scale values when they change.
Public variable uint32: 1 bEnableColorScaling True to turn on scaling of color channels in final image using ColorScale property.
Public variable uint32: 1 bEnableFading True if we should apply FadeColor/FadeAmount to the screen.
Public variable uint32: 1 bFadeAudio True to apply fading of audio alongside the video.
Public variable uint32: 1 bGameCameraCutThisFrame True if we did a camera cut this frame.
Protected variable uint32: 1 bHoldFadeWhenFinished True if camera fade hold at it's final value when finished.
Public variable uint32: 1 bIsOrthographic Flags.
Public variable FViewTargetTransitionParams BlendParams Current view target transition blend parameters.
Public variable float BlendTimeToGo Time remaining in viewtarget blend.
Public variable uint32: 1 bShouldSendClientSideCameraUpdate If true, send a camera update to the server on next update.
Public variable uint32: 1 bUseClientSideCameraUpdates True if server will use camera positions replicated from the client instead of calculating them locally.
Protected variable TObjectPtr< class UCameraModifier_CameraShake > CachedCameraShakeMod Camera Modifiers.
Protected variable TArray< TScriptInterface< class ICameraLensEffectInterface > > CameraLensEffects "Lens" effects (e.g. blood, dirt on camera)
Public variable FName CameraStyle Usable to define different camera behaviors. A few simple styles are implemented by default.
Public variable FVector ColorScale Allows control over scaling individual color channels in the final image (when bEnableColorScaling == true).
Public variable float ColorScaleInterpDuration Total time for color scale interpolation to complete (when bEnableColorScaling and bEnableColorScaleInterp == true)
Public variable float ColorScaleInterpStartTime Time at which interpolation started (when bEnableColorScaling and bEnableColorScaleInterp == true)
Public variable float DefaultAspectRatio Default aspect ratio. Most of the time the value from a camera component will be used instead.
Public variable float DefaultFOV FOV to use by default.
Public variable TArray< TSubclassOf< UCameraModifier > > DefaultModifiers List of modifiers to create by default for this camera
Public variable float DefaultOrthoWidth The default desired width (in world units) of the orthographic view (ignored in Perspective mode)
Public variable FVector DesiredColorScale Desired color scale which ColorScale will interpolate to (when bEnableColorScaling and bEnableColorScaleInterp == true)
Public variable FVector2D FadeAlpha Current camera fade alpha range, where X = starting alpha and Y = final alpha (when bEnableFading == true)
Public variable float FadeAmount Amount of fading to apply (when bEnableFading == true).
Public variable FLinearColor FadeColor Color to fade to (when bEnableFading == true).
Public variable float FadeTime Total duration of the camera fade (when bEnableFading == true)
Public variable float FadeTimeRemaining Time remaining in camera fade (when bEnableFading == true)
Public variable float FreeCamDistance Distance to place free camera from view target (used in certain CameraStyles)
Public variable FVector FreeCamOffset Offset to Z free camera position (used in certain CameraStyles)
Protected variable float LockedFOV Value to lock FOV to, in degrees. Ignored if <= 0, utilized if > 0.
Protected variable float LockedOrthoWidth Value OrthoWidth is locked at, if > 0. Ignored if <= 0.
Protected variable TArray< TObjectPtr< UCameraModifier > > ModifierList List of active camera modifier instances that have a chance to update the final camera POV
Public variable FOnAudioFadeChangeSignature OnAudioFadeChangeEvent If bound, broadcast on fade start (with fade time) instead of manually altering audio device's primary volume directly
Public variable FVector OriginalColorScale Color scale value at start of interpolation (when bEnableColorScaling and bEnableColorScaleInterp == true)
Public variable TObjectPtr< class APlayerController > PCOwner PlayerController that owns this Camera actor
Public variable FTViewTarget PendingViewTarget Pending view target for blending
Protected variable TArray< struct FPostProcessSettings > PostProcessBlendCache Internal list of active post process effects. Parallel array to PostProcessBlendCacheWeights.
Protected variable TArray< EViewTargetBlendOrder > PostProcessBlendCacheOrders Internal list of how to blend post process effects.
Protected variable TArray< float > PostProcessBlendCacheWeights Internal list of weights for active post process effects. Parallel array to PostProcessBlendCache.
Protected variable FTimerHandle SwapPendingViewTargetWhenUsingClientSideCameraUpdatesTimerHandle  
Public variable float ViewPitchMax Maximum view pitch, in degrees.
Public variable float ViewPitchMin Minimum view pitch, in degrees.
Public variable float ViewRollMax Maximum view roll, in degrees.
Public variable float ViewRollMin Minimum view roll, in degrees.
Public variable FTViewTarget ViewTarget Current ViewTarget
Public variable FVector ViewTargetOffset Offset to view target (used in certain CameraStyles)
Public variable float ViewYawMax Maximum view yaw, in degrees.
Public variable float ViewYawMin Minimum view yaw, in degrees.

Constructors

  Type Name Description
Public function  

APlayerCameraManager ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual   Destructor for handling property deprecation, please remove after all deprecated properties are gone

Functions

  Type Name Description
Public function void

AddCachedPPBlend ( FPostProcessSettings& PPSettings,
float BlendWeight,
EViewTargetBlendOrder BlendOrder
)

 Adds a postprocess effect at the given weight.
Public function Virtual AEmitterCameraLensEffectBase *  
Protected function Virtual bool Internal. Places the given modifier in the ModifierList at the appropriate priority.
Public function Virtual TScriptInterface< class ICameraLensEffectInterface >

AddGenericCameraLensEffect ( TSubclassOf< AActor > LensEffectEmitterClass
)

 Creates a camera lens effect of the given class on this camera.
Public function Virtual UCameraModifier * Creates and initializes a new camera modifier of the specified class.
Protected function Virtual Const bool Whether or not we allow photography mode
Protected function Virtual void Internal. Applies appropriate audio fading to the audio system.
Public function Virtual void

ApplyCameraModifiers ( float DeltaTime,
FMinimalViewInfo& InOutPOV
)

 Applies the current set of camera modifiers to the given camera POV.
Public function Virtual void

AssignViewTarget ( AActor* NewTarget,
FTViewTarget& VT,
FViewTargetTransitionParams TransitionParams
)

  
Protected function FPOV

BlendViewTargets ( const FTViewTarget& A,
const FTViewTarget& B,
float Alpha
)

 Internal helper to blend two viewtargets.
Public function bool

BlueprintUpdateCamera ( AActor* CameraTarget,
FVector& NewCameraLocation,
FRotator& NewCameraRotation,
float& NewCameraFOV
)

 Blueprint hook to allow blueprints to override existing camera behavior or implement custom cameras.
Protected function Static float

CalcRadialShakeScale ( APlayerCameraManager* Cam,
FVector Epicenter,
float InnerRadius,
float OuterRadius,
float Falloff
)

 Internal. Calculates shake scale for a particular camera.
Protected function Virtual void

CleanUpAnimCamera ( const bool bDestroy
)

  
Protected function void Removes all postprocess effects.
Public function Virtual void Removes all camera lens effects.
Public function Virtual void

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

  
Protected function Virtual void

DoUpdateCamera ( float DeltaTime
)

 Internal function conditionally called from UpdateCamera to do the actual work of updating the camera.
Public function void

FillCameraCache ( const FMinimalViewInfo& NewInfo
)

 Caches given final POV info for efficient access from other game code.
Public function Virtual UCameraModifier * Returns camera modifier for this camera of the given class, if it exists.
Public function Virtual TScriptInterface< class ICameraLensEffectInterface >

FindGenericCameraLensEffect ( TSubclassOf< AActor > LensEffectEmitterClass
)

 Camera Lens EffectsReturns first instance of a lens effect of the given class.
Public function Const void

GetCachedPostProcessBlends ( TArray< struct FPostProcessSettings > const*& OutPPSettings,
TArray< float > const*& OutBlendWeights
)

 Returns active post process info.
Public function Const void

GetCachedPostProcessBlends ( TArray< struct FPostProcessSettings > const*& OutPPSettings,
TArray< float > const*& OutBlendWeights,
TArray< EViewTargetBlendOrder > const*& OutBlendOrders
)

 Returns active post process info.
Public function Const float Get value of CameraCachePrivate.Time
Public function Virtual Const const FMinimalViewInfo & Gets value of CameraCachePrivate.POV
Public function Virtual Const FVector Returns camera's current location.
Public function Virtual Const FRotator Returns camera's current rotation.
Public function Virtual Const void

GetCameraViewPoint ( FVector& OutCamLoc,
FRotator& OutCamRot
)

 Primary function to retrieve Camera's actual view point.
Public function Virtual Const float Returns the camera's current full FOV angle, in degrees.
Public function Const float Get value of LastFrameCameraCachePrivate.Time
Public function Virtual Const const FMinimalViewInfo & Gets value of LastFrameCameraCachePrivate.POV
Public function Const float  
Public function Virtual Const float Returns the current orthographic width for the camera.
Public function Virtual Const APlayerController * Returns the PlayerController that owns this camera.
Public function Const USceneComponent * Returns TransformComponent subobject
Public function Const AActor * Returns the current ViewTarget.
Public function Const APawn * Returns the ViewTarget if it is an APawn, or nullptr otherwise
Public function Virtual void Initialize this PlayerCameraManager for the given associated PlayerController.
Public function Virtual Const bool Returns true if this camera is using an orthographic perspective.
Public function Virtual void

LimitViewPitch ( FRotator& ViewRotation,
float InViewPitchMin,
float InViewPitchMax
)

 Limit the player's view pitch.
Public function Virtual void

LimitViewRoll ( FRotator& ViewRotation,
float InViewRollMin,
float InViewRollMax
)

 Limit the player's view roll.
Public function Virtual void

LimitViewYaw ( FRotator& ViewRotation,
float InViewYawMin,
float InViewYawMax
)

 Limit the player's view yaw.
Public function Const APlayerCameraManager::FOnBlendComplete TBaseMulticastDelegate_NoParams  
Public function void Event triggered upon the end of a multi-part photograph capture, when manual free-roaming photographic camera control is about to be returned to the user.
Public function void Event triggered upon the start of a multi-part photograph capture (i.e. a stereoscopic or 360-degree shot).
Public function void Event triggered upon leaving Photography mode (after unpausing, if r.Photography.AutoPause is 1).
Public function void Event triggered upon entering Photography mode (before pausing, if r.Photography.AutoPause is 1).
Public function void

PhotographyCameraModify ( const FVector NewCameraLocation,
const FVector PreviousCameraLocation,
const FVector OriginalCameraLocation,
FVector& ResultCameraLocation
)

 Implementable blueprint hook to allow a PlayerCameraManager subclass to constrain or otherwise modify the camera during free-camera photography.
Public function Static void

PlayWorldCameraShake ( UWorld* InWorld,
TSubclassOf< UCameraShakeBase > Shake,
FVector Epicenter,
float InnerRadius,
float OuterRadius,
float Falloff,
bool bOrientShakeTowardsEpicenter
)

 Static.
Public function Virtual void

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

 Called to give PlayerCameraManager a chance to adjust view rotation updates before they are applied.
Public function Virtual void  
Public function Virtual bool

RemoveCameraModifier ( UCameraModifier* ModifierToRemove
)

 Removes the given camera modifier from this camera (if it's on the camera in the first place) and discards it.
Public function Virtual void Removes the given lens effect from the camera.
Public function Virtual void Sets value of CameraCachePrivate.POV
Protected function void

SetCameraCacheTime ( float InTime
)

 Get value of CameraCachePrivate.Time
Public function Virtual void

SetDesiredColorScale ( FVector NewColorScale,
float InterpTime
)

 Sets the new desired color scale, enables color scaling, and enables color scale interpolation.
Public function Virtual void

SetFOV ( float NewFOV
)

 Locks the FOV to the given value. Unlock with UnlockFOV.
Public function Virtual void Sets the bGameCameraCutThisFrame flag to true (indicating we did a camera cut this frame; useful for game code to call, e.g., when performing a teleport that should be seamless)
Public function Virtual void Sets value of LastFrameCameraCachePrivate.POV
Protected function void

SetLastFrameCameraCacheTime ( float InTime
)

 Get value of LastFrameCameraCachePrivate.Time
Public function Virtual void

SetManualCameraFade ( float InFadeAmount,
FLinearColor Color,
bool bInFadeAudio
)

 Turns on camera fading at the given opacity.
Public function Virtual void

SetOrthoWidth ( float OrthoWidth
)

 Sets and locks the current orthographic width for the camera.
Public function Virtual void

SetViewTarget ( AActor* NewViewTarget,
FViewTargetTransitionParams TransitionParams
)

 Sets a new ViewTarget.
Public function Virtual void

StartCameraFade ( float FromAlpha,
float ToAlpha,
float Duration,
FLinearColor Color,
bool bShouldFadeAudio,
bool bHoldWhenFinished
)

 Camera fades. Does a camera fade to/from a solid color. Animates automatically. Camera fades
Public function Virtual UCameraShakeBase *

StartCameraShake ( TSubclassOf< UCameraShakeBase > ShakeClass,
float Scale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRot
)

 Camera Shakes. Plays a camera shake on this camera. Camera Shakes
Public function Virtual UCameraShakeBase *

StartCameraShakeFromSource ( TSubclassOf< UCameraShakeBase > ShakeClass,
UCameraShakeSourceComponent* SourceComponent,
float Scale,
ECameraShakePlaySpace PlaySpace,
FRotator UserPlaySpaceRot
)

 Plays a camera shake on this camera.
Public function Virtual void

StopAllCameraShakes ( bool bImmediately
)

 Stops all active camera shakes on this camera.
Public function Virtual void

StopAllCameraShakesFromSource ( UCameraShakeSourceComponent* SourceComponent,
bool bImmediately
)

 Stops playing all shakes originating from the given source.
Public function Virtual void Stops playing all shakes of the given class.
Public function Virtual void Stops playing all shakes of the given class originating from the given source.
Protected function Virtual void  
Public function Virtual void Stops camera fading.
Public function Virtual void

StopCameraShake ( UCameraShakeBase* ShakeInstance,
bool bImmediately
)

 Immediately stops the given shake instance and invalidates it.
Protected function void ClientSide camera updates prevents DoUpdateCamera from swapping PendingViewTarget in when the blend is complete, just use a timer to swap.
Public function Virtual void Unlocks the FOV.
Public function Virtual void Unlocks OrthoWidth value
Public function Virtual void

UpdateCamera ( float DeltaTime
)

 Performs per-tick camera update.
Protected function Virtual void Update any attached camera lens effects
Public function Virtual void Performs a photography camera tick even when the camera wouldn't normally be ticking.
Protected function Virtual bool Overridable.
Public function Virtual void Allows the photography system to override postprocessing
Protected function Virtual void

UpdateViewTarget ( FTViewTarget& OutVT,
float DeltaTime
)

 Calculates an updated POV for the given viewtarget.
Protected function Virtual void

UpdateViewTargetInternal ( FTViewTarget& OutVT,
float DeltaTime
)

 Does the actual work to UpdateViewTarget.

Overridden from AActor

  Type Name Description
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owning level to shift an actor location and all relevant data structures by specified delta
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Public function Virtual Const bool If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly

Classes

  Type Name Description
Public class FOnBlendComplete Fires when ViewTarget is set to PendingViewTarget  

Deprecated Functions

  Type Name Description
Public function Virtual AEmitterCameraLensEffectBase * APlayerCameraManager::FindGenericCameraLensEffect is favored now, and this function forwards to that one.
Public function Virtual Const FMinimalViewInfo APlayerCameraManager::GetCameraCacheView is favored now, and this function forwards to that one.
Public function Virtual Const FMinimalViewInfo APlayerCameraManager::GetLastFrameCameraCacheView is favored now, and this function forwards to that one.

See Also

https://docs.unrealengine.com/latest/INT/Gameplay/Framework/Camera/

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page