1. Epic GamesDeveloper
  3. FRootCameraNodeEvaluator

FRootCameraNodeEvaluator

Base class for the evaluator of a root camera node.

API > API/Plugins > API/Plugins/GameplayCameras

Base class for the evaluator of a root camera node.

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

Syntax

class FRootCameraNodeEvaluator : public UE::Cameras::FCameraNodeEvaluator

Inheritance Hierarchy

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OnCameraRigEventDelegate FOnRootCameraNodeCameraRigEvent The delegate to notify when an event happens. Core/RootCameraNode.h  
OwningEvaluator FCameraSystemEvaluator * The camera system that owns this root node. Core/RootCameraNode.h  
PreVisualResult FCameraNodeEvaluationResult Evaluation result before the contribution of the visual layer. Core/RootCameraNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Activates a camera rig. Core/RootCameraNode.h  
Builds the hierarchy of the system for a given single camera rig. Core/RootCameraNode.h  

void DeactivateAllCameraRigs ( TSharedPtr< const FCameraEvaluationContext > InContext,
bool bImmediately
)

 Deactivates all camera rigs with the given evaluation context. Core/RootCameraNode.h  
Deactivates a camera rig. Core/RootCameraNode.h  

void ExecuteCameraDirectorRequest ( const FCameraRigActivationDeactivationRequest& Request
)

 Execute a request to activate or deactivate a camera rig. Core/RootCameraNode.h  

void GetActiveCameraRigInfo ( FCameraRigEvaluationInfo& OutCameraRigInfo
) const

 Gets information about the active camera rig in the main layer. Core/RootCameraNode.h  

const FCameraVariableTable * GetBlendedParameters()

 Gets the variable table containing the blended camera object interfaces parameters. Core/RootCameraNode.h  

void GetCameraRigInfo ( const FCameraRigInstanceID InstanceID,
FCameraRigEvaluationInfo& OutCameraRigInfo
) const

 Gets information about a specified camera rig. Core/RootCameraNode.h  

const FCameraNodeEvaluationResult & GetPreVisualLayerResult()

 Returns the evaluation result without the contribution of the visual layer. Core/RootCameraNode.h  

bool HasAnyActiveCameraRig()

 Gets whether any camera rig is running in the main layer. Core/RootCameraNode.h  

bool HasAnyRunningCameraRig ( TSharedPtr< const FCameraEvaluationContext > InContext
) const

 Gets whether any camera rig is running with the given context in the main layer. Core/RootCameraNode.h  

FOnRootCameraNodeCameraRigEvent & OnCameraRigEvent()

 Gets the delegate for camera rig events. Core/RootCameraNode.h  
Evaluates a single camera rig. Core/RootCameraNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastCameraRigEvent ( const FRootCameraNodeCameraRigEvent& InEvent
) const

   Core/RootCameraNode.h  

virtual FCameraRigInstanceID OnActivateCameraRig ( const FActivateCameraRigParams& Params
)

 Activates a camera rig. Core/RootCameraNode.h  

virtual void OnBuildSingleCameraRigHierarchy ( const FSingleCameraRigHierarchyBuildParams& Params,
FCameraNodeEvaluatorHierarchy& OutHierarchy
)

 Builds the hierarchy of the system for a given single camera rig. Core/RootCameraNode.h  

virtual void OnDeactivateAllCameraRigs ( TSharedPtr< const FCameraEvaluationContext > InContext,
bool bImmediately
)

 Deactivates all camera rigs with the given evaluation context. Core/RootCameraNode.h  

virtual void OnDeactivateCameraRig ( const FDeactivateCameraRigParams& Params
)

 Deactivates a camera rig. Core/RootCameraNode.h  

virtual void OnGetActiveCameraRigInfo ( FCameraRigEvaluationInfo& OutCameraRigInfo
) const

 Gets information about the active camera rig in the main layer. Core/RootCameraNode.h  

virtual const FCameraVariableTable * OnGetBlendedParameters()

 Gets the variable table containing the blended camera object interfaces parameters. Core/RootCameraNode.h  

virtual void OnGetCameraRigInfo ( const FCameraRigInstanceID InstanceID,
FCameraRigEvaluationInfo& OutCameraRigInfo
) const

 Gets information about a specified camera rig. Core/RootCameraNode.h  

virtual bool OnHasAnyRunningCameraRig ( TSharedPtr< const FCameraEvaluationContext > InContext
) const

 Gets whether any camera rig is running with the given context in the main layer. Core/RootCameraNode.h  

virtual void OnRunSingleCameraRig ( const FSingleCameraRigEvaluationParams& Params,
FCameraNodeEvaluationResult& OutResult
)

 Evaluates a single camera rig. See comments on RunSingleCameraRig. Core/RootCameraNode.h  

void SetPreVisualLayerResult ( const FCameraNodeEvaluationResult& InResult
)

   Core/RootCameraNode.h  

Overridden from FCameraNodeEvaluator

Name Remarks Include Path Unreal Specifiers

virtual void OnInitialize ( const FCameraNodeEvaluatorInitializeParams& Params,
FCameraNodeEvaluationResult& OutResult
)

 Initialize this evaluator. Children and descendants will be automatically initialized too. Core/RootCameraNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page