UCameraRigAsset | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Core

Inheritance Hierarchy

References


Module	GameplayCameras
Header	/Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraRigAsset.h
Include	#include "Core/CameraRigAsset.h"

Syntax

UCLASS (MinimalAPI)  
class UCameraRigAsset :  
    public UObject,  
    public IGameplayTagAssetInterface ,  
    public IHasCameraBuildStatus ,  
    public IObjectTreeGraphObject ,  
    public IObjectTreeGraphRootObject

Remarks

A camera rig asset, which runs a hierarchy of camera nodes to drive the behavior of a camera.

Variables

Type	Name	Description
FCameraRigAllocationInfo	AllocationInfo	Allocation information for all the nodes and variables in this camera rig.
ECameraBuildStatus	BuildStatus	The current build state of this camera rig.
TArray< TObjectPtr< UCameraRigTransition > >	EnterTransitions	List of enter transitions for this camera rig.
UE::Cameras::TCameraEventHandlerContainer< UE::Cameras::ICameraRigAssetEventHandler >	EventHandlers	Event handlers to be notified of data changes.
TArray< TObjectPtr< UCameraRigTransition > >	ExitTransitions	List of exist transitions for this camera rig.
FGameplayTagContainer	GameplayTags	The gameplay tags on this camera rig.
ECameraRigInitialOrientation	InitialOrientation	Default orientation initialization when this camera rig is activated.
FCameraRigInterface	Interface	The public data interface of this camera rig.
TObjectPtr< UCameraNode >	RootNode	Root camera node.

Functions

Type	Name	Description
void	BuildCameraRig ()	Builds this camera rig.
void	BuildCameraRig ( UE::Cameras::FCameraBuildLog& InBuildLog )	Builds this camera rig, similar to BuildCameraRig() but using a given build log.
void	GatherPackages ( FCameraRigPackages& OutPackages )
FString	GetDisplayName ()	Gets the display name of this camera rig.
const FGuid &	GetGuid ()	Gets the camera rig's unique ID.
void	GetOwnedGameplayTags ( FGameplayTagContainer& TagContainer )
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostInitProperties ()
void	PostLoad ()
void	PreSave ( FObjectPreSaveContext ObjectSaveContext )

Overridden from IHasCameraBuildStatus

	Type	Name	Description
	void	DirtyBuildStatus ()	Dirties the build status of the object.
	ECameraBuildStatus	GetBuildStatus ()	Gets the build status of the object.

Overridden from IObjectTreeGraphObject

Type	Name	Description
const FString &	GetGraphNodeCommentText ( FName InGraphName )	Gets the graph node's comment text.
void	GetGraphNodeName ( FName InGraphName, FText& OutName )	Gets the custom name for the graph node.
void	GetGraphNodePosition ( FName InGraphName, int32& NodePosX, int32& NodePosY )	Gets the canvas position for the graph node representing this object.
EObjectTreeGraphObjectSupportFlags	GetSupportFlags ( FName InGraphName )	Gets optional APIs support flags.
void	OnGraphNodeMoved ( FName InGraphName, int32 NodePosX, int32 NodePosY, bool bMarkDirty )	Called to save the canvas position of the graph node representing this object.
void	OnRenameGraphNode ( FName InGraphName, const FString& NewName )	Called to save a new custom name.
void	OnUpdateGraphNodeCommentText ( FName InGraphName, const FString& NewComment )	Called to save a new comment text.

Overridden from IObjectTreeGraphRootObject

	Type	Name	Description
	void	AddConnectableObject ( FName InGraphName, UObject* InObject )
	void	GetConnectableObjects ( FName InGraphName, TSet< UObject* >& OutObjects )
	void	RemoveConnectableObject ( FName InGraphName, UObject* InObject )