1. Epic GamesDeveloper
  3. Core

Core

API > API/Plugins > API/Plugins/GameplayCameras

Classes

  Type Name Description
Public struct FActivateCameraRigParams Parameter structure for activating a new camera rig.  
Public struct FActiveCameraRigInfo Structure describing a camera rig that should be active.  
Public class FBlendCameraNodeEvaluator Base evaluator class for blend camera nodes.  
Public struct FBlendStackCameraFreezeParams Parameter structure for freezing a camera rig inside a transient blend stack.  
Public struct FBlendStackCameraInsertParams Parameter structure for inserting a camera rig into a persistent blend stack.  
Public class FBlendStackCameraNodeEvaluator Evaluator for a blend stack camera node.  
Public struct FBlendStackCameraPushParams Parameter structure for pushing a camera rig onto a transient blend stack.  
Public struct FBlendStackCameraRemoveParams Parameter structure for removing a camera rig from a persistent blend stack.  
Public struct FBlendStackCameraRigEvent A structure describing an event happening on a blend stack.  
Public struct UStruct FBooleanCameraParameter Boolean camera parameter.  
Public struct UStruct FBooleanCameraRigParameterOverride    
Public struct UStruct FBooleanCameraVariableReference    
Public class FBuiltInCameraVariables A utility class that provides definitions for "well-known" camera variables.  
Public class FCameraAssetBuilder A class that can prepare a camera asset for runtime use.  
Public struct FCameraBlendedParameterUpdateParams Parameter structure for updating the pre-blended parameters of a camera node.  
Public struct FCameraBlendedParameterUpdateResult Result of updating the pre-blended parameters of a camera node.  
Public class FCameraBuildLog Build log, populated when building a camera rig, or other camera asset.  
Public struct FCameraBuildLogMessage A message emitted by a camera build process.  
Public struct FCameraDirectorActivateParams Parameter structure for activating a camera director evaluator.  
Public struct FCameraDirectorDeactivateParams Parameter structure for deactivating a camera director evaluator.  
Public struct FCameraDirectorEvaluationParams Parameter structure for running a camera director.  
Public struct FCameraDirectorEvaluationResult Result structure for running a camera director.  
Public class FCameraDirectorEvaluator Base class for camera director evaluators.  
Public struct FCameraDirectorEvaluatorBuilder Structure for building director evaluators.  
Public class FCameraDirectorEvaluatorStorage Storage for a director evaluator.  
Public struct FCameraDirectorFactoryCreateParams Parameter struct passed by an asset factory when a new camera asset is created.  
Public struct FCameraDirectorInitializeParams Parameter structure for initializing a newly created camera director evaluator.  
Public class FCameraEvaluationContext Base class for providing a context to running camera rigs.  
Public struct FCameraEvaluationContextActivateParams Parameter struct for activating an evaluation context, which happens when it is added to the camera system's context stack.  
Public struct FCameraEvaluationContextDeactivateParams Parameter struct for deactivating an evaluation context, which happens when it is removed from the camera system's context stack.  
Public struct FCameraEvaluationContextInitializeParams Parameter struct for initializing an evaluation context.  
Public struct FCameraEvaluationContextStack A simple stack of evaluation contexts. The top one is the active one.  
Public class FCameraEvaluationService An evaluation service running on a camera system.  
Public struct FCameraEvaluationServiceInitializeParams Parameter structure for initializing an evaluation service.  
Public struct FCameraEvaluationServiceTeardownParams Parameter structure for tearing down an evaluation service.  
Public struct FCameraEvaluationServiceUpdateParams Parameter structure for updating an evaluation service.  
Public struct FCameraEvaluationServiceUpdateResult Result structure for updating an evaluation service.  
Public class FCameraIKAim A class that can manipulate a camera rig in order to aim it at a desired target.  
Public struct FCameraIKAimParams Parameter structure for aiming a camera rig at a target.  
Public struct FCameraNodeBlendParams Parameter struct for blending camera node tree results.  
Public struct FCameraNodeBlendResult Result struct for blending camera node tree results.  
Public struct FCameraNodeEvaluationParams Parameter structure for running a camera node evaluator.  
Public struct FCameraNodeEvaluationResult Input/output result structure for running a camera node evaluator.  
Public class FCameraNodeEvaluator Base class for objects responsible for running a camera node.  
Public struct UStruct FCameraNodeEvaluatorAllocationInfo Allocation information for an entire tree of node evaluators.  
Public struct FCameraNodeEvaluatorBuilder Structure for building camera node evaluators.  
Public struct FCameraNodeEvaluatorBuildParams Structure for building the tree of camera node evaluators.  
Public class FCameraNodeEvaluatorHierarchy A utility class that stores a flattened hierarchy of camera node evaluators.  
Public struct FCameraNodeEvaluatorInitializeParams Structure for initializing a camera node evaluator.  
Public struct FCameraNodeEvaluatorSerializeParams Parameter structure for serializing the state of a camera node evaluator.  
Public class FCameraNodeEvaluatorStorage A class responsible for storing a tree of camera node evaluators.  
Public struct FCameraNodeEvaluatorTreeBuildParams Structure for building an entire tree of node evaluators.  
Public class FCameraNodeHierarchy A utility class that stores a flattened hierarchy of camera nodes.  
Public struct FCameraNodePreBlendParams Parameter struct for blending camera node parameters.  
Public struct FCameraNodePreBlendResult Result struct for blending camera node parameters.  
Public struct FCameraObjectTypeID Identifier for a given RTTI-enabled class.  
Public struct FCameraObjectTypeInfo Type information about an RTTI-enabled class.  
Public class FCameraObjectTypeRegistry Type registry of known RTTI-enabled classes.  
Public struct FCameraOperation Base class for an operation to be executed on a camera rig.  
Public struct FCameraOperationParams Parameter structure for executing camera operations.  
Public struct FCameraOperationTypeID Simple type ID for camera operations.  
Public struct UStruct FCameraPose Structure describing the state of a camera.  
Public struct FCameraPoseFlags Boolean flags for each of the properties inside FCameraPose.  
Public struct UStruct FCameraRigAllocationInfo Structure describing various allocations needed by a camera node.  
Public class FCameraRigAssetBuilder A class that can prepare a camera rig for runtime use.  
Public struct UStruct BlueprintType FCameraRigAssetReference A structure holding a reference to a camera rig asset, along with the interface parameter override values.  
Public struct FCameraRigBuildContext Camera rig asset build context.  
Public struct FCameraRigEvaluationInfo A structure describing an active camera rig being evaluated, generally inside a blend stack.  
Public struct UStruct FCameraRigInterface Structure defining the public data interface of a camera rig asset.  
Public struct FCameraRigJoint A structure describing a joint in a camera rig.  
Public class FCameraRigJoints A structure describing the joints of a camera rig.  
Public struct UStruct FCameraRigParameterOverrideBase Base struct for camera rig parameter overrides.  
Public struct UStruct FCameraRigParameterOverrides A structure that holds lists of camera rig interface parameter overrides, one list per parameter type.  
Public struct UStruct FCameraRigProxyTableEntry An entry in a camera rig proxy table.  
Public struct FCameraRigProxyTableResolveParams Parameter structure for resolving a camera rig proxy from a proxy table.  
Public struct FCameraRigTransitionConditionMatchParams Parameter structure for camera transitions.  
Public struct FCameraSystemEvaluationParams Parameter structure for updating the camera system.  
Public struct FCameraSystemEvaluationResult Result structure for updating the camera system.  
Public class FCameraSystemEvaluator The main camera system evaluator class.  
Public struct FCameraSystemEvaluatorCreateParams Parameter structure for initializing a new camera system evaluator.  
Public struct FCameraValueInterpolationParams Parameter structure for updating a value interpolator.  
Public struct FCameraValueInterpolationResult Result structure for updating a value interpolator.  
Public struct FCameraValueInterpolatorSerializeParams Parameter structure for serializing a value interpolator.  
Public struct UStruct FCameraVariableDefinition A structure that describes a camera variable.  
Public struct UStruct FCameraVariableID The ID of a camera variable, used to refer to it in a camera variable table.  
Public class FCameraVariableTable The camera variable table is a container for a collection of arbitrary values of various types.  
Public struct UStruct FCameraVariableTableAllocationInfo A structure that describes the required camera variable table setup of a camera rig.  
Public struct FDeactivateCameraRigParams Parameter structure for deaactivating a running camera rig.  
Public class FDefaultRootCameraNodeEvaluator Evaluator for the default root camera node.  
Public struct UStruct FDoubleCameraParameter Double camera parameter.  
Public struct UStruct FDoubleCameraRigParameterOverride    
Public struct UStruct FDoubleCameraVariableReference    
Public struct UStruct FFloatCameraParameter Float camera parameter.  
Public struct UStruct FFloatCameraRigParameterOverride    
Public struct UStruct FFloatCameraVariableReference    
Public struct UStruct FInteger32CameraParameter Integer camera parameter.  
Public struct UStruct FInteger32CameraRigParameterOverride    
Public struct UStruct FInteger32CameraVariableReference    
Public class FPersistentBlendStackCameraNodeEvaluator Evaluator for a persistent blend stack.  
Public struct FPostProcessSettingsCollection A class that can collect post-process settings, combining them with their associated blend weights.  
Public struct FRootCameraNodeCameraRigEvent A structure describing an event on a root node.  
Public class FRootCameraNodeEvaluator Base class for the evaluator of a root camera node.  
Public struct UStruct FRotator3dCameraParameter Rotator3d camera parameter.  
Public struct UStruct FRotator3dCameraRigParameterOverride    
Public struct UStruct FRotator3dCameraVariableReference    
Public struct UStruct FRotator3fCameraParameter Rotator3f camera parameter.  
Public struct UStruct FRotator3fCameraRigParameterOverride    
Public struct UStruct FRotator3fCameraVariableReference    
Public struct FSingleCameraRigEvaluationParams Parameter structure for evaluating a single camera rig.  
Public struct FSingleCameraRigHierarchyBuildParams Parameter structure for building a single camera rig hierarchy.  
Public struct FSingleValueCameraOperation A camera operation that tries to correct a single undetermined input value on a camera rig.  
Public struct UStruct FTransform3dCameraParameter Transform3d camera parameter.  
Public struct UStruct FTransform3dCameraRigParameterOverride    
Public struct UStruct FTransform3dCameraVariableReference    
Public struct UStruct FTransform3fCameraParameter Transform3f camera parameter.  
Public struct UStruct FTransform3fCameraRigParameterOverride    
Public struct UStruct FTransform3fCameraVariableReference    
Public class FTransientBlendStackCameraNodeEvaluator Evaluator for a transient blend stack.  
Public struct UStruct FVector2dCameraParameter Vector2d camera parameter.  
Public struct UStruct FVector2dCameraRigParameterOverride    
Public struct UStruct FVector2dCameraVariableReference    
Public struct UStruct FVector2fCameraParameter Vector2f camera parameter.  
Public struct UStruct FVector2fCameraRigParameterOverride    
Public struct UStruct FVector2fCameraVariableReference    
Public struct UStruct FVector3dCameraParameter Vector3d camera parameter.  
Public struct UStruct FVector3dCameraRigParameterOverride    
Public struct UStruct FVector3dCameraVariableReference    
Public struct UStruct FVector3fCameraParameter Vector3f camera parameter.  
Public struct UStruct FVector3fCameraRigParameterOverride    
Public struct UStruct FVector3fCameraVariableReference    
Public struct UStruct FVector4dCameraParameter Vector4d camera parameter.  
Public struct UStruct FVector4dCameraRigParameterOverride    
Public struct UStruct FVector4dCameraVariableReference    
Public struct UStruct FVector4fCameraParameter Vector4f camera parameter.  
Public struct UStruct FVector4fCameraRigParameterOverride    
Public struct UStruct FVector4fCameraVariableReference    
Public struct FYawPitchCameraOperation A camera operation that tries to correct the yaw/pitch of a camera rig.  
Public class ICameraAssetEventHandler Interface for listening to changes on a camera asset.  
Public class ICameraRigAssetEventHandler Interface for listening to changes on a camera rig asset.  
Public class IHasCameraBuildStatus Interface for an object that can be built and has a build status, such as a camera asset or camera rig.  
Public class IObjectTreeGraphObject An interface that UObjects can implement to customize how they are represented and interacted with inside an object tree graph (see UObjectTreeGraph).  
Public class IObjectTreeGraphRootObject    
Public struct TCameraArrayChangedEvent Parameter structure for an array property change event.  
Public struct TCameraEventHandler Wrapper struct, or handle, for a listener of data change events.  
Public struct TCameraEventHandlerContainer A wrapper struct for a list of listeners waiting to be notified of data changes.  
Public class TCameraNodeEvaluator Utility base class for camera node evaluators of a specific camera node type.  
Public struct TCameraNodeEvaluatorAllocationInfo Allocation information for a node evaluator, auto-setup for a given type.  
Public class TCameraObjectStorage A utility class that allocates and stores objects of, or derived from, a common base class.  
Public struct TCameraObjectStorageTraits Default traits for specific storages.  
Public struct TCameraObjectTypeID Strongly-typed ID wrapper for an RTTI-enabled class.  
Public class TCameraParameterReader    
Public struct TCameraPropertyChangedEvent Parameter structure for a value property change event.  
Public struct TCameraValueInterpolationTraits Generic traits for interpolated value types.  
Public class TCameraValueInterpolator A value interpolator is a stand-alone object that can interpolate a given value towards a given target value.  
Public struct TCameraVariableInterpolation    
Public struct TCameraVariableTraits    
Public struct TObjectChildrenView Structure that describes a list of children of an object.  
Public class TPopValueInterpolator A simple value interpolator that immediately "pops" to the target value.  
Public class UClass Abstract, MinimalAPI Meta UBlendCameraNode Base class for blend camera nodes.  
Public class UClass MinimalAPI hidden UBlendStackCameraNode A blend stack implemented as a camera node.  
Public class UClass UBooleanCameraVariable Boolean camera variable.  
Public class UClass MinimalAPI UCameraAsset A complete camera asset.  
Public class UClass Abstract defaulttoinstanced UCameraDirector Base class for a camera director.  
Public class UClass Abstract Meta defaulttoinstanced, editinlinenew UCameraNode The base class for a camera node.  
Public class UClass MinimalAPI UCameraRigAsset A camera rig asset, which runs a hierarchy of camera nodes to drive the behavior of a camera.  
Public class UClass MinimalAPI UCameraRigProxyAsset A proxy for a camera rig asset.  
Public class UClass MinimalAPI editinlinenew UCameraRigProxyTable A table that defines mappings between camera rig proxies and actual camera rigs.  
Public class UClass MinimalAPI UCameraRigTransition A camera transition.  
Public class UClass Abstract, MinimalAPI collapsecategories, defaulttoinstanced, editinlinenew UCameraValueInterpolator Base class for value interpolator parameters.  
Public class UClass Abstract UCameraVariableAsset The base asset class for all camera variables.  
Public class UClass MinimalAPI UCameraVariableCollection An asset that represents a collection of camera variables.  
Public class UClass MinimalAPI hidden UDefaultRootCameraNode The default implementation of a root camera node.  
Public class UClass UDoubleCameraVariable Double camera variable.  
Public class UClass UFloatCameraVariable Float camera variable.  
Public class UHasCameraBuildStatus    
Public class UClass UInteger32CameraVariable Integer camera variable.  
Public class UObjectTreeGraphObject    
Public class UObjectTreeGraphRootObject    
Public class UClass Meta UPopValueInterpolator Simple interpolator that immediately "pops" to the target value.  
Public class UClass URotator3dCameraVariable Rotator3d camera variable.  
Public class UClass URotator3fCameraVariable Rotator3f camera variable.  
Public class UClass UTransform3dCameraVariable Transform3d camera variable.  
Public class UClass UTransform3fCameraVariable Transform3f camera variable.  
Public class UClass UVector2dCameraVariable Vector2d camera variable.  
Public class UClass UVector2fCameraVariable Vector2f camera variable.  
Public class UClass UVector3dCameraVariable Vector3d camera variable.  
Public class UClass UVector3fCameraVariable Vector3f camera variable.  
Public class UClass UVector4dCameraVariable Vector4d camera variable.  
Public class UClass UVector4fCameraVariable Vector4f camera variable.  

Typedefs

Name Description
FCameraDirectorEvaluatorPtr Typedef to avoid having to deal with namespaces in UCameraNode subclasses.
FCameraDoubleValueInterpolator  
FCameraNodeChildrenView View on a camera node's children.
FCameraNodeEvaluatorPtr Typedef to avoid having to deal with namespaces in UCameraNode subclasses.
FCameraRigPackages List of packages that contain the definition of a camera rig.
FCameraVector2dValueInterpolator  
FCameraVector3dDoubleValueInterpolator  
FOnBlendStackCameraRigEvent  
FOnRootCameraNodeCameraRigEvent  

Enums

  Type Name Description
Public enum UEnum EBuiltInDoubleCameraVariable Built-in floating point camera variables.  
Public enum UEnum EBuiltInRotator3dCameraVariable    
Public enum UEnum EBuiltInVector2dCameraVariable Built-in 2-dimensional camera variables.  
Public enum UEnum ECameraBlendStackType Describes a type of blend stack.  
Public enum UEnum ECameraBuildStatus Enumeration that describes if a camera asset needs to be rebuilt.  
Public enum UEnum ECameraRigInitialOrientation Determines how a camera rig's initial orientation should be initialized.  
Public enum UEnum BlueprintType ECameraRigLayer Defines evaluation layers for camera rigs.  
Public enum UEnum ECameraVariableType The type of a camera variable.  
Public enum EObjectTreeGraphObjectSupportFlags Flags representing supported optional APIs of an IObjectTreeGraphObject.  
Public enum UE::Cameras::EBlendStackCameraRigEventType A type of blend stack event.  
Public enum UE::Cameras::EBuiltInCameraOperationTypes Hard-coded type IDs for built-in camera operations.  
Public enum UE::Cameras::ECameraArrayChangedEventType The type of change on an array property.  
Public enum UE::Cameras::ECameraEvaluationServiceFlags Flags for what callbacks an evaluation service wants to opt-into.  
Public enum UE::Cameras::ECameraNodeEvaluationType The type of evaluation being run.  
Public enum UE::Cameras::ECameraNodeEvaluatorFlags Flags describing the needs of a camera node evaluator.  
Public enum UE::Cameras::ECameraVariableTableFilter Filter for variable table operations.  
Public enum UE::Cameras::ERootCameraNodeCameraRigEventType The type of root node event.  

Functions

  Type Name Description
Public function bool

CameraParameterValueEquals ( typename TCallTraits< ValueType >::ParamType A,
typename TCallTraits< ValueType >::ParamType B
)

  
Public function    
Public function    
Public function   View on a camera node evaluator's children.
Public function   A structure that keeps track of which variables have been processed in a camera variable table.
Public function Const  

UE::Cameras::ENUM_CLASS_FLAGS ( FCameraVariableTable::EEntryFlags
)

  

Variables

  Type Name Description
Public variable   ObjectTreeGraphCategory Base class for a camera transition condition.
Public variable   ObjectTreeGraphDefaultPropertyPinDirection  
Public variable   ObjectTreeGraphSelfPinDirection  
Public variable   ObjectTreeGraphSelfPinDirection An exposed camera rig parameter that drives a specific parameter on one of its camera nodes.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page