FCameraEvaluationService

An evaluation service running on a camera system.

API > API/Plugins > API/Plugins/GameplayCameras

An evaluation service running on a camera system.

Evaluation services can run arbitrary logic before or after the root camera node update, and respond to events in the node tree such as when camera rigs are activated or deactivated.

   
Name FCameraEvaluationService
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraEvaluationService.h
Include Path #include "Core/CameraEvaluationService.h"

Syntax

class FCameraEvaluationService : public TSharedFromThis< FCameraEvaluationService >

Inheritance Hierarchy

Derived Classes

FCameraEvaluationService derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FCameraEvaluationService()

   Core/CameraEvaluationService.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCameraEvaluationService()

   Core/CameraEvaluationService.h  

Typedefs

Name Type Remarks Include Path
FCameraObjectTypeID ::UE::Cameras::FCameraObjectTypeID   Core/CameraEvaluationService.h

Constants

Name Type Remarks Include Path
PrivateTypeID const ::UE::Cameras::TCameraObjectTypeID< FCameraEvaluationService >   Core/CameraEvaluationService.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Evaluator FCameraSystemEvaluator * The camera system that this service lives inside of. Core/CameraEvaluationService.h  
PrivateFlags ECameraEvaluationServiceFlags Evaluation service flags. Core/CameraEvaluationService.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Collect referenced UObjects. Core/CameraEvaluationService.h  

void BuildDebugBlocks ( const FCameraDebugBlockBuildParams& Params,
FCameraDebugBlockBuilder& Builder
)

 Called to create debug blocks for this node evaluator. Core/CameraEvaluationService.h  

const Type * CastThis ()

   Core/CameraEvaluationService.h  

Type * CastThis ()

   Core/CameraEvaluationService.h  

const Type * CastThisChecked ()

   Core/CameraEvaluationService.h  

Type * CastThisChecked ()

   Core/CameraEvaluationService.h  

ECameraEvaluationServiceFlags GetEvaluationServiceFlags()

   Core/CameraEvaluationService.h  

bool HasAllEvaluationServiceFlags ( ECameraEvaluationServiceFlags InFlags
) const

   Core/CameraEvaluationService.h  

void Initialize ( const FCameraEvaluationServiceInitializeParams& Params
)

 Initializes the evaluation service. Core/CameraEvaluationService.h  

bool IsKindOf ()

   Core/CameraEvaluationService.h  

void PostCameraDirectorUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs after the camera director update. Core/CameraEvaluationService.h  

void PostUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs at the end of the camera system update. Core/CameraEvaluationService.h  

void PreUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs at the start of the camera system update. Core/CameraEvaluationService.h  

void Teardown ( const FCameraEvaluationServiceTeardownParams& Params
)

 Tears down the evaluation service. Core/CameraEvaluationService.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual const FCameraObjectTypeID & GetTypeID()

   Core/CameraEvaluationService.h  

virtual bool IsKindOf ( const FCameraObjectTypeID& InTypeID
) const

   Core/CameraEvaluationService.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SetEvaluationServiceFlags ( ECameraEvaluationServiceFlags InFlags
)

 Sets the flags on this service. Can be called from the constructor, or during OnInitialize(). Core/CameraEvaluationService.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void OnAddReferencedObjects ( FReferenceCollector& Collector
)

 Collect referenced UObjects. Core/CameraEvaluationService.h  

virtual void OnBuildDebugBlocks ( const FCameraDebugBlockBuildParams& Params,
FCameraDebugBlockBuilder& Builder
)

 Called to create debug blocks for this node evaluator. Core/CameraEvaluationService.h  

virtual void OnInitialize ( const FCameraEvaluationServiceInitializeParams& Params
)

 Initializes the evaluation service. Core/CameraEvaluationService.h  

virtual void OnPostCameraDirectorUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs after the camera director update. Core/CameraEvaluationService.h  

virtual void OnPostUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs at the end of the camera system update. Core/CameraEvaluationService.h  

virtual void OnPreUpdate ( const FCameraEvaluationServiceUpdateParams& Params,
FCameraEvaluationServiceUpdateResult& OutResult
)

 Runs at the start of the camera system update. Core/CameraEvaluationService.h  

virtual void OnRootCameraNodeEvent ( const FRootCameraNodeCameraRigEvent& InEvent
)

 Called when the root camera node experiences an event. Core/CameraEvaluationService.h  

virtual void OnTeardown ( const FCameraEvaluationServiceTeardownParams& Params
)

 Tears down the evaluation service. Core/CameraEvaluationService.h  

Static

Name Remarks Include Path Unreal Specifiers
  Core/CameraEvaluationService.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page