Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Camera > APlayerCameraManager

Light Theme

Dark Theme

APlayerCameraManager

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

APlayerCameraManager

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

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

Constructors

	Name	Description
	APlayerCameraManager ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~APlayerCameraManager()	Destructor for handling property deprecation, please remove after all deprecated properties are gone

Functions

	Name	Description
void	AddCachedPPBlend ( FPostProcessSettings& PPSettings, float BlendWeight )	Adds a postprocess effect at the given weight.
AEmitterCame...	AddCameraLensEffect ( TSubclassOf< class AEmitterCameraLe... )	Creates a camera lens effect of the given class on this camera.
bool	AddCameraModifierToList ( UCameraModifier* NewModifier )	Places the given modifier in the ModifierList at the appropriate priority.
UCameraModif...	AddNewCameraModifier ( TSubclassOf< UCameraModifier > Modi... )	Creates and initializes a new camera modifier of the specified class.
UCameraAnimI...	AllocCameraAnimInst()	Returns an available CameraAnimInst, or NULL if no more are available.
bool	AllowPhotographyMode()	Whether or not we allow photography mode
void	ApplyAnimToCamera ( ACameraActor const* AnimatedCa..., UCameraAnimInst const* AnimIns..., FMinimalViewInfo& InOutPOV )
void	ApplyAudioFade()	Applies appropriate audio fading to the audio system.
void	ApplyCameraModifiers ( float DeltaTime, FMinimalViewInfo& InOutPOV )	Applies the current set of camera modifiers to the given camera POV.
void	AssignViewTarget ( AActor* NewTarget, FTViewTarget& VT, FViewTargetTransitionParams Transit... )
FPOV	BlendViewTargets ( const FTViewTarget& A, const FTViewTarget& B, float Alpha )	Internal helper to blend two viewtargets.
bool	BlueprintUpdateCamera ( AActor* CameraTarget, FVector& NewCameraLocation, FRotator& NewCameraRotation, float& NewCameraFOV )	Blueprint hook to allow blueprints to override existing camera behavior or implement custom cameras.
float	CalcRadialShakeScale ( APlayerCameraManager* Cam, FVector Epicenter, float InnerRadius, float OuterRadius, float Falloff )	Calculates shake scale for a particular camera.
void	ClearCachedPPBlends()	Removes all postprocess effects.
void	ClearCameraLensEffects()	Removes all camera lens effects.
void	DisplayDebug ( UCanvas* Canvas, const FDebugDisplayInfo& DebugDisp..., float& YL, float& YPos )
void	DoUpdateCamera ( float DeltaTime )	Internal function conditionally called from UpdateCamera to do the actual work of updating the camera.
void	FillCameraCache ( const FMinimalViewInfo& NewInfo )	Caches given final POV info for efficient access from other game code.
AEmitterCame...	FindCameraLensEffect ( TSubclassOf< class AEmitterCameraLe... )	Camera Lens EffectsReturns first instance of a lens effect of the given class.
UCameraModif...	FindCameraModifierByClass ( TSubclassOf< UCameraModifier > Modi... )	Returns camera modifier for this camera of the given class, if it exists.
UCameraAnimI...	FindInstanceOfCameraAnim ( UCameraAnim const* Anim )	Returns first existing instance of the specified camera anim, or NULL if none exists.
void	GetCachedPostProcessBlends ( TArray< struct FPostProcessSettings..., TArray< float > const*& OutBle... )	Returns active post process info.
FMinimalView...	GetCameraCachePOV()	Gets value of CameraCachePrivate.POV
float	GetCameraCacheTime()	Get value of CameraCachePrivate.Time
FVector	GetCameraLocation()	Returns camera's current location.
FRotator	GetCameraRotation()	Returns camera's current rotation.
void	GetCameraViewPoint ( FVector& OutCamLoc, FRotator& OutCamRot )	Master function to retrieve Camera's actual view point.
float	GetFOVAngle()	Returns the camera's current full FOV angle, in degrees.
FMinimalView...	GetLastFrameCameraCachePOV()	Gets value of LastFrameCameraCachePrivate.POV
float	GetLastFrameCameraCacheTime()	Get value of LastFrameCameraCachePrivate.Time
float	GetLockedFOV()
float	GetOrthoWidth()	Returns the current orthographic width for the camera.
APlayerContr...	GetOwningPlayerController()	Returns the PlayerController that owns this camera.
USceneCompon...	GetTransformComponent()	Returns TransformComponent subobject
AActor *	GetViewTarget()	Returns the current ViewTarget.
APawn *	GetViewTargetPawn()	Returns the ViewTarget if it is an APawn, or nullptr otherwise
void	InitializeFor ( APlayerController* PC )	Initialize this PlayerCameraManager for the given associated PlayerController.
void	InitTempCameraActor ( ACameraActor* CamActor, UCameraAnimInst const* AnimIns... )	Gets specified temporary CameraActor ready to update the specified Anim.
bool	IsOrthographic()	Returns true if this camera is using an orthographic perspective.
void	LimitViewPitch ( FRotator& ViewRotation, float InViewPitchMin, float InViewPitchMax )	Limit the player's view pitch.
void	LimitViewRoll ( FRotator& ViewRotation, float InViewRollMin, float InViewRollMax )	Limit the player's view roll.
void	LimitViewYaw ( FRotator& ViewRotation, float InViewYawMin, float InViewYawMax )	Limit the player's view yaw.
APlayerCamer...	OnBlendComplete()
void	OnPhotographyMultiPartCaptureEnd()	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.
void	OnPhotographyMultiPartCaptureStart()	Event triggered upon the start of a multi-part photograph capture (i.e. a stereoscopic or 360-degree shot).
void	OnPhotographySessionEnd()	Event triggered upon leaving Photography mode (after unpausing, if r.Photography.AutoPause is 1).
void	OnPhotographySessionStart()	Event triggered upon entering Photography mode (before pausing, if r.Photography.AutoPause is 1).
void	PhotographyCameraModify ( const FVector NewCameraLocation, const FVector PreviousCameraLocatio..., const FVector OriginalCameraLocatio..., FVector& ResultCameraLocation )	Implementable blueprint hook to allow a PlayerCameraManager subclass to constrain or otherwise modify the camera during free-camera photography.
UCameraAnimI...	PlayCameraAnim ( UCameraAnim* Anim, float Rate, float Scale, float BlendInTime, float BlendOutTime, bool bLoop, bool bRandomStartTime, float Duration, ECameraShakePlaySpace PlaySpace, FRotator UserPlaySpaceRot )	CameraAnim support. Play the indicated CameraAnim on this camera.
void	PlayWorldCameraShake ( UWorld* InWorld, TSubclassOf< UCameraShakeBase > Sha..., FVector Epicenter, float InnerRadius, float OuterRadius, float Falloff, bool bOrientShakeTowardsEpicenter )	Static.
void	ProcessViewRotation ( float DeltaTime, FRotator& OutViewRotation, FRotator& OutDeltaRot )	Called to give PlayerCameraManager a chance to adjust view rotation updates before they are applied.
void	ReleaseCameraAnimInst ( UCameraAnimInst* Inst )	Frees an allocated CameraAnimInst for future use.
void	RemoveCameraLensEffect ( AEmitterCameraLensEffectBase* ... )	Removes the given lens effect from the camera.
bool	RemoveCameraModifier ( UCameraModifier* ModifierToRem... )	Removes the given camera modifier from this camera (if it's on the camera in the first place) and discards it.
void	SetCameraCachePOV ( const FMinimalViewInfo& InPOV )	Sets value of CameraCachePrivate.POV
void	SetCameraCacheTime ( float InTime )	Get value of CameraCachePrivate.Time
void	SetDesiredColorScale ( FVector NewColorScale, float InterpTime )	Sets the new desired color scale, enables color scaling, and enables color scale interpolation.
void	SetFOV ( float NewFOV )	Locks the FOV to the given value. Unlock with UnlockFOV.
void	SetGameCameraCutThisFrame()	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)
void	SetLastFrameCameraCachePOV ( const FMinimalViewInfo& InPOV )	Sets value of LastFrameCameraCachePrivate.POV
void	SetLastFrameCameraCacheTime ( float InTime )	Get value of LastFrameCameraCachePrivate.Time
void	SetManualCameraFade ( float InFadeAmount, FLinearColor Color, bool bInFadeAudio )	Turns on camera fading at the given opacity.
void	SetOrthoWidth ( float OrthoWidth )	Sets and locks the current orthographic width for the camera.
void	SetViewTarget ( AActor* NewViewTarget, FViewTargetTransitionParams Transit... )	Sets a new ViewTarget.
void	StartCameraFade ( float FromAlpha, float ToAlpha, float Duration, FLinearColor Color, bool bShouldFadeAudio, bool bHoldWhenFinished )	CameraAnim fades. Does a camera fade to/from a solid color. Animates automatically. Camera fades
UCameraShake...	StartCameraShake ( TSubclassOf< UCameraShakeBase > Sha..., float Scale, ECameraShakePlaySpace PlaySpace, FRotator UserPlaySpaceRot )	Camera Shakes. Plays a camera shake on this camera. Camera Shakes
UCameraShake...	StartCameraShakeFromSource ( TSubclassOf< UCameraShakeBase > Sha..., UCameraShakeSourceComponent* S..., float Scale, ECameraShakePlaySpace PlaySpace, FRotator UserPlaySpaceRot )	Plays a camera shake on this camera.
void	StopAllCameraAnims ( bool bImmediate )	Stop playing all CameraAnims on this CameraManager.
void	StopAllCameraShakes ( bool bImmediately )	Stops all active camera shakes on this camera.
void	StopAllCameraShakesFromSource ( UCameraShakeSourceComponent* S..., bool bImmediately )	Stops playing all shakes originating from the given source.
void	StopAllInstancesOfCameraAnim ( UCameraAnim* Anim, bool bImmediate )	Stop playing all instances of the indicated CameraAnim.
void	StopAllInstancesOfCameraShake ( TSubclassOf< UCameraShakeBase > Sha..., bool bImmediately )	Stops playing all shakes of the given class.
void	StopAllInstancesOfCameraShakeFromSource ( TSubclassOf< UCameraShakeBase > Sha..., UCameraShakeSourceComponent* S..., bool bImmediately )	Stops playing all shakes of the given class originating from the given source.
void	StopAudioFade()
void	StopCameraAnimInst ( UCameraAnimInst* AnimInst, bool bImmediate )	Stops the given CameraAnimInst from playing.
void	StopCameraFade()	Stops camera fading.
void	StopCameraShake ( UCameraShakeBase* ShakeInstanc..., bool bImmediately )	Immediately stops the given shake instance and invalidates it.
void	SwapPendingViewTargetWhenUsingClientSideCameraUpdates()	ClientSide camera updates prevents DoUpdateCamera from swapping PendingViewTarget in when the blend is complete, just use a timer to swap.
void	UnlockFOV()	Unlocks the FOV.
void	UnlockOrthoWidth()	Unlocks OrthoWidth value
void	UpdateCamera ( float DeltaTime )	Performs per-tick camera update.
void	UpdateCameraLensEffects ( const FTViewTarget& OutVT )	Update any attached camera lens effects
void	UpdateCameraPhotographyOnly()	Performs a photography camera tick even when the camera wouldn't normally be ticking.
bool	UpdatePhotographyCamera ( FMinimalViewInfo& NewPOV )	Overridable.
void	UpdatePhotographyPostProcessing ( FPostProcessSettings& InOutPostPro... )	Allows the photography system to override postprocessing
void	UpdateViewTarget ( FTViewTarget& OutVT, float DeltaTime )	Calculates an updated POV for the given viewtarget.
void	UpdateViewTargetInternal ( FTViewTarget& OutVT, float DeltaTime )	Does the actual work to UpdateViewTarget.

Overridden from AActor

	Name	Description
void	ApplyWorldOffset ( const FVector& InOffset, bool bWorldShift )	Called by owning level to shift an actor location and all relevant data structures by specified delta
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
void	PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
bool	ShouldTickIfViewportsOnly()	If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly

Classes

	Name	Description
	FOnBlendComplete	Fires when ViewTarget is set to PendingViewTarget

Constants

Name	Description
MAX_ACTIVE_CAMERA_ANIMS	CameraAnim support.

Deprecated Variables

		Name	Description
	FCameraCacheEnt...	CameraCache	This property is now deprecated, please use GetCameraCachePOV and SetCameraCachePOV functions instead.
	FCameraCacheEnt...	LastFrameCameraCache	This property is now deprecated, please use GetLastFrameCameraCachePOV and SetLastFrameCameraCachePOV functions instead.