1. Epic GamesDeveloper
  3. UCameraModifier

UCameraModifier

A CameraModifier is a base class for objects that may adjust the final camera properties after being computed by the [APlayerCameraManager](API\Runtime\Engine\APlayerCameraManager) (

API > API/Runtime > API/Runtime/Engine

A CameraModifier is a base class for objects that may adjust the final camera properties after being computed by the APlayerCameraManager (

   
Name UCameraModifier
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Camera/CameraModifier.h
Include Path #include "Camera/CameraModifier.h"

Syntax

UCLASS (BlueprintType, Blueprintable, MinimalAPI)  
class UCameraModifier : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCameraModifier ( const FObjectInitializer& ObjectInitializer
)

   Camera/CameraModifier.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDebug uint32 If true, enables certain debug visualization features. Camera/CameraModifier.h
  • EditAnywhere
  • Category=Debug
bExclusive uint32 If true, no other modifiers of same priority allowed. Camera/CameraModifier.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category=CameraModifier
Priority uint8 Priority value that determines the order in which modifiers are applied. Camera/CameraModifier.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category=CameraModifier

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddedToCamera ( APlayerCameraManager* Camera
)

 Allows any custom initialization. Called immediately after creation. Camera/CameraModifier.h  

void BlueprintModifyCamera ( float DeltaTime,
FVector ViewLocation,
FRotator ViewRotation,
float FOV,
FVector& NewViewLocation,
FRotator& NewViewRotation,
float& NewFOV
)

 Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's transform. Camera/CameraModifier.h
  • BlueprintImplementableEvent
  • BlueprintCosmetic

void BlueprintModifyPostProcess ( float DeltaTime,
float& PostProcessBlendWeight,
FPostProcessSettings& PostProcessSettings
)

 Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's postprocess effects. Camera/CameraModifier.h
  • BlueprintImplementableEvent
  • BlueprintCosmetic

virtual void DisableModifier ( bool bImmediate
)

 Disables this modifier. Camera/CameraModifier.h
  • BlueprintCallable
  • Category=CameraModifier

virtual void DisplayDebug ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay,
float& YL,
float& YPos
)

 Allows camera modifiers to output debug text during "showdebug camera" Camera/CameraModifier.h  

virtual void EnableModifier()

 Enables this modifier. Camera/CameraModifier.h
  • BlueprintCallable
  • Category=CameraModifier

virtual AActor * GetViewTarget()

   Camera/CameraModifier.h
  • BlueprintCallable
  • Category=CameraModifier

UWorld * GetWorld()

   Camera/CameraModifier.h  

virtual bool IsDisabled()

   Camera/CameraModifier.h
  • BlueprintCallable
  • Category=CameraModifier

virtual bool IsPendingDisable()

   Camera/CameraModifier.h
  • BlueprintCallable
  • Category=CameraModifier

virtual bool ModifyCamera ( float DeltaTime,
FMinimalViewInfo& InOutPOV
)

 Directly modifies variables in the owning camera Camera/CameraModifier.h  

virtual bool ProcessViewRotation ( AActor* ViewTarget,
float DeltaTime,
FRotator& OutViewRotation,
FRotator& OutDeltaRot
)

 Called to give modifiers a chance to adjust view rotation updates before they are applied. Camera/CameraModifier.h  

virtual void ToggleModifier()

 Toggled disabled/enabled state of this modifier. Camera/CameraModifier.h  

virtual void UpdateAlpha ( float DeltaTime
)

 Responsible for updating alpha blend value. Camera/CameraModifier.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual float GetTargetAlpha()

   Camera/CameraModifier.h  

virtual void ModifyCamera ( float DeltaTime,
FVector ViewLocation,
FRotator ViewRotation,
float FOV,
FVector& NewViewLocation,
FRotator& NewViewRotation,
float& NewFOV
)

 Allows modifying the camera in native code. Camera/CameraModifier.h  

virtual void ModifyPostProcess ( float DeltaTime,
float& PostProcessBlendWeight,
FPostProcessSettings& PostProcessSettings
)

 Allows modifying the post process in native code. Camera/CameraModifier.h  

void OnCameraOwnerDestroyed ( AActor* InOwner
)

   Camera/CameraModifier.h  

See Also

  • ModifyCamera). A CameraModifier can be stateful

  • and is associated uniquely with a specific APlayerCameraManager.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page