Navigation
API > API/Plugins > API/Plugins/GameplayCameras
An evaluation service for running "camera modifiers", which are context-less camera rig instances meant to run additively in the camera system.
| Name | FCameraModifierService |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Services/CameraModifierService.h |
| Include Path | #include "Services/CameraModifierService.h" |
Syntax
class FCameraModifierService : public UE::Cameras::FCameraEvaluationService
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FCameraEvaluationService → FCameraModifierService
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FCameraEvaluationService | Services/CameraModifierService.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FirstBlendStackOrderKey | const int32 | Services/CameraModifierService.h | |
| PrivateTypeID | GAMEPLAYCAMERAS_API const ::UE::Cameras::TCameraObjectTypeID< FCameraModifierService > | Services/CameraModifierService.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Evaluator | FCameraSystemEvaluator * | Services/CameraModifierService.h | ||
| ModifierContext | TSharedPtr< FCameraEvaluationContext > | Services/CameraModifierService.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCameraRigInstanceID StartCameraModifierRig
(
const UCameraRigAsset* CameraRig, |
Starts a new instance of the given camera rig, using a "null" context. | Services/CameraModifierService.h | |
FCameraRigInstanceID StartCameraModifierRig
(
const UCameraRigAsset* CameraRig, |
Starts a new instance of the given camera rig, using the given context. | Services/CameraModifierService.h | |
void StopCameraModifierRig
(
FCameraRigInstanceID CameraRigID, |
Stops a running instance of a camera rig. | Services/CameraModifierService.h |
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FCameraObjectTypeID & GetTypeID() |
Services/CameraModifierService.h | ||
virtual bool IsKindOf
(
const FCameraObjectTypeID& InTypeID |
Services/CameraModifierService.h |
Protected
Overridden from FCameraEvaluationService
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnInitialize
(
const FCameraEvaluationServiceInitializeParams& Params |
Initializes the evaluation service. | Services/CameraModifierService.h | |
virtual void OnTeardown
(
const FCameraEvaluationServiceTeardownParams& Params |
Tears down the evaluation service. | Services/CameraModifierService.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 GetFirstBlendStackOrderKey() |
Blend stack order key for modifiers. | Services/CameraModifierService.h | |
static const ::UE::Cameras::TCameraObjectTypeID< FCameraModifierService > & StaticTypeID() |
Services/CameraModifierService.h |