1. Epic GamesDeveloper
  3. FCameraDirectorEvaluator

FCameraDirectorEvaluator

Base class for camera director evaluators.

API > API/Plugins > API/Plugins/GameplayCameras

Base class for camera director evaluators.

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

Syntax

class FCameraDirectorEvaluator

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FCameraDirectorEvaluator()

   Core/CameraDirectorEvaluator.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCameraDirectorEvaluator()

   Core/CameraDirectorEvaluator.h  

Structs

Name Remarks
FChildContextManulationParams Parameter struct for adding/removing children contexts.
FChildContextManulationResult Result struct for adding/removing children contexts.

Enums

Protected

Name Remarks
EChildContextManipulationResult Result for adding/removing children contexts.

Typedefs

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

Constants

Name Type Remarks Include Path
PrivateTypeID GAMEPLAYCAMERAS_API const ::UE::Cameras::TCameraObjectTypeID< FCameraDirectorEvaluator >   Core/CameraDirectorEvaluator.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bNextActivationForce bool Whether to force camera rig activation on the next update. Cleared after every system update. Core/CameraDirectorEvaluator.h  
Evaluator FCameraSystemEvaluator * The camera system this evaluator is running inside of. Core/CameraDirectorEvaluator.h  
NextActivationTransitionOverride TObjectPtr< const UCameraRigTransition > A forced transition to use on the next update. Cleared after every system update. Core/CameraDirectorEvaluator.h  
PrivateCameraDirector TObjectPtr< const UCameraDirector > The camera director this evaluator is running. Core/CameraDirectorEvaluator.h  
WeakOwnerContext TWeakPtr< FCameraEvaluationContext > The evaluation context that owns this evaluator. Core/CameraDirectorEvaluator.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Activate ( const FCameraDirectorActivateParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Activates the camera director evaluator. Core/CameraDirectorEvaluator.h  

bool AddChildEvaluationContext ( TSharedRef< FCameraEvaluationContext > InContext
)

 Add a child context to this camera director. Core/CameraDirectorEvaluator.h  

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Garbage collection pass. Core/CameraDirectorEvaluator.h  

const Type * CastThis ()

   Core/CameraDirectorEvaluator.h  

Type * CastThis ()

   Core/CameraDirectorEvaluator.h  

const Type * CastThisChecked ()

   Core/CameraDirectorEvaluator.h  

Type * CastThisChecked ()

   Core/CameraDirectorEvaluator.h  

void Deactivate ( const FCameraDirectorDeactivateParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Deactivates the camera director evaluator. Core/CameraDirectorEvaluator.h  

const UCameraRigAsset * FindCameraRigByProxy ( const UCameraRigProxyAsset* InProxy
) const

   Core/CameraDirectorEvaluator.h  

void ForceNextActivation()

 Request that the next camera rig activation be forced. Core/CameraDirectorEvaluator.h  

const UCameraDirector * GetCameraDirector()

 Gets the camera director. Core/CameraDirectorEvaluator.h  

const CameraDirectorType * GetCameraDirectorAs()

 Gets the camera director. Core/CameraDirectorEvaluator.h  

TSharedPtr< FCameraEvaluationContext > GetEvaluationContext()

 Gets the owning evaluation context. Core/CameraDirectorEvaluator.h  

virtual const FCameraObjectTypeID & GetTypeID()

   Core/CameraDirectorEvaluator.h  

void Initialize ( const FCameraDirectorInitializeParams& Params
)

 Initializes a camera director evalutor. Core/CameraDirectorEvaluator.h  

virtual bool IsKindOf ( const FCameraObjectTypeID& InTypeID
) const

   Core/CameraDirectorEvaluator.h  

bool IsKindOf ()

   Core/CameraDirectorEvaluator.h  

void OnEndCameraSystemUpdate()

   Core/CameraDirectorEvaluator.h  

void OverrideNextActivationTransition ( const UCameraRigTransition* TransitionOverride
)

 Request that the next camera rig activation use the provided transition. Core/CameraDirectorEvaluator.h  

bool RemoveChildEvaluationContext ( TSharedRef< FCameraEvaluationContext > InContext
)

 Remove the given child context from this camera director. Core/CameraDirectorEvaluator.h  

void Run ( const FCameraDirectorEvaluationParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Runs the camera director to determine what camera rig(s) should be active this frame. Core/CameraDirectorEvaluator.h  

void SetPrivateCameraDirector ( const UCameraDirector* InCameraDirector
)

   Core/CameraDirectorEvaluator.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnActivate ( const FCameraDirectorActivateParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Activates the camera director evaluator. May be called multiple times, in pair with OnDeactivate. Core/CameraDirectorEvaluator.h  

virtual void OnAddChildEvaluationContext ( const FChildContextManulationParams& Params,
FChildContextManulationResult& Result
)

 Add a child context to this camera director. Core/CameraDirectorEvaluator.h  

virtual void OnAddReferencedObjects ( FReferenceCollector& Collector
)

 Garbage collection pass. Core/CameraDirectorEvaluator.h  

virtual void OnDeactivate ( const FCameraDirectorDeactivateParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Deactivates the camera director evaluator. May be called multiple times, in pair with OnActivate. Core/CameraDirectorEvaluator.h  

virtual void OnInitialize ( const FCameraDirectorInitializeParams& Params
)

 Initializes a camera director evalutor. Only called once after construction. Core/CameraDirectorEvaluator.h  

virtual void OnRemoveChildEvaluationContext ( const FChildContextManulationParams& Params,
FChildContextManulationResult& Result
)

 Remove the given child context from this camera director. Core/CameraDirectorEvaluator.h  

virtual void OnRun ( const FCameraDirectorEvaluationParams& Params,
FCameraDirectorEvaluationResult& OutResult
)

 Runs the camera director to determine what camera rig(s) should be active this frame. Core/CameraDirectorEvaluator.h  

Static

Name Remarks Include Path Unreal Specifiers
  Core/CameraDirectorEvaluator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page