Navigation
API > API/Plugins > API/Plugins/GameplayCameras
An interface for objects that host a camera system evaluator.
| Name | IGameplayCameraSystemHost |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/GameFramework/IGameplayCameraSystemHost.h |
| Include Path | #include "GameFramework/IGameplayCameraSystemHost.h" |
Syntax
class IGameplayCameraSystemHost
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCameraSystemEvaluator | UE::Cameras::FCameraSystemEvaluator | GameFramework/IGameplayCameraSystemHost.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DebugDrawDelegateHandle | FDelegateHandle | GameFramework/IGameplayCameraSystemHost.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UObject * GetAsObject() |
Should be implemented by the underlying class to return itself as a UObject. | GameFramework/IGameplayCameraSystemHost.h | |
TScriptInterface< IGameplayCameraSystemHost > GetAsScriptInterface() |
Returns this object as a script interface. | GameFramework/IGameplayCameraSystemHost.h | |
TSharedPtr< FCameraSystemEvaluator > GetCameraSystemEvaluator() |
Gets the camera system evaluator. | GameFramework/IGameplayCameraSystemHost.h | |
bool HasCameraSystem() |
Returns whether a camera system evaluation has been created in this host. | GameFramework/IGameplayCameraSystemHost.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateCameraRig
(
UCameraRigAsset* CameraRig, |
Activates the given camera rig in the given layer. Should not be used with Main layer. | GameFramework/IGameplayCameraSystemHost.h | |
void DestroyCameraSystem() |
Destroys the camera system. | GameFramework/IGameplayCameraSystemHost.h | |
void EnsureCameraSystemInitialized() |
Ensures that the camera system is created. | GameFramework/IGameplayCameraSystemHost.h | |
void InitializeCameraSystem () |
Creates a new camera system. Asserts if there is already one. | GameFramework/IGameplayCameraSystemHost.h | |
void InitializeCameraSystem
(
const UE::Cameras::FCameraSystemEvaluatorCreateParams& Params |
Creates a new camera system. Asserts if there is already one. | GameFramework/IGameplayCameraSystemHost.h | |
void OnAddReferencedObjects
(
FReferenceCollector& Collector |
Should be called by the underlying object for garbage collection. | GameFramework/IGameplayCameraSystemHost.h | |
void UpdateCameraSystem
(
float DeltaTime |
Updates the camera system, if it exists. | GameFramework/IGameplayCameraSystemHost.h | |
void UpdateCameraSystemForEditorPreview
(
float DeltaTime |
Updates the camera system, if it exists, for an editor world preview. | GameFramework/IGameplayCameraSystemHost.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IGameplayCameraSystemHost * FindActiveHost
(
APlayerController* PlayerController |
Finds a valid host on the player controller's camera manager, or its view target. | GameFramework/IGameplayCameraSystemHost.h |