Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → AActor → APlayerCameraManager → AGameplayCamerasPlayerCameraManager
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 |
|
| ViewRotationMode | EGameplayCamerasViewRotationMode | The view rotation handling mode to use. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
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 |
|
|
| 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 |
|
void ActivatePersistentGlobalCameraRig
(
UCameraRigAsset* CameraRig |
Activates the given camera rig prefab in the global layer. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
void ActivatePersistentVisualCameraRig
(
UCameraRigAsset* CameraRig |
Activates the given camera rig prefab in the visual layer. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
bool IsCameraShakeAssetPlaying
(
FCameraShakeInstanceID InInstanceID |
Checks if a camera shake is running. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
void ReleasePlayerController() |
Restore an originally stolen camera manager (see StealPlayerController). | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
FCameraShakeInstanceID StartCameraShakeAsset
(
const UCameraShakeAsset* CameraShake, |
Starts a new camera shake. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
FCameraRigInstanceID StartGlobalCameraModifierRig
(
const UCameraRigAsset* CameraRig, |
Starts a camera modifier rig on the global layer. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
FCameraRigInstanceID StartVisualCameraModifierRig
(
const UCameraRigAsset* CameraRig, |
Starts a camera modifier rig on the visual layer. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
void StealPlayerController
(
APlayerController* PlayerController |
Replace the camera manager currently set on the provided controller with this camera manager. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
void StopCameraModifierRig
(
FCameraRigInstanceID InstanceID, |
Stops a camera modifier rig on previously started on the global or visual layer. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
bool StopCameraShakeAsset
(
FCameraShakeInstanceID InInstanceID, |
Stops a running camera shake. | GameFramework/GameplayCamerasPlayerCameraManager.h |
|
Overridden from APlayerCameraManager
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DisplayDebug
(
UCanvas* Canvas, |
GameFramework/GameplayCamerasPlayerCameraManager.h | ||
virtual void InitializeFor
(
APlayerController* PlayerController |
GameFramework/GameplayCamerasPlayerCameraManager.h | ||
virtual void ProcessViewRotation
(
float DeltaTime, |
GameFramework/GameplayCamerasPlayerCameraManager.h | ||
virtual void SetViewTarget
(
AActor* NewViewTarget, |
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, |
GameFramework/GameplayCamerasPlayerCameraManager.h |