1. Epic GamesDeveloper
  3. UCameraRigAsset

UCameraRigAsset

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

Unreal Engine C++ API Reference > 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
Public variable UProperty FCameraRigAllocationInfo AllocationInfo Allocation information for all the nodes and variables in this camera rig.
Public variable UProperty Transient ECameraBuildStatus BuildStatus The current build state of this camera rig.
Public variable UProperty Meta instanced TArray< TObjectPtr< UCameraRigTransition > > EnterTransitions List of enter transitions for this camera rig.
Public variable UE::Cameras::TCameraEventHandlerContainer< UE::Cameras::ICameraRigAssetEventHandler > EventHandlers Event handlers to be notified of data changes.
Public variable UProperty Meta instanced TArray< TObjectPtr< UCameraRigTransition > > ExitTransitions List of exist transitions for this camera rig.
Public variable UProperty Category, EditAnywhere FGameplayTagContainer GameplayTags The gameplay tags on this camera rig.
Public variable UProperty Category, EditAnywhere ECameraRigInitialOrientation InitialOrientation Default orientation initialization when this camera rig is activated.
Public variable UProperty FCameraRigInterface Interface The public data interface of this camera rig.
Public variable UProperty instanced TObjectPtr< UCameraNode > RootNode Root camera node.

Functions

  Type Name Description
Public function void Builds this camera rig.
Public function void Builds this camera rig, similar to BuildCameraRig() but using a given build log.
Public function Const void  
Public function Const FString Gets the display name of this camera rig.
Public function Const const FGuid &

GetGuid ()

 Gets the camera rig's unique ID.
Public function Virtual Const void  
Protected function Virtual void

PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  

Overridden from IHasCameraBuildStatus

  Type Name Description
Public function Virtual void Dirties the build status of the object.
Public function Virtual Const ECameraBuildStatus Gets the build status of the object.

Overridden from IObjectTreeGraphObject

  Type Name Description
Protected function Virtual Const const FString &

GetGraphNodeCommentText ( FName InGraphName
)

 Gets the graph node's comment text.
Protected function Virtual Const void

GetGraphNodeName ( FName InGraphName,
FText& OutName
)

 Gets the custom name for the graph node.
Protected function Virtual Const void

GetGraphNodePosition ( FName InGraphName,
int32& NodePosX,
int32& NodePosY
)

 Gets the canvas position for the graph node representing this object.
Protected function Virtual Const EObjectTreeGraphObjectSupportFlags

GetSupportFlags ( FName InGraphName
)

 Gets optional APIs support flags.
Protected function Virtual void

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

 Called to save the canvas position of the graph node representing this object.
Protected function Virtual void

OnRenameGraphNode ( FName InGraphName,
const FString& NewName
)

 Called to save a new custom name.
Protected function Virtual void

OnUpdateGraphNodeCommentText ( FName InGraphName,
const FString& NewComment
)

 Called to save a new comment text.

Overridden from IObjectTreeGraphRootObject

  Type Name Description
Protected function Virtual void

AddConnectableObject ( FName InGraphName,
UObject* InObject
)

  
Protected function Virtual Const void

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

  
Protected function Virtual void

RemoveConnectableObject ( FName InGraphName,
UObject* InObject
)

  

Constants

Name Description
NodeTreeGraphName Graph names for ObjectTreeGraph API.
TransitionsGraphName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page