Navigation
API > API/Plugins > API/Plugins/GameplayCameras
The base class for a framing camera node evaluator.
This evaluator does nothing per se but provides utility functions to be called in a sub-class' OnRun method. Namely:
- AcquireTargetLocation() : a default way to get the world location of the desired target.
- UpdateFramingState() : computes the current state of the framing node. The result can be obtained from the State field. The, compute the desired framing state for the current tick, including the desired framing correction. This can be obtained from the Desired field. It is up to the sub-class to implement the necessary logic to honor this correction. For instance, a dolly shot would translate left/right (and maybe up/down too) to try and reframe things accordingly, whereas a panning shot would rotate the camera left/right/up/down to accomplish the same.
- EndFramingUpdate() : the sub-class should call near the end of its OnRun method. This will for instance optionally set the target distance.
| Name | FBaseFramingCameraNodeEvaluator |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Nodes/Framing/BaseFramingCameraNode.h |
| Include Path | #include "Nodes/Framing/BaseFramingCameraNode.h" |
Syntax
class FBaseFramingCameraNodeEvaluator : public UE::Cameras::FCameraNodeEvaluator
Inheritance Hierarchy
- FCameraNodeEvaluator → FBaseFramingCameraNodeEvaluator
Structs
| Name | Remarks |
|---|---|
| FDesired | Utility struct for the desired reframing to be done in the current tick. |
| FReaders | Utility structure for all the parameter readers we need every frame. |
| FScreenTargetHistory | |
| FState | Utility struct for storing the current known state. |
| FWorldTargetInfos |
Enums
Protected
| Name | Remarks |
|---|---|
| ETargetFramingState | The current location of the target. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FCameraNodeEvaluator | Nodes/Framing/BaseFramingCameraNode.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateTypeID | const ::UE::Cameras::TCameraObjectTypeID< FBaseFramingCameraNodeEvaluator > | Nodes/Framing/BaseFramingCameraNode.h |
Functions
Public
Overridden from FCameraNodeEvaluator
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FCameraObjectTypeID & GetTypeID() |
Nodes/Framing/BaseFramingCameraNode.h | ||
virtual bool IsKindOf
(
const FCameraObjectTypeID& InTypeID |
Nodes/Framing/BaseFramingCameraNode.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EndFramingUpdate
(
const FCameraNodeEvaluationParams& Params, |
Wraps-up the update with optional operations. | Nodes/Framing/BaseFramingCameraNode.h | |
TOptional< FVector3d > GetInitialDesiredWorldTarget
(
const FCameraNodeEvaluationParams& Params, |
The first frame aiming direction we need for proper initialization. | Nodes/Framing/BaseFramingCameraNode.h | |
void UpdateFramingState
(
const FCameraNodeEvaluationParams& Params, |
Updates the framing state for the current tick, see State member field. | Nodes/Framing/BaseFramingCameraNode.h |
Overridden from FCameraNodeEvaluator
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnBuildDebugBlocks
(
const FCameraDebugBlockBuildParams& Params, |
Called to create debug blocks for this node evaluator. | Nodes/Framing/BaseFramingCameraNode.h | |
virtual void OnDrawEditorPreview
(
const FCameraEditorPreviewDrawParams& Params, |
Nodes/Framing/BaseFramingCameraNode.h | ||
virtual void OnInitialize
(
const FCameraNodeEvaluatorInitializeParams& Params, |
Initialize this evaluator. Children and descendants will be automatically initialized too. | Nodes/Framing/BaseFramingCameraNode.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FFramingZone ComputeScreenTargetBounds
(
const FCameraPose& CameraPose, |
Nodes/Framing/BaseFramingCameraNode.h | ||
static void DrawFramingState
(
const FState& State, |
Nodes/Framing/BaseFramingCameraNode.h | ||
static const ::UE::Cameras::TCameraObjectTypeID< FBaseFramingCameraNodeEvaluator > & StaticTypeID() |
Nodes/Framing/BaseFramingCameraNode.h |