1. Epic GamesDeveloper
  3. FCameraSystemEvaluator

FCameraSystemEvaluator

The main camera system evaluator class.

API > API/Plugins > API/Plugins/GameplayCameras

The main camera system evaluator class.

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

Syntax

class FCameraSystemEvaluator : public TSharedFromThis< FCameraSystemEvaluator >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FCameraSystemEvaluator()

 Builds a new camera system. Initialize must be called before the system is used. Core/CameraSystemEvaluator.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCameraSystemEvaluator()

   Core/CameraSystemEvaluator.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CameraRigCombinationRegistry TSharedPtr< FCameraRigCombinationRegistry > Registry for programmatically building combinations of camera rigs. Core/CameraSystemEvaluator.h  
ContextStack FCameraEvaluationContextStack The stack of active evaluation context. Core/CameraSystemEvaluator.h  
DebugBlockStorage FCameraDebugBlockStorage Storage for debug drawing blocks. Core/CameraSystemEvaluator.h  
DebugID FCameraSystemDebugID The debug ID for this camera system. Core/CameraSystemEvaluator.h  
EvaluationServices TArray< TSharedPtr< FCameraEvaluationService > > The list of evaluation services. Core/CameraSystemEvaluator.h  
EvaluatorSnapshot TArray< uint8 > Reusable buffer for node tree snapshots (e.g. view rotation preview update). Core/CameraSystemEvaluator.h  
PreVisualResult FCameraSystemEvaluationResult The current overall result of the camera system without the contribution of the visual layer. Core/CameraSystemEvaluator.h  
Result FCameraSystemEvaluationResult The current overall result of the camera system. Core/CameraSystemEvaluator.h  
Role ECameraSystemEvaluatorRole The role of this camera system. Core/CameraSystemEvaluator.h  
RootDebugBlock FRootCameraDebugBlock * The root debug drawing block. Core/CameraSystemEvaluator.h  
RootEvaluator FRootCameraNodeEvaluator * The root evaluator. Core/CameraSystemEvaluator.h  
RootEvaluatorStorage FCameraNodeEvaluatorStorage Storage buffer for the root evaluator. Core/CameraSystemEvaluator.h  
RootNode TObjectPtr< URootCameraNode > The root camera node. Core/CameraSystemEvaluator.h  
RootNodeResult FCameraNodeEvaluationResult The current result of the root camera node. Core/CameraSystemEvaluator.h  
WeakOwner TWeakObjectPtr The owner (if any) of this camera system evaluator. Core/CameraSystemEvaluator.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Collect reference objects for the garbage collector. Core/CameraSystemEvaluator.h  

void DebugUpdate ( const FCameraSystemDebugUpdateParams& Params
)

   Core/CameraSystemEvaluator.h  

void DrawEditorPreview ( const FCameraSystemEditorPreviewParams& Params
)

 Render information about the state of the camera system in-editor. Core/CameraSystemEvaluator.h  

void EditorPreviewUpdate ( const FCameraSystemEvaluationParams& Params
)

 Run an update suitable for an in-editor preview. Core/CameraSystemEvaluator.h  

void ExecuteOperation ( FCameraOperation& Operation
)

 Executes an operation, to be dispatched by the root node evaluator. Core/CameraSystemEvaluator.h  
Finds an evaluation service of the given type. Core/CameraSystemEvaluator.h  

TSharedPtr< EvaluationServiceType > FindEvaluationService ()

 Finds an evaluation service of the given type. Core/CameraSystemEvaluator.h  

TSharedRef< EvaluationServiceType > FindOrRegisterEvaluationService()

 Finds or creates/registers an evaluation service of the given type. Core/CameraSystemEvaluator.h  

FCameraSystemDebugID GetDebugID()

 Gets the debug ID for this camera system. Core/CameraSystemEvaluator.h  

void GetEvaluatedCameraView ( FMinimalViewInfo& DesiredView
)

 Get the last evaluated camera. Core/CameraSystemEvaluator.h  

const FCameraSystemEvaluationResult & GetEvaluatedResult()

 Gets the evaluated result. Core/CameraSystemEvaluator.h  
Gets the context stack. Core/CameraSystemEvaluator.h  
Gets the context stack. Core/CameraSystemEvaluator.h  

void GetEvaluationServices ( TArray< TSharedPtr< FCameraEvaluationService > >& OutEvaluationServices
) const

 Get currently registered evaluation services. Core/CameraSystemEvaluator.h  

UObject * GetOwner()

 Gets the owner of this camera system, if any, and if still valid. Core/CameraSystemEvaluator.h  

const FCameraSystemEvaluationResult & GetPreVisualLayerEvaluatedResult()

 Gets the evaluated result without the contribution of the visual layer. Core/CameraSystemEvaluator.h  
Gets the role of this camera system. Core/CameraSystemEvaluator.h  

FRootCameraNodeEvaluator * GetRootNodeEvaluator()

 Returns the root node evaluator. Core/CameraSystemEvaluator.h  
Initializes the camera system. Core/CameraSystemEvaluator.h  

void Initialize ( TObjectPtr< UObject > InOwner
)

 Initializes the camera system. Core/CameraSystemEvaluator.h  

void PopEvaluationContext()

 Pop the active (top) evaluation context from the stack. Core/CameraSystemEvaluator.h  

void PushEvaluationContext ( TSharedRef< FCameraEvaluationContext > EvaluationContext
)

 Push a new evaluation context on the stack. Core/CameraSystemEvaluator.h  

void RegisterEvaluationService ( TSharedRef< FCameraEvaluationService > EvaluationService
)

 Registers an evaluation service on this camera system. Core/CameraSystemEvaluator.h  

void RemoveEvaluationContext ( TSharedRef< FCameraEvaluationContext > EvaluationContext
)

 Remove an existing evaluation context from the stack. Core/CameraSystemEvaluator.h  

void UnregisterEvaluationService ( TSharedRef< FCameraEvaluationService > EvaluationService
)

 Unregisters an evaluation service from this camera system. Core/CameraSystemEvaluator.h  

void Update ( const FCameraSystemEvaluationParams& Params
)

 Run an update of the camera system. Core/CameraSystemEvaluator.h  

void ViewRotationPreviewUpdate ( const FCameraSystemEvaluationParams& Params,
FCameraSystemViewRotationEvaluationResult& OutResult
)

 Run a view rotation preview update of the camera system. Core/CameraSystemEvaluator.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsDebugTraceEnabled()

   Core/CameraSystemEvaluator.h  

static bool ShouldBuildOrDrawDebugBlocks()

   Core/CameraSystemEvaluator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page