1. Epic GamesDeveloper
  3. GameplayCameras

GameplayCameras

API > API/Plugins

   
Name GameplayCameras
Type Plugin
Part of Plugins Gameplay Cameras
Location /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/
Module Build Rules GameplayCameras.Build.cs

Classes

Name Remarks
AGameplayCameraActor An actor that can run a camera asset.
AGameplayCameraActorBase A base class for actors that can run a camera object.
AGameplayCameraRigActor An actor that can run a camera asset.
AGameplayCamerasPlayerCameraManager A player camera manager that runs the GameplayCameras camera system.
AGameplayCameraSystemActor An actor that hosts a camera system.
FActorCameraEvaluationContext An evaluation context for an arbitrary actor.
FBaseFramingCameraNodeEvaluator The base class for a framing camera node evaluator.
FBlendCameraNodeEvaluator Base evaluator class for blend camera nodes.
FBlendStackCameraDebugBlock  
FBlendStackCameraNodeEvaluator Evaluator for a blend stack camera node.
FBlendStacksCameraDebugBlock Debug block that shows multiple blend stacks.
FBlendStackSummaryCameraDebugBlock  
FBuiltInCameraVariables A utility class that provides definitions for "well-known" camera variables.
FCameraAssetBuilder A class that can prepare a camera asset for runtime use.
FCameraBuildLog Build log, populated when building a camera rig, or other camera asset.
FCameraContextDataTable The camera context data table is a container for a collection of arbitrary values of various types.
FCameraDebugBlock Debug drawing structure responsible for displaying information about some aspect of the camera system evaluation.
FCameraDebugBlockStorage A class responsible for storing a tree of debug blocks
FCameraDebugClock A debug clock, for showing a real-time angle or 2D vector in a graphical way.
FCameraDebugClockRenderer  
FCameraDebugColors Standard debug drawing colors for the camera system.
FCameraDebugGraphRenderer  
FCameraDebugRenderer Utility class for camera-related debug drawing.
FCameraDirectorEvaluator Base class for camera director evaluators.
FCameraDirectorEvaluatorStorage Storage for a director evaluator.
FCameraDirectorTreeDebugBlock A debug block for showing the list of camera directors in the camera system's context stack.
FCameraEvaluationContext Base class for providing a context to running camera rigs.
FCameraEvaluationService An evaluation service running on a camera system.
FCameraEvaluationServiceDebugBlock Basic debug block for an evaluation service.
FCameraFramingMath Utility class for mathematical functions related to framing zones.
FCameraIKAim A class that can manipulate a camera rig in order to aim it at a desired target.
FCameraModifierService An evaluation service for running "camera modifiers", which are context-less camera rig instances meant to run additively in the camera system.
FCameraNodeEvaluationResultDebugBlock A debug block that prints an evaluation result.
FCameraNodeEvaluator Base class for objects responsible for running a camera node.
FCameraNodeEvaluatorDebugBlock Basic debug block for a camera node evaluator.
FCameraNodeEvaluatorHierarchy A utility class that stores a flattened hierarchy of camera node evaluators.
FCameraNodeEvaluatorStorage A class responsible for storing a tree of camera node evaluators.
FCameraNodeHierarchy A utility class that stores a flattened hierarchy of camera nodes.
FCameraNodeHierarchyBuilder A helper class that can build a hierarchy of camera nodes.
FCameraNodeSpaceMath  
FCameraObjectInterfaceBuilder  
FCameraObjectInterfaceParameterBuilder A helper class for building an FInstancedPropertyBag from a list of camera rig parameter definitions.
FCameraObjectTypeRegistry Type registry of known RTTI-enabled classes.
FCameraParameterSetterService A camera system service that handles running camera parameter setters.
FCameraPoseDebugBlock A debug block that displays information about a camera pose.
FCameraPoseLocationTrailDebugBlock A debug block that draws a camera pose location trail.
FCameraPoseMath A utility class for mathematical functions related to a camera pose.
FCameraRigAssetBuilder A class that can prepare a camera rig for runtime use.
FCameraRigCameraNodeEvaluator  
FCameraRigInput1DSlotEvaluator  
FCameraRigInput2DSlotEvaluator  
FCameraRigJoints A structure describing the joints of a camera rig.
FCameraRigJointsDebugBlock A debug block that displays information about a camera rig's joints.
FCameraShakeAssetBuilder  
FCameraShakeService A camera system service that handles running camera shakes in the visual layer.
FCameraSystemDebugRegistry A registry for any running camera system instance for which we may want to display debug info.
FCameraSystemEvaluator The main camera system evaluator class.
FCameraVariableTable The camera variable table is a container for a collection of arbitrary values of various types.
FCategoryTitleDebugBlock A utility debug block that prints a title for a debug category, if that debug category is active.
FContextDataTableDebugBlock A debug block that prints the contents of a context data table.
FDebugTextRenderer Rendering utility for colored debug text.
FDefaultRootCameraNodeEvaluator Evaluator for the default root camera node.
FGameplayCameraComponentEvaluationContext Evaluation context for the gameplay camera component.
FGameplayCamerasDelegates Global delegates for the GameplayCameras module.
FInput1DCameraNodeEvaluator Base class for a 1D input value node evaluator.
FInput2DCameraNodeEvaluator Base class for a 2D input value node evaluator.
FInterruptedBlendCameraNodeEvaluator A special blend meant to "freeze" an ongoing blend, and then start running another blend.
FObjectReferenceFinder A utility class for finding references from a given package to a set of UObjects.
FOutgoingReferenceFinder A utility class for finding outgoing references from a given package to external UObjects of a given class.
FPersistentBlendStackCameraNodeEvaluator Evaluator for a persistent blend stack, i.e. a blend stack in which camera rigs blend additively on top of each other, but without automatically popping out any fully blended-out entries.
FPlayerControllersDebugBlock A debug block for showing the list of local player controllers and their view targets.
FPlayerControlRotationEvaluationService An evaluation service that manages the player's control rotation based on what's going on with cameras.
FPostProcessSettingsDebugBlock A debug block that displays information about post-process settings.
FPriorityQueueCameraDirectorEvaluator Evaluator for the priority queue camera director.
FReverseBlendCameraNodeEvaluator A special blend that can run another blend in "reverse", when that blend doesn't support reverse mode.
FRootCameraDebugBlock The root debug block for the camera system.
FRootCameraNodeEvaluator Base class for the evaluator of a root camera node.
FShakeCameraNodeEvaluator  
FSimpleBlendCameraNodeEvaluator  
FSimpleFixedTimeBlendCameraNodeEvaluator  
FTransientBlendStackCameraNodeEvaluator Evaluator for a transient blend stack, i.e. a blend stack where camera rigs evaluate together, blending together and blend out those below them, which are then automatically popped out of the stack.
FVariableTableDebugBlock A debug block that prints the contents of a variable table.
FViewfinderDebugBlock  
TCameraDebugGraph A debug graph, showing one or more lines.
TCameraNodeEvaluator Utility base class for camera node evaluators of a specific camera node type.
TCameraObjectStorage A utility class that allocates and stores objects of, or derived from, a common base class.
TCameraParameterReader A utility class for reading the effective value of a camera parameter.
TCameraValueInterpolator A value interpolator is a stand-alone object that can interpolate a given value towards a given target value.
TCameraVariableReferenceReader A utility class for reading the effective value of variable reference.
TIIRValueInterpolator The actual evaluation code for the IIR interpolator.
TPopValueInterpolator A simple value interpolator that immediately "pops" to the target value.
UAccelerationDecelerationValueInterpolator A value interpolator that first accelerates up to a maximum speed, and then decelerates before reaching the target value.
UActivateCameraRigFunctions Blueprint functions for activating camera rigs in the base/global/visual layers.
UArrayCameraNode A camera node that runs a list of other camera nodes.
UAssetReferenceCameraNode  
UAttachToActorCameraNode A camera node that moves the camera to an actor.
UAttachToActorGroupCameraNode A camera node that moves the camera to the weighted center of a group of actors.
UAttachToPlayerPawnCameraNode A camera node that moves the camera to the player pawn.
UAutoFocusCameraNode A camera node that sets the focus distance to the distance of the current target.
UAutoRotateInput2DCameraNode An input node that modifies a yaw/pitch input in order to re-align its values to a given default direction.
UBaseCameraObject  
UBaseFramingCameraNode The base class for a standard scren-space framing camera node.
UBlendCameraNode Base class for blend camera nodes.
UBlendStackCameraNode A blend stack implemented as a camera node.
UBlueprintCameraContextDataTableFunctionLibrary Utility Blueprint functions for camera context data tables.
UBlueprintCameraDirector A camera director that will instantiate the given Blueprint and run it.
UBlueprintCameraDirectorEvaluator Base class for a Blueprint camera director evaluator.
UBlueprintCameraEvaluationDataFunctionLibrary Blueprint function library for camera evaluation data references.
UBlueprintCameraNode A camera node that runs arbitrary Blueprint logic.
UBlueprintCameraNodeEvaluator The base class for Blueprint camera node evaluators.
UBlueprintCameraPoseFunctionLibrary Utility Blueprint functions for camera poses.
UBlueprintCameraVariableTableFunctionLibrary Blueprint function library for camera variable tables.
UBodyParametersCameraNode A camera node that configures parameters on the camera body.
UBooleanCameraVariable Boolean camera variable.
UBoomArmCameraNode A camera node that can rotate the camera in yaw and pitch based on player input.
UCalcCameraActorCameraNode A simple camera node that calls an actor's CalcCamera functoin and copies the result to the evaluation output.
UCameraAsset A complete camera asset.
UCameraComponentCameraNode A simple camera node that copies the properties of a camera component and applies them to the evaluation output.
UCameraDirector Base class for a camera director.
UCameraDirectorStateTreeSchema The schema of the StateTree for a StateTree camera director.
UCameraNode The base class for a camera node.
UCameraObjectInterfaceBlendableParameter An exposed camera rig parameter that drives a specific parameter on one of its camera nodes.
UCameraObjectInterfaceDataParameter  
UCameraObjectInterfaceParameterBase Base class for interface parameters on a camera rig asset.
UCameraRigAsset A camera rig asset, which runs a hierarchy of camera nodes to drive the behavior of a camera.
UCameraRigCameraNode A camera node that runs a camera rig's own node tree.
UCameraRigInput1DSlot The base class for a node that can handle and accumulate raw player input values.
UCameraRigInput2DSlot The base class for a node that can handle and accumulate raw player input values.
UCameraRigInstanceFunctions Blueprint functions for camera rig instance IDs.
UCameraRigParameterInterop Blueprint internal methods to set values on a camera rig's exposed parameters.
UCameraRigProxyAsset A proxy for a camera rig asset.
UCameraRigProxyTable  
UCameraRigTransition A camera transition.
UCameraShakeAsset  
UCameraShakeCameraNode A camera node that runs a camera shake asset.
UCameraShakeServiceCameraNode  
UCameraValueInterpolator Base class for value interpolator parameters.
UCameraVariableAsset The base asset class for all camera variables.
UCameraVariableCollection An asset that represents a collection of camera variables.
UClippingPlanesCameraNode A camera node that sets the clipping planes for the evaluated camera.
UCollisionPushCameraNode A node that pushes the camera towards a "safe position" when it is colliding with the environment.
UCompositeShakeCameraNode  
UControllerGameplayCameraEvaluationComponent A component, attached to a player controller, that can run camera rigs activated from a global place like the Blueprint functions inside UActivateCameraRigFunctions.
UCriticalDamperValueInterpolator A value interpolator that uses a spring-mass system to converge towards the target value.
UCustomCameraNodeParameterProvider  
UDampenPositionCameraNode A camera node that smoothes the movement of the camera.
UDampenRotationCameraNode A camera node that smoothes the rotation of the camera.
UDefaultRootCameraNode The default implementation of a root camera node.
UDollyFramingCameraNode A camera node that frames a target by moving along a sideways rail (left/right relative to the camera transform) and optionally also up and down.
UDoubleCameraVariable Double camera variable.
UDoubleIIRValueInterpolator Double infinite impulse response filter interpolator.
UEnvelopeShakeCameraNode  
UFieldOfViewCameraNode A camera node that sets the field of view of the camera.
UFilmbackCameraNode A camera node that configures the camera filmback.
UFloatCameraVariable Float camera variable.
UGameplayCameraParameterSetterComponent  
UGameplayCamerasSettings The settings for the Gameplay Cameras runtime.
UGameplayCameraSystemComponent A component that hosts a camera system.
UGameplayCameraSystemHost An interface for objects that host a camera system evaluator.
UGameplayControlRotationComponent An example component that works with the GameplayCameraComponent to manage a player's control rotation when the camera changes or moves in a way that was not initiated by the player themselves.
UGameplayTagTransitionCondition A transition condition that matches the gameplay tags on the previous and next camera rigs and assets.
UHasCameraBuildStatus  
UIIRValueInterpolator Infinite impulse response filter interpolator.
UInputAxisBinding2DCameraNode An input node that reads player input from an input action.
UInteger32CameraVariable Integer camera variable.
UIsCameraRigTransitionCondition A transition condition that matches the previous and/or next camera rigs against one of the owning camera asset's rigs.
ULensCalibrationCameraNode A camera node that specifies a lens definition.
ULensParametersCameraNode A camera node that sets parameter values on the camera lens.
ULinearBlendCameraNode Linear blend node.
ULocationRotationBlendCameraNode A blend node that blends translation and rotation differently.
UMovieSceneCameraFramingZoneSection  
UMovieSceneCameraFramingZoneTrack  
UObjectTreeGraphComment A generic comment node for object tree graphs.
UObjectTreeGraphObject  
UObjectTreeGraphRootObject  
UOcclusionMaterialCameraNode  
UOffsetCameraNode A camera node that offsets the location of the camera.
UOrbitBlendCameraNode Orbit blend node.
UOrthographicCameraNode A camera node that sets the perspective mode to orthographic.
UPanningFramingCameraNode A camera node that frames a target by rotating in place.
UPerlinNoiseLocationShakeCameraNode  
UPerlinNoiseRotationShakeCameraNode  
UPopBlendCameraNode A blend node that creates a camera cut (i.e. it doesn't blend at all).
UPopValueInterpolator Simple interpolator that immediately "pops" to the target value.
UPostProcessCameraNode A camera node that adds post-process settings on the evaluated camera.
UPriorityQueueCameraDirector A camera director that holds multiple sub-directors, and runs the one that has the highest priority.
URootCameraNode The base class for a camera node that can act as the root of the camera system evaluation.
URotator3dCameraVariable Rotator3d camera variable.
URotator3fCameraVariable Rotator3f camera variable.
USetLocationCameraNode A camera node that sets the location of the camera.
USetRotationCameraNode A camera node that sets the rotation of the camera.
UShakeCameraNode Base class for shake camera nodes.
USimpleBlendCameraNode Base class for a blend camera node that uses a simple scalar factor.
USimpleFixedTimeBlendCameraNode Base class for a blend camera node that uses a simple scalar factor over a fixed time.
USingleCameraDirector A simple camera director that only ever returns one single camera rig.
USmoothBlendCameraNode A blend camera rig that implements the smoothstep and smoothersteps algorithms.
USplineFieldOfViewCameraNode A camera node that sets the field of view of the camera by evaluating a curve.
USplineOffsetCameraNode A camera node that offsets the location and rotation of the camera by evaluating curves.
USplineOrbitCameraNode A camera node that can orbit around a pivot point, and the shape of the orbit is defined by pitch-based parameters.
UStateTreeCameraDirector A camera director that runs a StateTree to specify which camera rigs should be active any given frame.
UTargetRayCastCameraNode A camera node that determines and sets the camera's target by running a ray-cast from the current camera position.
UTransform3dCameraVariable Transform3d camera variable.
UTransform3fCameraVariable Transform3f camera variable.
UVector2dCameraVariable Vector2d camera variable.
UVector2fCameraVariable Vector2f camera variable.
UVector3dCameraVariable Vector3d camera variable.
UVector3fCameraVariable Vector3f camera variable.
UVector4dCameraVariable Vector4d camera variable.
UVector4fCameraVariable Vector4f camera variable.
UViewTargetTransitionParamsBlendCameraNode A blend node that implements the blend algorithms of the FViewTargetTransitionParams.

Structs

Name Remarks
FActivateCameraRigParams Parameter structure for activating a new camera rig.
FBaseCameraObjectReference  
FBlendableStructInfo  
FBlendStackCameraFreezeParams Parameter structure for freezing a camera rig inside a transient blend stack.
FBlendStackCameraInsertParams Parameter structure for inserting a camera rig into a persistent blend stack.
FBlendStackCameraPushParams Parameter structure for pushing a camera rig onto a transient blend stack.
FBlendStackCameraRemoveParams Parameter structure for removing a camera rig from a persistent blend stack.
FBlendStackCameraRigEvent A structure describing an event happening on a blend stack.
FBlendStackEntryID An ID for an entry in a camera blend stack.
FBlueprintCameraPose Represents a camera pose.
FBooleanCameraParameter All camera parameters have:
FBooleanCameraRigParameterOverride  
FBooleanCameraVariableReference All camera references have:
FCameraActorAttachmentInfo Attachment information for a camera rig.
FCameraActorAttachmentInfoArrayReader A special reader class for multiple attachment information.
FCameraActorAttachmentInfoReader A special reader class for attachment information.
FCameraActorComputedTargetInfo  
FCameraActorTargetInfo Targeting information for a camera rig.
FCameraActorTargetInfoArrayReader A special reader class for multiple targeting information.
FCameraActorTargetInfoReader A special reader class for targeting information.
FCameraAssetAllocationInfo Structure describing various allocations needed by a camera asset.
FCameraAssetReference A structure holding a reference to a camera asset, along with the interface parameter override values for any of its camera rigs.
FCameraBlendedParameterUpdateParams Parameter structure for updating the pre-blended parameters of a camera node.
FCameraBlendedParameterUpdateResult Result of updating the pre-blended parameters of a camera node.
FCameraBuildLogMessage A message emitted by a camera build process.
FCameraContextDataDefinition Definition for one entry in a camera rig's context data registry.
FCameraContextDataID The ID of a context data, used to refer to it in a camera context data table.
FCameraContextDataTableAllocationInfo Collection of context data entries for a camera rig.
FCameraDebugBlockBuilder Builder class for camera debug drawing blocks.
FCameraDebugBlockBuildParams Structure for creating the node evaluator's debug blocks.
FCameraDebugBlockDrawParams Parameter structure for debug block drawing.
FCameraDebugBlockField Metadata for a debug block's member field.
FCameraDebugCategories Standard debug categories for showing different "debug modes".
FCameraDebugClockDrawParams Parameter structure for drawing a debug clock.
FCameraDebugGraphDrawParams Parameter structure for drawing a debug graph.
FCameraDirectorActivateParams Parameter structure for activating a camera director evaluator.
FCameraDirectorDeactivateParams Parameter structure for deactivating a camera director evaluator.
FCameraDirectorEvaluationParams Parameter structure for running a camera director.
FCameraDirectorEvaluationResult Result structure for running a camera director.
FCameraDirectorEvaluatorBuilder Structure for building director evaluators.
FCameraDirectorFactoryCreateParams Parameter struct passed by an asset factory when a new camera asset is created.
FCameraDirectorInitializeParams Parameter structure for initializing a newly created camera director evaluator.
FCameraDirectorRigUsageInfo Parameter struct for gathering camera rigs used by a director.
FCameraDirectorStateTreeEvaluationData The evaluation data for the StateTree camera director.
FCameraEditorPreviewDrawParams Parameter structure for drawing editor preview.
FCameraEvaluationContextActivateParams Parameter struct for activating an evaluation context, which happens when it is added to the camera system's context stack.
FCameraEvaluationContextDeactivateParams Parameter struct for deactivating an evaluation context, which happens when it is removed from the camera system's context stack.
FCameraEvaluationContextInitializeParams Parameter struct for initializing an evaluation context.
FCameraEvaluationContextStack A simple stack of evaluation contexts. The top one is the active one.
FCameraEvaluationServiceInitializeParams Parameter structure for initializing an evaluation service.
FCameraEvaluationServiceTeardownParams Parameter structure for tearing down an evaluation service.
FCameraEvaluationServiceUpdateParams Parameter structure for updating an evaluation service.
FCameraEvaluationServiceUpdateResult Result structure for updating an evaluation service.
FCameraFieldsOfView Simple struct for holding horizontal and vertical fields of view.
FCameraFramingZone A structure that defines a zone for use in framing subjects in screen-space.
FCameraFramingZoneParameter Framing zone camera parameter.
FCameraIKAimDebugInfo  
FCameraIKAimIterationDebugInfo  
FCameraIKAimParams Parameter structure for aiming a camera rig at a target.
FCameraNodeBlendInterruptionParams Parameter struct for initializing a blend from an interrupted blend.
FCameraNodeBlendParams Parameter struct for blending camera node tree results.
FCameraNodeBlendResult Result struct for blending camera node tree results.
FCameraNodeEvaluationParams Parameter structure for running a camera node evaluator.
FCameraNodeEvaluationResult Input/output result structure for running a camera node evaluator.
FCameraNodeEvaluatorAllocationInfo Allocation information for an entire tree of node evaluators.
FCameraNodeEvaluatorBuilder Structure for building camera node evaluators.
FCameraNodeEvaluatorBuildParams Structure for building the tree of camera node evaluators.
FCameraNodeEvaluatorInitializeParams Structure for initializing a camera node evaluator.
FCameraNodeEvaluatorSerializeParams Parameter structure for serializing the state of a camera node evaluator.
FCameraNodeEvaluatorTreeBuildParams Structure for building an entire tree of node evaluators.
FCameraNodePreBlendParams Parameter struct for blending camera node parameters.
FCameraNodePreBlendResult Result struct for blending camera node parameters.
FCameraNodeShakeParams Parameters for applying a shake to a camera result.
FCameraNodeShakeRestartParams Parameters for restarting a running camera shake.
FCameraNodeShakeResult Result structure for applying a shake to a camera result.
FCameraNodeSpaceParams A structure that can wrap node evaluation parameters and results, and spit out information needed to compute positions and offsets in various evaluation coordinate systems.
FCameraObjectAllocationInfo Structure describing various allocations needed by a camera rig.
FCameraObjectBuildContext Camera object build context.
FCameraObjectInterface Structure defining the public data interface of a camera object.
FCameraObjectInterfaceParameterDefinition Information about a parameter exposed on a camera asset.
FCameraObjectInterfaceParameterMetaData Metadata for a referenced camera object's interface parameters.
FCameraObjectTypeID Identifier for a given RTTI-enabled class.
FCameraObjectTypeInfo Type information about an RTTI-enabled class.
FCameraOperation Base class for an operation to be executed on a camera rig.
FCameraOperationParams Parameter structure for executing camera operations.
FCameraOperationTypeID Simple type ID for camera operations.
FCameraParameterClamping Value clamping parameters.
FCameraParameterNormalization Value normalization parameters.
FCameraPose Structure describing the state of a camera.
FCameraPoseFlags Boolean flags for each of the properties inside FCameraPose.
FCameraRigActivationDeactivationRequest Structure for requesting that a camera rig be activated or deactivated.
FCameraRigAssetReference A structure holding a reference to a camera rig asset, along with the interface parameter override values.
FCameraRigEvaluationInfo A structure describing an active camera rig being evaluated, generally inside a blend stack.
FCameraRigInputSlotParameters General options for an input slot.
FCameraRigInstanceID A unique instance ID for a running, or previously running, camera rig.
FCameraRigJoint A structure describing a joint in a camera rig.
FCameraRigParameterOverrideBase  
FCameraRigParameterOverrides A structure that holds lists of camera rig interface parameter overrides, one list per parameter type.
FCameraRigProxyRedirectTable A table that defines mappings between camera rig proxies and actual camera rigs.
FCameraRigProxyRedirectTableEntry An entry in a camera rig proxy table.
FCameraRigProxyResolveParams Parameter structure for resolving a camera rig proxy from a proxy table.
FCameraRigTransitionConditionMatchParams Parameter structure for camera transitions.
FCameraRotatorCurve  
FCameraShakeAssetReference A structure holding a reference to a camera shake asset, along with the interface parameter override values.
FCameraSingleCurve  
FCameraSystemDebugID An identifier for a camera system instance.
FCameraSystemDebugUpdateParams Parameter structure for running the debug pass of the camera system.
FCameraSystemEditorPreviewParams Parameter structure for rendering the state of the camera system in editor.
FCameraSystemEvaluationParams Parameter structure for updating the camera system.
FCameraSystemEvaluationResult Result structure for updating the camera system.
FCameraSystemEvaluatorCreateParams Parameter structure for initializing a new camera system evaluator.
FCameraSystemViewRotationEvaluationResult Result structure for view rotation updates of the camera system.
FCameraValueInterpolationParams Parameter structure for updating a value interpolator.
FCameraValueInterpolationResult Result structure for updating a value interpolator.
FCameraValueInterpolatorSerializeParams Parameter structure for serializing a value interpolator.
FCameraVariableDefinition A structure that describes a camera variable.
FCameraVariableID The ID of a camera variable, used to refer to it in a camera variable table.
FCameraVariableSetter A base structure for overriding a camera variable value until told to stop.
FCameraVariableSetterHandle A handle to an ongoing camera variable setter.
FCameraVariableTableAllocationInfo A structure that describes the required camera variable table setup of a camera rig.
FCameraVariableTableFlags A structure that keeps track of which variables have been processed in a camera variable table.
FCameraVectorCurve  
FCriticalDamper Implements a critically damped spring-mass system.
FCustomCameraNodeBlendableParameter Describes a custom camera blendable parameter.
FCustomCameraNodeDataParameter Describes a custom camera data parameter.
FCustomCameraNodeParameterInfos A structure for providing custom camera rig parameter information.
FCustomCameraNodeParameters Describes custom camera parameters.
FDeactivateCameraRigParams Parameter structure for deactivating a running camera rig.
FDebugTextDrawCommand Command for drawing text on a canvas.
FDebugTextNewLineCommand Command for moving the drawing position to a new line.
FDebugTextSetColorCommand Command for setting the text color on a canvas.
FDoubleCameraParameter Double camera parameter.
FDoubleCameraRigParameterOverride  
FDoubleCameraVariableReference  
FFloatCameraParameter Float camera parameter.
FFloatCameraRigParameterOverride  
FFloatCameraVariableReference  
FFramingZone Effective coordinates for a rectangular screen-space zone.
FFramingZoneAngles The half-angles (in radians) of a rectangular screen framing zone, relative to the camera pose's aim direction.
FGameplayCameraAssetBuildEvent  
FGameplayCamerasActivateCameraRigTask A task that activates a given camera rig inside a StateTreeCameraDirector.
FGameplayCamerasActivateCameraRigTaskInstanceData Instance data for the "Activate Camera Rig" task.
FGameplayCamerasActivateCameraRigViaProxyTask A task that activates a camera rig via the given camera rig proxy inside a StateTreeCameraDirector.
FGameplayCamerasActivateCameraRigViaProxyTaskInstanceData Instance data for the "Activate Camera Rig via Proxy" task.
FGameplayCamerasStateTreeCondition Base classs for camera director StateTree conditions.
FGameplayCamerasStateTreeTask Base classs for camera director StateTree tasks.
FInteger32CameraParameter Integer camera parameter.
FInteger32CameraRigParameterOverride  
FInteger32CameraVariableReference  
FPerlinNoise Implements a 1-dimensional perlin noise generator.
FPerlinNoiseData  
FPlayerControlRotationParams Parameter structure for the player control rotation service.
FPopBlendCameraNodeHelper Utility function for cutting evaluation results without blending.
FPostProcessSettingsCollection A class that can collect post-process settings, combining them with their associated blend weights.
FRootCameraNodeCameraRigEvent A structure describing an event on a root node.
FRotator3dCameraParameter Rotator3d camera parameter.
FRotator3dCameraRigParameterOverride  
FRotator3dCameraVariableReference  
FRotator3fCameraParameter Rotator3f camera parameter.
FRotator3fCameraRigParameterOverride  
FRotator3fCameraVariableReference  
FSimpleBlendCameraNodeEvaluationResult Result structure for defining a simple scalar-factor-based blend.
FSingleCameraRigEvaluationParams Parameter structure for evaluating a single camera rig.
FSingleCameraRigHierarchyBuildParams Parameter structure for building a single camera rig hierarchy.
FSingleValueCameraOperation A camera operation that tries to correct a single undetermined input value on a camera rig.
FSplineOrbitControlPoint Control point for the spline orbit camera node.
FStartCameraShakeParams Parameters for starting a camera shake.
FStateTreeContextDataNames  
FTransform3dCameraParameter Transform3d camera parameter.
FTransform3dCameraRigParameterOverride  
FTransform3dCameraVariableReference  
FTransform3fCameraParameter Transform3f camera parameter.
FTransform3fCameraRigParameterOverride  
FTransform3fCameraVariableReference  
FVector2dCameraParameter Vector2d camera parameter.
FVector2dCameraRigParameterOverride  
FVector2dCameraVariableReference  
FVector2fCameraParameter Vector2f camera parameter.
FVector2fCameraRigParameterOverride  
FVector2fCameraVariableReference  
FVector3dCameraParameter Vector3d camera parameter.
FVector3dCameraRigParameterOverride  
FVector3dCameraVariableReference  
FVector3fCameraParameter Vector3f camera parameter.
FVector3fCameraRigParameterOverride  
FVector3fCameraVariableReference  
FVector4dCameraParameter Vector4d camera parameter.
FVector4dCameraRigParameterOverride  
FVector4dCameraVariableReference  
FVector4fCameraParameter Vector4f camera parameter.
FVector4fCameraRigParameterOverride  
FVector4fCameraVariableReference  
FYawPitchCameraOperation A camera operation that tries to correct the yaw/pitch of a camera rig.
TCameraArrayChangedEvent Parameter structure for an array property change event.
TCameraContextDataReader  
TCameraContextDataTraits  
TCameraDebugBlockField Templated version of the debug block field.
TCameraDebugGraphEntry An entry on a debug graph, defined by a timestamp and one or more graph values.
TCameraEventHandler Wrapper struct, or handle, for a listener of data change events.
TCameraEventHandlerContainer A wrapper struct for a list of listeners waiting to be notified of data changes.
TCameraNodeEvaluatorAllocationInfo Allocation information for a node evaluator, auto-setup for a given type.
TCameraObjectStorageTraits Default traits for specific storages.
TCameraObjectTypeID Strongly-typed ID wrapper for an RTTI-enabled class.
TCameraPropertyChangedEvent Parameter structure for a value property change event.
TCameraValueInterpolationTraits Generic traits for interpolated value types.
TCameraVariableInterpolation  
TCameraVariableSetter An actual camera variable setter for a given type of values.
TCameraVariableTraits  
TConsumableValue A value that can be "consumed" and applied to another value.
TIIRValueInterpolatorTraits  
TObjectChildrenView Structure that describes a list of children of an object.
TVariableSetterValueInterpolator  

Interfaces

Name Remarks
IAssetReferenceCameraNode  
ICameraAssetEventHandler Interface for listening to changes on a camera asset.
ICameraObjectEventHandler Interface for listening to changes on a camera rig asset.
ICameraRigAssetEventHandler Interface for listening to changes on a camera rig asset.
ICustomCameraNodeParameterProvider An interface for camera nodes that want to expose a custom interface of blendable parameters and data parameters.
IGameplayCamerasLiveEditListener Interface for an object that can handle an asset being hot-reloaded at runtime.
IGameplayCamerasLiveEditManager Interface for an object that can centralize the live-editing features of the camera system.
IGameplayCamerasModule  
IGameplayCameraSystemHost An interface for objects that host a camera system evaluator.
IHasCameraBuildStatus Interface for an object that can be built and has a build status, such as a camera asset or camera rig.
IObjectTreeGraphObject An interface that UObjects can implement to customize how they are represented and interacted with inside an object tree graph (see UObjectTreeGraph).
IObjectTreeGraphRootObject  
IPriorityQueueEntry Interface for sub-directors with dynamic priorities.

Typedefs

Name Type Remarks Include Path
FBlendableStructTypeErasedInterpolator void(*)(uint8 *From, const uint8 *To, float Alpha)   Core/CameraVariableTableFwd.h
FCameraDirectorEvaluatorPtr UE::Cameras::FCameraDirectorEvaluator * Typedef to avoid having to deal with namespaces in UCameraNode subclasses. Core/CameraDirectorEvaluator.h
FCameraDoubleValueInterpolator TCameraValueInterpolator< double >   Core/CameraValueInterpolator.h
FCameraNodeChildrenView UE::Cameras::TObjectChildrenView< TObjectPtr< UCameraNode > > View on a camera node's children. Core/CameraNode.h
FCameraNodeEvaluatorChildrenView TObjectChildrenView< FCameraNodeEvaluator * > View on a camera node evaluator's children. Core/CameraNodeEvaluator.h
FCameraNodeEvaluatorPtr UE::Cameras::FCameraNodeEvaluator * Typedef to avoid having to deal with namespaces in UCameraNode subclasses. Core/CameraNodeEvaluatorFwd.h
FCameraRigPackages TArray< const UPackage *, TInlineAllocator< 4 > > List of packages that contain the definition of a camera rig. Core/CameraRigAsset.h
FCameraVariableSetterPtr TInlineValue< FCameraVariableSetter, 64 >   Core/CameraVariableSetter.h
FCameraVector2dValueInterpolator TCameraValueInterpolator< FVector2d >   Core/CameraValueInterpolator.h
FCameraVector3dDoubleValueInterpolator TCameraValueInterpolator< FVector3d >   Core/CameraValueInterpolator.h
FConsumableDouble TConsumableValue< double >   Math/ConsumableValue.h
FConsumableFloat TConsumableValue< float >   Math/ConsumableValue.h
FDebugTextCommand TVariant< FDebugTextDrawCommand, FDebugTextNewLineCommand, FDebugTextSetColorCommand > A debug text drawing command, which can be of multiple types. Debug/DebugTextRenderer.h
FDebugTextCommandArray TArray< FDebugTextCommand > A command queue for drawing text on a canvas. Debug/DebugTextRenderer.h
FOnBlendStackCameraRigEvent TMulticastDelegate_OneParam< void, const FBlendStackCameraRigEvent & >   Core/BlendStackCameraNode.h
FOnCameraAssetBuilt TMulticastDelegate_OneParam< void, const UCameraAsset * >   GameplayCamerasDelegates.h
FOnCameraNodeChanged TMulticastDelegate_OneParam< void, const UCameraNode * >   GameplayCamerasDelegates.h
FOnCameraRigAssetBuilt TMulticastDelegate_OneParam< void, const UCameraRigAsset * >   GameplayCamerasDelegates.h
FOnCameraShakeAssetBuilt TMulticastDelegate_OneParam< void, const UCameraShakeAsset * >   GameplayCamerasDelegates.h
FOnRootCameraNodeCameraRigEvent TMulticastDelegate_OneParam< void, const FRootCameraNodeCameraRigEvent & >   Core/RootCameraNode.h

Enums

Public

Name Remarks
EBuiltInDoubleCameraVariable Built-in floating point camera variables.
EBuiltInRotator3dCameraVariable  
EBuiltInVector2dCameraVariable Built-in 2-dimensional camera variables.
ECameraAutoRotateDirection Describes the type of auto-rotate.
ECameraBlendStackType Describes a type of blend stack.
ECameraBuildStatus Enumeration that describes if a camera asset needs to be rebuilt.
ECameraContextDataContainerType Supported container types for a camera node's context data.
ECameraContextDataType Supported types for a camera node's context data.
ECameraEvaluationDataCondition  
ECameraNodeFlags Flags describing the needs of a camera node.
ECameraNodeOriginPosition Defines an origin position for a camera node to operate at.
ECameraNodeSpace Defines what space a camera node, or one of its features, should operate in.
ECameraObjectInterfaceParameterType The type of a camera rig parameter.
ECameraRigInitialOrientation Determines how a camera rig's initial orientation should be initialized.
ECameraRigLayer Defines evaluation layers for camera rigs.
ECameraShakeEvaluationMode  
ECameraTargetShape  
ECameraVariableSetterBlendType The blend type for a camera variable setter.
ECameraVariableType The type of a camera variable.
ECollisionSafePosition Specifies how to compute the default safe position for the collision camera node to push towards.
ECollisionSafePositionOffsetSpace Describes the coordinate system in which to offset the collision camera node's safe position.
EGameplayCameraComponentActivationMode Defines how to activate a gameplay camera component.
EGameplayCamerasViewRotationMode Defines how the GameplayCamerasPlayerCameraManager should handle the player's view rotation.
EObjectTreeGraphObjectSupportFlags Flags representing supported optional APIs of an IObjectTreeGraphObject.
ESmoothCameraBlendType The smoothstep type.
UE::Cameras::EBlendStackCameraRigEventType A type of blend stack event.
UE::Cameras::EBuiltInCameraOperationTypes Hard-coded type IDs for built-in camera operations.
UE::Cameras::ECameraArrayChangedEventType The type of change on an array property.
UE::Cameras::ECameraContextDataTableFilter Filter for context data table operations.
UE::Cameras::ECameraDebugBlockBuildVisitFlags  
UE::Cameras::ECameraDebugDrawVisitFlags  
UE::Cameras::ECameraEvaluationServiceFlags Flags for what callbacks an evaluation service wants to opt-into.
UE::Cameras::ECameraNodeEvaluationType The type of evaluation being run.
UE::Cameras::ECameraNodeEvaluatorFlags Flags describing the needs of a camera node evaluator.
UE::Cameras::ECameraRigActivationDeactivationRequestType The type of request for activating or deactivating a camera rig.
UE::Cameras::ECameraSystemEvaluatorRole An enumeration that describes what a camera system evaluator is used for.
UE::Cameras::ECameraVariableTableFilter Filter for variable table operations.
UE::Cameras::ERootCameraNodeCameraRigEventType The type of root node event.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CameraNodeCategories   A camera node that provides a two-dimensional value to an input slot. Nodes/Input/Input2DCameraNode.h  
CameraNodeCategories   A camera node that provides a floating-point value to an input slot. Nodes/Input/Input1DCameraNode.h  
ClassGroup   A component that can run a camera asset inside its own camera evaluation context. GameFramework/GameplayCameraComponent.h  
ClassGroup   A component that can run a camera asset inside its own camera evaluation context. GameFramework/GameplayCameraComponentBase.h  
ClassGroup   A component that can run a camera rig asset inside its own camera evaluation context. GameFramework/GameplayCameraRigComponent.h  
EvaluationContextOwner TObjectPtr< UObject > The owner (if any) of the evaluation context we are running inside of. Directors/BlueprintCameraDirector.h
  • BlueprintReadWrite
  • Category="Evaluation"
  • Meta=(Deprecated, DeprecationMessage="Use the main EvaluationContextOwner parameter on RunCameraDirector")
HideCategories     GameFramework/GameplayCameraComponentBase.h  
meta     GameFramework/GameplayCameraRigComponent.h  
meta     GameFramework/GameplayCameraComponentBase.h  
meta     GameFramework/GameplayCameraComponent.h  
meta   Blueprint wrapper for camera evaluation data. GameFramework/BlueprintCameraEvaluationDataRef.h  
ObjectTreeGraphCategory   Base class for a camera transition condition. Core/CameraRigTransition.h  
ObjectTreeGraphDefaultPropertyPinDirection     Nodes/Input/Input2DCameraNode.h  
ObjectTreeGraphDefaultPropertyPinDirection     Nodes/Input/Input1DCameraNode.h  
ObjectTreeGraphDefaultPropertyPinDirection     Core/CameraRigTransition.h  
ObjectTreeGraphSelfPinDirection     Nodes/Input/Input2DCameraNode.h  
ObjectTreeGraphSelfPinDirection     Nodes/Input/Input1DCameraNode.h  
ObjectTreeGraphSelfPinDirection     Core/CameraRigTransition.h  
STATCAT_Advanced     GameplayCameras.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Core/CameraParameters.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraNode.h  
  Core/CameraRigInstanceID.h  
  Core/ObjectTreeGraphObject.h  
  Core/CameraContextDataTable.h  

bool UE::Cameras::operator! ( FCameraContextDataTable::EEntryFlags E
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

bool UE::Cameras::operator! ( FCameraVariableTable::EEntryFlags E
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags UE::Cameras::operator& ( FCameraContextDataTable::EEntryFlags Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags UE::Cameras::operator& ( FCameraVariableTable::EEntryFlags Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags & UE::Cameras::operator&= ( FCameraContextDataTable::EEntryFlags& Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags & UE::Cameras::operator&= ( FCameraVariableTable::EEntryFlags& Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags UE::Cameras::operator^ ( FCameraContextDataTable::EEntryFlags Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags UE::Cameras::operator^ ( FCameraVariableTable::EEntryFlags Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags & UE::Cameras::operator^= ( FCameraContextDataTable::EEntryFlags& Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags & UE::Cameras::operator^= ( FCameraVariableTable::EEntryFlags& Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags UE::Cameras::operator| ( FCameraContextDataTable::EEntryFlags Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags UE::Cameras::operator| ( FCameraVariableTable::EEntryFlags Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags & UE::Cameras::operator|= ( FCameraContextDataTable::EEntryFlags& Lhs,
FCameraContextDataTable::EEntryFlags Rhs
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags & UE::Cameras::operator|= ( FCameraVariableTable::EEntryFlags& Lhs,
FCameraVariableTable::EEntryFlags Rhs
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  
  Core/CameraContextDataTable.h  

FCameraContextDataTable::EEntryFlags UE::Cameras::operator~ ( FCameraContextDataTable::EEntryFlags E
)

   Core/CameraContextDataTable.h  
  Core/CameraEvaluationService.h  
  Core/CameraNodeEvaluator.h  
  Core/CameraVariableTable.h  

FCameraVariableTable::EEntryFlags UE::Cameras::operator~ ( FCameraVariableTable::EEntryFlags E
)

   Core/CameraVariableTable.h  
  Debug/CameraDebugBlockBuilder.h  
  Debug/CameraDebugRenderer.h  

float UE::Cameras::SmootherStep ( float Value
)

 Smootherstep interpolation Math/Interpolation.h  

float UE::Cameras::SmoothStep ( float Value
)

 Smoothstep interpolation Math/Interpolation.h  

FString UE::Cameras::ToDebugString ( const FieldType& FieldValue
)

 Utility function to print something. Most types have a LexToString implementation, but not all. Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( TEnumAsByte< EnumType > EnumValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const UE::Math::TVector< T >& FieldValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const UE::Math::TVector2< T >& FieldValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const UE::Math::TVector4< T >& FieldValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const UE::Math::TRotator< T >& FieldValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const UE::Math::TTransform< T >& FieldValue
)

   Debug/DebugTextRenderer.h  

FString UE::Cameras::ToDebugString ( const FLinearColor& FieldValue
)

   Debug/DebugTextRenderer.h  
  Debug/DebugTextRenderer.h  
  Debug/DebugTextRenderer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page