Navigation
API > API/Plugins > API/Plugins/GameplayCameras
A complete camera asset.
| Name | UCameraAsset |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraAsset.h |
| Include Path | #include "Core/CameraAsset.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UCameraAsset :
public UObject ,
public IHasCameraBuildStatus ,
public IObjectTreeGraphObject ,
public IObjectTreeGraphRootObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCameraAsset
Implements Interfaces
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| SharedTransitionsGraphName | const FName | Graph names for ObjectTreeGraph API. | Core/CameraAsset.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EventHandlers | UE::Cameras::TCameraEventHandlerContainer< UE::Cameras::ICameraAssetEventHandler > | Event handlers to be notified of data changes. | Core/CameraAsset.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllocationInfo | FCameraAssetAllocationInfo | Allocation info for the camera asset. | Core/CameraAsset.h | |
| AllSharedTransitionsObjects | TArray< TObjectPtr< UObject > > | All nodes used in the shared transitions graph editor. | Core/CameraAsset.h |
|
| BuildStatus | ECameraBuildStatus | The current build state of this camera asset. | Core/CameraAsset.h |
|
| CameraDirector | TObjectPtr< UCameraDirector > | The camera director to use in this camera. | Core/CameraAsset.h |
|
| DefaultParameters | FInstancedPropertyBag | Generated values for all camera rig parameters. | Core/CameraAsset.h | |
| EnterTransitions | TArray< TObjectPtr< UCameraRigTransition > > | A list of default enter transitions for all the camera rigs in this asset. | Core/CameraAsset.h |
|
| ExitTransitions | TArray< TObjectPtr< UCameraRigTransition > > | A list of default exit transitions for all the camera rigs in this asset. | Core/CameraAsset.h |
|
| ParameterDefinitions | TArray< FCameraObjectInterfaceParameterDefinition > | Generated list of all the camera rigs' parameters. | Core/CameraAsset.h | |
| TransitionGraphNodeComment | FString | User-written comment in the transition graph editor. | Core/CameraAsset.h | |
| TransitionGraphNodePos | FIntVector2 | Position of the camera node in the shared transitions graph editor. | Core/CameraAsset.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEnterTransition
(
UCameraRigTransition* InTransition |
Adds an enter transition. | Core/CameraAsset.h | |
void AddExitTransition
(
UCameraRigTransition* InTransition |
Adds an exit transition. | Core/CameraAsset.h | |
void BuildCamera
(
UE::Cameras::FCameraBuildLog& InBuildLog |
Builds and validates this camera, including all its camera rigs. | Core/CameraAsset.h | |
void BuildCamera () |
Builds and validates this camera, including all its camera rigs. | Core/CameraAsset.h | |
const FCameraAssetAllocationInfo & GetAllocationInfo() |
Gets the allocation info for this camera asset. | Core/CameraAsset.h | |
UCameraDirector * GetCameraDirector() |
Gets the camera director. | Core/CameraAsset.h | |
const FInstancedPropertyBag & GetDefaultParameters () |
Gets the default parameter values for all camera rigs. | Core/CameraAsset.h | |
| Gets the default parameter values for all camera rigs. | Core/CameraAsset.h | ||
TArrayView< const TObjectPtr< UCameraRigTransition > > GetEnterTransitions() |
Gets the enter transitions. | Core/CameraAsset.h | |
TArrayView< const TObjectPtr< UCameraRigTransition > > GetExitTransitions() |
Gets the exit transitions. | Core/CameraAsset.h | |
TConstArrayView< FCameraObjectInterfaceParameterDefinition > GetParameterDefinitions() |
Gets the definitions of parameters exposed on this camera asset. | Core/CameraAsset.h | |
int32 RemoveEnterTransition
(
UCameraRigTransition* InTransition |
Removes an enter transition. | Core/CameraAsset.h | |
int32 RemoveExitTransition
(
UCameraRigTransition* InTransition |
Removes an exit transition. | Core/CameraAsset.h | |
void SetBuildStatus
(
ECameraBuildStatus InBuildStatus |
Sets the build status. | Core/CameraAsset.h | |
void SetCameraDirector
(
UCameraDirector* InCameraDirector |
Sets the camera director. | Core/CameraAsset.h |
Overridden from IHasCameraBuildStatus
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DirtyBuildStatus() |
Dirties the build status of the object. | Core/CameraAsset.h | |
virtual ECameraBuildStatus GetBuildStatus() |
Gets the build status of the object. | Core/CameraAsset.h |
Protected
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
Core/CameraAsset.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Core/CameraAsset.h | ||
virtual void PostLoad() |
Core/CameraAsset.h | ||
virtual void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
Core/CameraAsset.h |
Overridden from IObjectTreeGraphObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Gets the graph node's comment text. | Core/CameraAsset.h | ||
virtual void GetGraphNodePosition
(
FName InGraphName, |
Gets the canvas position for the graph node representing this object. | Core/CameraAsset.h | |
virtual EObjectTreeGraphObjectSupportFlags GetSupportFlags
(
FName InGraphName |
Gets optional APIs support flags. | Core/CameraAsset.h | |
virtual void OnGraphNodeMoved
(
FName InGraphName, |
Called to save the canvas position of the graph node representing this object. | Core/CameraAsset.h | |
| Called to save a new comment text. | Core/CameraAsset.h |
Overridden from IObjectTreeGraphRootObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Core/CameraAsset.h | |||
| Core/CameraAsset.h | |||
| Core/CameraAsset.h |