1. Epic GamesDeveloper
  3. FCameraEvaluationContext

FCameraEvaluationContext

Base class for providing a context to running camera rigs.

API > API/Plugins > API/Plugins/GameplayCameras

Base class for providing a context to running camera rigs.

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

Syntax

class FCameraEvaluationContext : public TSharedFromThis< FCameraEvaluationContext >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Constructs an evaluation context. Core/CameraEvaluationContext.h  
Constructs an evaluation context. Core/CameraEvaluationContext.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCameraEvaluationContext()

 Destroys this evaluation context. Core/CameraEvaluationContext.h  

Typedefs

Name Type Remarks Include Path
FCameraObjectTypeID ::UE::Cameras::FCameraObjectTypeID   Core/CameraEvaluationContext.h
FChildrenContexts TArray< TSharedPtr< FCameraEvaluationContext > > The children contexts, if any. Core/CameraEvaluationContext.h
FConditionalResults TMap< ECameraEvaluationDataCondition, FCameraNodeEvaluationResult > Conditional camera data for camera rigs running inside this context. Core/CameraEvaluationContext.h

Constants

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

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bActivated bool   Core/CameraEvaluationContext.h  
bInitialized bool   Core/CameraEvaluationContext.h  
CameraSystemEvaluator FCameraSystemEvaluator * The camera system that this context has been activated for, or null if the context isn't currently active. Core/CameraEvaluationContext.h  
ChildrenContexts FChildrenContexts   Core/CameraEvaluationContext.h  
ConditionalResults FConditionalResults   Core/CameraEvaluationContext.h  
DirectorEvaluator FCameraDirectorEvaluator *   Core/CameraEvaluationContext.h  
DirectorEvaluatorStorage FCameraDirectorEvaluatorStorage The camera director evaluator, usually only valid if this context has been activated. Core/CameraEvaluationContext.h  
WeakParent TWeakPtr< FCameraEvaluationContext > The parent context, if any. Core/CameraEvaluationContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Activate ( const FCameraEvaluationContextActivateParams& Params
)

 Activates this evaluation context. This will create the camera director evaluator if necessary. Core/CameraEvaluationContext.h  

bool AddChildContext ( TSharedRef< FCameraEvaluationContext > ChildContext
)

 Adds a child context. Core/CameraEvaluationContext.h  

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Internal API. Core/CameraEvaluationContext.h  

const Type * CastThis ()

   Core/CameraEvaluationContext.h  

Type * CastThis ()

   Core/CameraEvaluationContext.h  

Type * CastThisChecked ()

   Core/CameraEvaluationContext.h  

const Type * CastThisChecked ()

   Core/CameraEvaluationContext.h  

void Deactivate ( const FCameraEvaluationContextDeactivateParams& Params
)

 Deactivates this evaluation context. Core/CameraEvaluationContext.h  

const UCameraAsset * GetCameraAsset()

 Gets the camera asset that is hosted in this context. Core/CameraEvaluationContext.h  

TArrayView< const TSharedPtr< FCameraEvaluationContext > > GetChildrenContexts()

 Gets the children evaluation contexts running inside this context. Core/CameraEvaluationContext.h  
Gets an evaluation result that will be conditionally overlaid on some camera rigs in this context. Core/CameraEvaluationContext.h  
Gets an evaluation result that will be conditionally overlaid on some camera rigs in this context. Core/CameraEvaluationContext.h  

FCameraDirectorEvaluator * GetDirectorEvaluator()

 Gets the camera director evaluator that runs the camera rigs of this context. Core/CameraEvaluationContext.h  
Gets the initial evaluation result for all camera rigs in this context. Core/CameraEvaluationContext.h  
Gets the initial evaluation result for all camera rigs in this context. Core/CameraEvaluationContext.h  

FCameraNodeEvaluationResult & GetOrAddConditionalResult ( ECameraEvaluationDataCondition Condition
)

 Gets or adds an evaluation result that will be conditionally overlaid on some camera rigs in this context. Core/CameraEvaluationContext.h  

UObject * GetOwner()

 Gets the owner of this evaluation context, if any, and if still valid. Core/CameraEvaluationContext.h  
Gets the parent evaluation context, if any. Core/CameraEvaluationContext.h  
Gets the parent evaluation context, if any. Core/CameraEvaluationContext.h  

APlayerController * GetPlayerController()

 Gets the player controller (if any) in control of the cameras running inside of this evaluation context. Core/CameraEvaluationContext.h  

virtual const FCameraObjectTypeID & GetTypeID()

   Core/CameraEvaluationContext.h  

FIntPoint GetViewportSize()

 Gets the size of the viewport that cameras inside the context are being viewed through. Core/CameraEvaluationContext.h  

UWorld * GetWorld()

 Gets the world in which this evaluation context runs. This is the owner's world. Core/CameraEvaluationContext.h  

void Initialize ( const FCameraEvaluationContextInitializeParams& Params
)

 Initializes the evaluation context, if it was created with the default constructor. Core/CameraEvaluationContext.h  

bool IsActive()

 Whether this context is active. Core/CameraEvaluationContext.h  

virtual bool IsKindOf ( const FCameraObjectTypeID& InTypeID
) const

   Core/CameraEvaluationContext.h  

bool IsKindOf ()

   Core/CameraEvaluationContext.h  

void OnEndCameraSystemUpdate()

   Core/CameraEvaluationContext.h  

bool RegisterChildContext ( TSharedRef< FCameraEvaluationContext > ChildContext
)

   Core/CameraEvaluationContext.h  

bool RemoveChildContext ( TSharedRef< FCameraEvaluationContext > ChildContext
)

 Removes a child context. Core/CameraEvaluationContext.h  

void SetEditorPreviewCameraRigIndex ( int32 Index
)

   Core/CameraEvaluationContext.h  

bool UnregisterChildContext ( TSharedRef< FCameraEvaluationContext > ChildContext
)

   Core/CameraEvaluationContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AutoCreateDirectorEvaluator()

   Core/CameraEvaluationContext.h  

void AutoCreateEditorPreviewDirectorEvaluator ( const FCameraEvaluationContextActivateParams& Params
)

   Core/CameraEvaluationContext.h  

FCameraSystemEvaluator * GetCameraSystemEvaluator()

   Core/CameraEvaluationContext.h  

virtual void OnActivate ( const FCameraEvaluationContextActivateParams& Params
)

   Core/CameraEvaluationContext.h  

virtual void OnDeactivate ( const FCameraEvaluationContextDeactivateParams& Params
)

   Core/CameraEvaluationContext.h  

Static

Name Remarks Include Path Unreal Specifiers
  Core/CameraEvaluationContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page