Navigation
API > API/Plugins > API/Plugins/GameplayCameras
The base class for a standard scren-space framing camera node.
| Name | UBaseFramingCameraNode |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Nodes/Framing/BaseFramingCameraNode.h |
| Include Path | #include "Nodes/Framing/BaseFramingCameraNode.h" |
Syntax
UCLASS (MinimalAPI, Abstract, Meta=(CameraNodeCategories="Framing"))
class UBaseFramingCameraNode :
public UCameraNode ,
public ICustomCameraNodeParameterProvider
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraNode → UBaseFramingCameraNode
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UBaseFramingCameraNode
(
const FObjectInitializer& ObjectInit |
Nodes/Framing/BaseFramingCameraNode.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DeadZone | FCameraFramingZoneParameter | The size of the dead zone, i.e. the zone inside which the target can freely move. | Nodes/Framing/BaseFramingCameraNode.h |
|
| DisengageTime | FFloatCameraParameter | The time spent ramping down the reframing after entering the dead zone. | Nodes/Framing/BaseFramingCameraNode.h |
|
| IdealFramingLocation | FVector2dCameraParameter | The ideal horizontal and vertical screen-space position of the target. | Nodes/Framing/BaseFramingCameraNode.h |
|
| InitializeWithIdealFraming | FBooleanCameraParameter | Whether to frame the target with the ideal framing immediately on the first frame. | Nodes/Framing/BaseFramingCameraNode.h |
|
| LowReframeDampingFactor | FFloatCameraParameter | If valid, the recentering damping factor will interpolate between LowReframeDampingFactor and ReframeDampingFactor as the target moves between the ideal target position and the boundaries of the hard-zone. | Nodes/Framing/BaseFramingCameraNode.h |
|
| ReengageTime | FFloatCameraParameter | The time spent ramping up the reframing after exiting the dead zone. | Nodes/Framing/BaseFramingCameraNode.h |
|
| ReframeDampingFactor | FFloatCameraParameter | The damping factor for how fast the framing recenters on the target. | Nodes/Framing/BaseFramingCameraNode.h |
|
| SetTargetDistance | FBooleanCameraParameter | Whether the camera pose's target distance should be set to the distance between its location and the effective target's location. | Nodes/Framing/BaseFramingCameraNode.h |
|
| SoftZone | FCameraFramingZoneParameter | The margins of the soft zone, i.e. the zone inside which the reframing will engage, in order to bring the target back towards the ideal framing position. | Nodes/Framing/BaseFramingCameraNode.h |
|
| TargetInfos | TArray< FCameraActorTargetInfo > | Specifies one or more target actors to frame. | Nodes/Framing/BaseFramingCameraNode.h |
|
| TargetInfosDataID | FCameraContextDataID | Nodes/Framing/BaseFramingCameraNode.h | ||
| TargetLocation | FVector3dCameraVariableReference | A variable whose value is the desired target's location in world space. | Nodes/Framing/BaseFramingCameraNode.h |
|
| TargetMovementAnticipationTime | FFloatCameraParameter | Nodes/Framing/BaseFramingCameraNode.h |
|
Functions
Public
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Nodes/Framing/BaseFramingCameraNode.h |
Overridden from ICustomCameraNodeParameterProvider
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetCustomCameraNodeParameters
(
FCustomCameraNodeParameterInfos& OutParameterInfos |
Gathers the custom parameters on this node. | Nodes/Framing/BaseFramingCameraNode.h |