Navigation
API > API/Plugins > API/Plugins/GameplayCameras
A camera action scope, which is a logical container for zero or more camera actions to be run for a given camera rig instance.
| Name | FCameraActionScope |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Services/CameraActionScope.h |
| Include Path | #include "Services/CameraActionScope.h" |
Syntax
class FCameraActionScope : public TSharedFromThis< FCameraActionScope >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FCameraActionScope
Structs
| Name | Remarks |
|---|---|
| FActionInfo |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Actions | TArray< FActionInfo > | Services/CameraActionScope.h | ||
| CameraRig | TObjectPtr< const UCameraRigAsset > | Services/CameraActionScope.h | ||
| CameraRigInstanceID | FCameraRigInstanceID | Services/CameraActionScope.h | ||
| ChildEvaluator | FCameraNodeEvaluator * | Services/CameraActionScope.h | ||
| ChildResult | const FCameraNodeEvaluationResult * | Services/CameraActionScope.h | ||
| EvaluationContext | TWeakPtr< const FCameraEvaluationContext > | Services/CameraActionScope.h | ||
| NextActionID | uint32 | Services/CameraActionScope.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddReferencedObjects
(
FReferenceCollector& Collector |
Collect referenced UObjects for all actions in the scope. | Services/CameraActionScope.h | |
void BuildDebugBlocks
(
const FCameraDebugBlockBuildParams& Params, |
Called to create debug blocks for this action scope. | Services/CameraActionScope.h | |
FCameraActionEvaluator * GetAction
(
const FCameraActionInstanceID InInstanceID |
Gets a running action. | Services/CameraActionScope.h | |
const UCameraRigAsset * GetCameraRig() |
Gets the camera rig associated with this action scope. | Services/CameraActionScope.h | |
FCameraRigEvaluationInfo GetCameraRigEvaluationInfo() |
Gets the evaluation info of the camera rig instance that this action acts upon. | Services/CameraActionScope.h | |
FCameraNodeEvaluator * GetChildEvaluator() |
Gets the root evaluator for the camera rig instance that this action acts upon. | Services/CameraActionScope.h | |
TSharedPtr< const FCameraEvaluationContext > GetEvaluationContext() |
Gets the evaluation context that the camera rig instance runs inside of. | Services/CameraActionScope.h | |
void Initialize
(
const FCameraRigEvaluationInfo& CameraRigInfo |
Initialize this scope and associate it with the given camera rig. | Services/CameraActionScope.h | |
bool IsActionRunning
(
const FCameraActionInstanceID InInstanceID |
Returns whether the given action instance is running. | Services/CameraActionScope.h | |
void PostScopeRun
(
const FCameraNodeEvaluationParams& Params, |
Runs the post-scope evaluation for all actions in the scope. | Services/CameraActionScope.h | |
void PreScopeRun
(
const FCameraNodeEvaluationParams& Params, |
Runs the pre-scope evaluation for all actions in the scope. | Services/CameraActionScope.h | |
void Serialize
(
const FCameraActionEvaluatorSerializeParams& Params, |
Serializes the state of all actions in the scope. | Services/CameraActionScope.h | |
FCameraActionInstanceID StartAction
(
const UCameraAction* InCameraAction |
Adds a new camera action. | Services/CameraActionScope.h | |
bool StopAction
(
const FCameraActionInstanceID InInstanceID |
Stops a running camera action. | Services/CameraActionScope.h |