Navigation
API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Nodes > API/Plugins/GameplayCameras/Nodes/Framing
Inheritance Hierarchy
- FCameraNodeEvaluator
- FBaseFramingCameraNodeEvaluator
References
| Module | GameplayCameras |
| Header | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Nodes/Framing/BaseFramingCameraNode.h |
| Include | #include "Nodes/Framing/BaseFramingCameraNode.h" |
Syntax
class FBaseFramingCameraNodeEvaluator : public UE::Cameras::FCameraNodeEvaluator
Remarks
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:
- UpdateFramingState() : computes the current state of the framing node. The result can be obtained from the State field.
- ComputeDesiredState() : one the current state has been written, this method computes the desired framing state for the current tick, including the desired framing correction. 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.
- RegisterNewFraming() : once the framing correction has been executed by the sub-class, it's important to register the new camera transform with RegisterNewFraming, otherwise the reframing will always act only on the incoming camera pose! If this incoming camera pose is fixed (e.g. the previous nodes are only fixed offsets) then if RegisterNewFraming isn't called, the reframing will always do the same thing every frame!
Variables
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TOptional< FVector3d > | AcquireTargetLocation
(
const FCameraNodeEvaluationParams& Params, |
Gets the target location. |
 |
void | ComputeDesiredState
(
float DeltaTime |
Computes the desired reframing for the current tick, see Desired member field. |
  |
const ::UE::Cameras::TCameraObjectTypeID< FBaseFramingCameraNodeEvaluator > & | StaticTypeID () |
|
 |
void | UpdateFramingState
(
const FCameraNodeEvaluationParams& Params, |
Updates the framing state for the current tick, see State member field. |
Overridden from FCameraNodeEvaluator
| Type | Name | Description | |
|---|---|---|---|
   |
const FCameraObjectTypeID & | GetTypeID () |
|
   |
bool | IsKindOf
(
const FCameraObjectTypeID& InTypeID |
|
  |
void | OnInitialize
(
const FCameraNodeEvaluatorInitializeParams& Params, |
Initialize this evaluator. Children and descendants will be automatically initialized too. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
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. | |
 |
FState | Utility struct for storing the current known state. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
ETargetFramingState | The current location of the target. |
Typedefs
| Name | Description |
|---|---|
| Super |
Constants
| Name | Description |
|---|---|
| PrivateTypeID |