Navigation
API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Core
Inheritance Hierarchy
- TSharedFromThis< FCameraEvaluationContext >
- FCameraEvaluationContext
- FGameplayCameraComponentEvaluationContext
References
| Module | GameplayCameras |
| Header | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraEvaluationContext.h |
| Include | #include "Core/CameraEvaluationContext.h" |
Syntax
class FCameraEvaluationContext : public TSharedFromThis< FCameraEvaluationContext >
Remarks
Base class for providing a context to running camera rigs.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< const UCameraAsset > | CameraAsset | The camera asset hosted in this context. | |
| FCameraNodeEvaluationResult | InitialResult | The initial result for all camera rigs in this context. | |
| TWeakObjectPtr | WeakOwner | The owner of this context, if any. | |
| TWeakObjectPtr< APlayerController > | WeakPlayerController | The player controller (if any) in control of the cameras running inside of this evaluation context. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Constructs an evaluation context. | |||
FCameraEvaluationContext
(
const FCameraEvaluationContextInitializeParams& Params |
Constructs an evaluation context. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Destroys this evaluation context. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Activate
(
const FCameraEvaluationContextActivateParams& Params |
Activates this evaluation context. This will create the camera director evaluator if necessary. | |
| void | AddReferencedObjects
(
FReferenceCollector& Collector |
Internal API. | |
| void | |||
| Type * | CastThis () |
||
| const Type * | CastThis () |
||
| const Type * | |||
| Type * | |||
| void | Deactivate
(
const FCameraEvaluationContextDeactivateParams& Params |
Deactivates this evaluation context. | |
| const UCameraAsset * | Gets the camera asset that is hosted in this context. | ||
| FCameraSystemEvaluator * | Gets the camera system evaluator. Only valid if this evaluation context is active. | ||
| TArrayView< const TSharedPtr< FCameraEvaluationContext > > | Gets the children evaluation contexts running inside this context. | ||
| FCameraDirectorEvaluator * | Gets the camera director evaluator that runs the camera rigs of this context. | ||
| FCameraNodeEvaluationResult & | Gets the initial evaluation result for all camera rigs in this context. | ||
| const FCameraNodeEvaluationResult & | Gets the initial evaluation result for all camera rigs in this context. | ||
| UObject * | GetOwner () |
Gets the owner of this evaluation context, if any, and if still valid. | |
| APlayerController * | Gets the player controller (if any) in control of the cameras running inside of this evaluation context. | ||
| const FCameraObjectTypeID & | GetTypeID () |
||
| UWorld * | GetWorld () |
Gets the world in which this evaluation context runs. This is the owner's world. | |
| void | Initialize
(
const FCameraEvaluationContextInitializeParams& Params |
Initializes the evaluation context, if it was created with the default constructor. | |
| bool | IsKindOf
(
const FCameraObjectTypeID& InTypeID |
||
| bool | IsKindOf () |
||
| void | OnActivate
(
const FCameraEvaluationContextActivateParams& Params |
||
| void | OnDeactivate
(
const FCameraEvaluationContextDeactivateParams& Params |
||
| bool | RegisterChildContext
(
TSharedRef< FCameraEvaluationContext > ChildContext |
||
| const ::UE::Cameras::TCameraObjectTypeID< FCameraEvaluationContext > & | StaticTypeID () |
||
| bool | UnregisterChildContext
(
TSharedRef< FCameraEvaluationContext > ChildContext |
Typedefs
| Name | Description |
|---|---|
| FCameraObjectTypeID | |
| FChildrenContexts |
Constants
| Name | Description |
|---|---|
| PrivateTypeID |