1. Epic GamesDeveloper
  3. UBlueprintCameraDirectorEvaluator

UBlueprintCameraDirectorEvaluator

Base class for a Blueprint camera director evaluator.

API > API/Plugins > API/Plugins/GameplayCameras

Base class for a Blueprint camera director evaluator.

   
Name UBlueprintCameraDirectorEvaluator
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Directors/BlueprintCameraDirector.h
Include Path #include "Directors/BlueprintCameraDirector.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, Abstract)  
class UBlueprintCameraDirectorEvaluator : public UObject

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FCameraDirectorEvaluationResult UE::Cameras::FCameraDirectorEvaluationResult   Directors/BlueprintCameraDirector.h
FCameraEvaluationContext UE::Cameras::FCameraEvaluationContext   Directors/BlueprintCameraDirector.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChildrenContextSlotNames TArray< FName > Currently registered children contexts. Directors/BlueprintCameraDirector.h  
EvaluationContext TSharedPtr< FCameraEvaluationContext > The current evaluation context. Directors/BlueprintCameraDirector.h  
EvaluationResult FCameraDirectorEvaluationResult The current evaluation result. Directors/BlueprintCameraDirector.h  
WeakCachedWorld TWeakObjectPtr< UWorld > Cached world. Directors/BlueprintCameraDirector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS void ActivateCameraDirector ( UObject* EvaluationContextOwner,
const FBlueprintCameraDirectorActivateParams& Params
)

 Override this method in Blueprint to execute custom logic when this camera director gets activated. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="Camera Director|Activation"

void ActivateCameraRig ( UCameraRigAsset* CameraRig,
bool bForceNewInstance
)

 Specifies a camera rig to be active this frame. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Evaluation"

void ActivateCameraRigViaProxy ( UCameraRigProxyAsset* CameraRigProxy,
bool bForceNewInstance
)

 Specifies a camera rig to be active this frame, via a proxy which is later resolved via the proxy table of the Blueprint camera director. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Evaluation"

void ActivatePersistentBaseCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Activates the given camera rig prefab in the base layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"

void ActivatePersistentGlobalCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Activates the given camera rig prefab in the global layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"

void ActivatePersistentVisualCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Activates the given camera rig prefab in the visual layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"

FName AddChildEvaluationContext ( UObject* ChildEvaluationContextOwner
)

   Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="Evaluation"

PRAGMA_DISABLE_DEPRECATION_WARNINGS void DeactivateCameraDirector ( UObject* EvaluationContextOwner,
const FBlueprintCameraDirectorDeactivateParams& Params
)

 Override this method in Blueprint to execute custom logic when this camera director gets deactivated. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="Camera Director|Activation"

void DeactivatePersistentBaseCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Deactivates the given camera rig prefab in the base layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"

void DeactivatePersistentGlobalCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Deactivates the given camera rig prefab in the global layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"

void DeactivatePersistentVisualCameraRig ( UCameraRigAsset* CameraRigPrefab
)

 Deactivates the given camera rig prefab in the visual layer. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Camera Director|Activation"
A utility function that tries to find if an actor owns the evaluation context. Directors/BlueprintCameraDirector.h
  • BlueprintPure
  • Category="Camera Director|Evaluation"
  • Meta=(DeterminesOutputType="ActorClass")

FBlueprintCameraEvaluationDataRef GetConditionalContextResult ( ECameraEvaluationDataCondition Condition
) const

 Gets the evaluation context data for a sub-set of camera rigs. Directors/BlueprintCameraDirector.h
  • BlueprintPure
  • Category="Camera Director|Evaluation"
  • Meta=(DisplayName="Get Conditional Camera Data")

const FCameraDirectorEvaluationResult & GetEvaluationResult()

   Directors/BlueprintCameraDirector.h  

FBlueprintCameraEvaluationDataRef GetInitialContextResult()

 Gets the shared evaluation context data. Directors/BlueprintCameraDirector.h
  • BlueprintPure
  • Category="Camera Director|Evaluation"
  • Meta=(DisplayName="Get Shared Camera Data")

virtual UWorld * GetWorld()

   Directors/BlueprintCameraDirector.h  

virtual bool ImplementsGetWorld()

   Directors/BlueprintCameraDirector.h  

void NativeActivateCameraDirector ( const UE::Cameras::FCameraDirectorActivateParams& Params
)

 Native wrapper for ActivateCameraDirector. Directors/BlueprintCameraDirector.h  

bool NativeAddChildEvaluationContext ( UObject* ChildEvaluationContextOwner
)

   Directors/BlueprintCameraDirector.h  

void NativeDeactivateCameraDirector ( const UE::Cameras::FCameraDirectorDeactivateParams& Params
)

 Native wrapper for DeactivateCameraDirector. Directors/BlueprintCameraDirector.h  

void NativeInitializeCameraDirector ( const UE::Cameras::FCameraDirectorInitializeParams& Params
)

   Directors/BlueprintCameraDirector.h  

bool NativeRemoveChildEvaluationContext ( UObject* ChildEvaluationContextOwner
)

   Directors/BlueprintCameraDirector.h  

void NativeRunCameraDirector ( const UE::Cameras::FCameraDirectorEvaluationParams& Params
)

 Native wrapper for RunCameraDirector. Directors/BlueprintCameraDirector.h  

bool RemoveChildEvaluationContext ( UObject* ChildEvaluationContextOwner,
FName ChildSlotName
)

   Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="Evaluation"

PRAGMA_DISABLE_DEPRECATION_WARNINGS void RunCameraDirector ( float DeltaTime,
UObject* EvaluationContextOwner,
const FBlueprintCameraDirectorEvaluationParams& Params
)

 Override this method in Blueprint to execute the custom logic that determines what camera rig(s) should be active every frame. Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="Evaluation"

bool RunChildCameraDirector ( float DeltaTime,
FName ChildSlotName
)

   Directors/BlueprintCameraDirector.h
  • BlueprintCallable
  • Category="Evaluation"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page