TCameraRigAssetAssemblerBase

The root assembler class for building a camera rig.

API > API/Plugins > API/Plugins/GameplayCameras

The root assembler class for building a camera rig. Follow the fluent interface to construct the hierarchy of camera nodes, add transitions, etc.

For instance: UCameraRigAsset* CameraRig = FCameraRigAssetAssembler(TEXT("SimpleTest")) .MakeRootNode() .AddChild(&UArrayCameraNode::Children) .SetParameter(&UOffsetCameraNode::TranslationOffset, FVector3d{ 1, 0, 0 }) .Done() .AddChild(&UArrayCameraNode::Children) .SetParameter(&ULensParametersCameraNode::FocalLength, 18.f) .Done() .Done() .AddEnterTransition() .MakeBlend() .Done() .Get();

   
Name TCameraRigAssetAssemblerBase
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Build/CameraAssetAssembleUtils.h
Include Path #include "Build/CameraAssetAssembleUtils.h"

Syntax

template<typename ThisType>  
class TCameraRigAssetAssemblerBase :  
    public UE::Cameras::TCameraObjectInitializer< UCameraRigAsset > ,  
    public UE::Cameras::IHasNamedObjectRegistry

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

TCameraRigAssetAssemblerBase ( TSharedPtr< FNamedObjectRegistry > InNamedObjectRegistry,
FName Name,
UObject* Outer
)

   Build/CameraAssetAssembleUtils.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CameraRig UCameraRigAsset *   Build/CameraAssetAssembleUtils.h  
NamedObjectRegistry TSharedPtr< FNamedObjectRegistry >   Build/CameraAssetAssembleUtils.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

ThisType & AddBlendableParameter ( const FString& ParameterName,
ECameraVariableType ParameterType,
UCameraNode* Target,
FName TargetPropertyName
)

 Creates a new exposed rig parameter and hooks it up to the given camera node's property. Build/CameraAssetAssembleUtils.h  

ThisType & AddBlendableParameter ( const FString& ParameterName,
ECameraVariableType ParameterType,
const FString& TargetName,
FName TargetPropertyName
)

 A variant of ExposeParameter that retrieves the target node from the named registry. Build/CameraAssetAssembleUtils.h  

ThisType & AddDataParameter ( const FString& ParameterName,
const UScriptStruct* InScriptStruct,
const FString& TargetName,
FName TargetPropertyName
)

 A variant of AddDataParameter that retrieves the target node from the named registry. Build/CameraAssetAssembleUtils.h  

ThisType & AddDataParameter ( const FString& ParameterName,
TSubclassOf< UObject > ObjectClass,
const FString& TargetName,
FName TargetPropertyName
)

 A variant of AddDataParameter that retrieves the target node from the named registry. Build/CameraAssetAssembleUtils.h  

ThisType & AddDataParameter ( const FString& ParameterName,
const UScriptStruct* InScriptStruct,
UCameraNode* Target,
FName TargetPropertyName
)

 Creates a new exposed rig parameter and hooks it up to the given camera node's property. Build/CameraAssetAssembleUtils.h  

ThisType & AddDataParameter ( const FString& ParameterName,
TSubclassOf< UObject > ObjectClass,
UCameraNode* Target,
FName TargetPropertyName
)

 Creates a new exposed rig parameter and hooks it up to the given camera node's property. Build/CameraAssetAssembleUtils.h  
Adds a new enter transition and returns an assembler for it. Build/CameraAssetAssembleUtils.h  
Adds a new exit transition and returns an assembler for it. Build/CameraAssetAssembleUtils.h  

ThisType & BuildCameraRig()

 Builds the camera rig. Build/CameraAssetAssembleUtils.h  

UCameraRigAsset * Get()

 Gets the built camera rig. Build/CameraAssetAssembleUtils.h  

TCameraNodeAssembler< ThisType, UArrayCameraNode > MakeArrayRootNode()

 A convenience method that calls MakeRootNode with a UArrayCameraNode. Build/CameraAssetAssembleUtils.h  

TCameraNodeAssembler< ThisType, NodeType > MakeRootNode ()

 Creates a new camera node and sets it as the root node of the rig. Build/CameraAssetAssembleUtils.h  

ThisType & Named ( const TCHAR* InName
)

 Give a name to the built camera rig, to be recalled later. Build/CameraAssetAssembleUtils.h  

ThisType & Pin ( UCameraRigAsset*& OutPtr
)

 Pins the built camera rig to a given pointer, for being able to later refer to it. Build/CameraAssetAssembleUtils.h  

ThisType & SetDefaultParameterValue ( const FName ParameterName,
TCallTraits< ValueType >::ParamType ParameterValue
)

 Sets the default value for a camera rig parameter. Build/CameraAssetAssembleUtils.h  

ThisType & Setup ( TFunction< void(UCameraRigAsset*)> SetupCallback
)

 Runs arbitrary setup logic on the camera rig. Build/CameraAssetAssembleUtils.h  

ThisType & Setup ( TFunction< void(UCameraRigAsset*, FNamedObjectRegistry*)> SetupCallback
)

 Runs arbitrary setup logic on the camera rig. Build/CameraAssetAssembleUtils.h  

Public Virtual

Overridden from IHasNamedObjectRegistry

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FNamedObjectRegistry > GetNamedObjectRegistry()

 Gets the named object registry. Build/CameraAssetAssembleUtils.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers
  Build/CameraAssetAssembleUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page