1. Epic GamesDeveloper
  3. UCameraRigAsset

UCameraRigAsset

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

API > API/Plugins > API/Plugins/GameplayCameras

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

   
Name UCameraRigAsset
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraRigAsset.h
Include Path #include "Core/CameraRigAsset.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constants

Name Type Remarks Include Path
NodeTreeGraphName const FName Graph names for ObjectTreeGraph API. Core/CameraRigAsset.h
TransitionsGraphName const FName   Core/CameraRigAsset.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BuildStatus ECameraBuildStatus The current build state of this camera rig. Core/CameraRigAsset.h
  • Transient
EnterTransitions TArray< TObjectPtr< UCameraRigTransition > > List of enter transitions for this camera rig. Core/CameraRigAsset.h
  • Instanced
EventHandlers UE::Cameras::TCameraEventHandlerContainer< UE::Cameras::ICameraRigAssetEventHandler > Event handlers to be notified of data changes. Core/CameraRigAsset.h  
ExitTransitions TArray< TObjectPtr< UCameraRigTransition > > List of exist transitions for this camera rig. Core/CameraRigAsset.h
  • Instanced
GameplayTags FGameplayTagContainer The gameplay tags on this camera rig. Core/CameraRigAsset.h
  • EditAnywhere
  • Category=GameplayTags
InitialOrientation ECameraRigInitialOrientation Default orientation initialization when this camera rig is activated. Core/CameraRigAsset.h
  • EditAnywhere
  • Category="Transition"
RootNode TObjectPtr< UCameraNode > Root camera node. Core/CameraRigAsset.h
  • Instanced

Protected

Name Type Remarks Include Path Unreal Specifiers
AllNodeTreeObjects TArray< TObjectPtr< UObject > > A list of all the camera nodes, including the 'loose' ones that aren't connected to the root node, and therefore would be GC'ed if we didn't hold them here. Core/CameraRigAsset.h
  • Instanced
  • Meta=(ObjectTreeGraphHidden=true)
AllTransitionsObjects TArray< TObjectPtr< UObject > > Similar to AllNodeTreeObjects, but for the transitions graph. Core/CameraRigAsset.h
  • Instanced
  • Meta=(ObjectTreeGraphHidden=true)
Guid FGuid The camera rig's unique ID. Core/CameraRigAsset.h  
NodeGraphNodeComment FString User-written comment in the node graph editor. Core/CameraRigAsset.h  
NodeGraphNodePos FIntVector2 Position of the camera rig node in the node graph editor. Core/CameraRigAsset.h  
TransitionGraphNodeComment FString User-written comment in the transition graph editor. Core/CameraRigAsset.h  
TransitionGraphNodePos FIntVector2 Position of the camera rig node in the transition graph editor. Core/CameraRigAsset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildCameraRig ()

 Builds this camera rig. Core/CameraRigAsset.h  
Builds this camera rig, similar to BuildCameraRig() but using a given build log. Core/CameraRigAsset.h  

void GatherPackages ( FCameraRigPackages& OutPackages
) const

   Core/CameraRigAsset.h  

const FGuid & GetGuid()

 Gets the camera rig's unique ID. Core/CameraRigAsset.h  

virtual void GetOwnedGameplayTags ( FGameplayTagContainer& TagContainer
) const

   Core/CameraRigAsset.h  

Overridden from UBaseCameraObject

Name Remarks Include Path Unreal Specifiers

virtual UCameraNode * GetRootNode()

 Get the root node of this camera object. Core/CameraRigAsset.h  

Overridden from IHasCameraBuildStatus

Name Remarks Include Path Unreal Specifiers

virtual void DirtyBuildStatus()

 Dirties the build status of the object. Core/CameraRigAsset.h  

virtual ECameraBuildStatus GetBuildStatus()

 Gets the build status of the object. Core/CameraRigAsset.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

   Core/CameraRigAsset.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Core/CameraRigAsset.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   Core/CameraRigAsset.h  

virtual void PostInitProperties()

   Core/CameraRigAsset.h  

virtual void PostLoad()

   Core/CameraRigAsset.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Core/CameraRigAsset.h  

Overridden from IObjectTreeGraphObject

Name Remarks Include Path Unreal Specifiers

virtual const FString & GetGraphNodeCommentText ( FName InGraphName
) const

 Gets the graph node's comment text. Core/CameraRigAsset.h  

virtual void GetGraphNodeName ( FName InGraphName,
FText& OutName
) const

 Gets the custom name for the graph node. Core/CameraRigAsset.h  

virtual void GetGraphNodePosition ( FName InGraphName,
int32& NodePosX,
int32& NodePosY
) const

 Gets the canvas position for the graph node representing this object. Core/CameraRigAsset.h  

virtual EObjectTreeGraphObjectSupportFlags GetSupportFlags ( FName InGraphName
) const

 Gets optional APIs support flags. Core/CameraRigAsset.h  

virtual void OnGraphNodeMoved ( FName InGraphName,
int32 NodePosX,
int32 NodePosY,
bool bMarkDirty
)

 Called to save the canvas position of the graph node representing this object. Core/CameraRigAsset.h  

virtual void OnUpdateGraphNodeCommentText ( FName InGraphName,
const FString& NewComment
)

 Called to save a new comment text. Core/CameraRigAsset.h  

Overridden from IObjectTreeGraphRootObject

Name Remarks Include Path Unreal Specifiers

virtual void AddConnectableObject ( FName InGraphName,
UObject* InObject
)

   Core/CameraRigAsset.h  

virtual void GetConnectableObjects ( FName InGraphName,
TSet< UObject* >& OutObjects
) const

   Core/CameraRigAsset.h  

virtual void RemoveConnectableObject ( FName InGraphName,
UObject* InObject
)

   Core/CameraRigAsset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page