1. Epic GamesDeveloper
  3. ULensComponent

ULensComponent

Component for applying a post-process lens distortion effect to a CineCameraComponent on the same actor

API > API/Plugins > API/Plugins/LensComponent

Inheritance Hierarchy

  • UActorComponent
  • ULensComponent

References

   
Module LensComponent
Header /Engine/Plugins/VirtualProduction/LensComponent/Source/LensComponent/Public/LensComponent.h
Include #include "LensComponent.h"

Syntax

UCLASS (HideCategories=(Tags, Activation, Cooking, AssetUserData, Collision),  
       Meta=(BlueprintSpawnableComponent))  
class ULensComponent : public UActorComponent

Remarks

Component for applying a post-process lens distortion effect to a CineCameraComponent on the same actor

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bApplyDistortion Whether or not to apply distortion to the target camera component
Protected variable UProperty Category, EditAnywhere bool bApplyNodalOffsetOnTick If checked, nodal offset will be applied automatically when this component ticks.
Protected variable UProperty bool bIsDistortionSetup Whether a distortion effect is currently being applied to the target camera component
Protected variable UProperty Category, AdvancedDisplay BlueprintReadWrite bool bScaleOverscan Whether to scale the computed overscan by the overscan percentage
Protected variable UProperty Category, EditAnywhere, Meta FCameraFilmbackSettings CroppedFilmback Cropped filmback to use if the filmback override settings are set to use it
Protected variable UProperty Category, EditAnywhere, Interp, Meta FLensDistortionState DistortionState The current distortion state
Protected variable UProperty Category, EditAnywhere, Meta EDistortionSource DistortionStateSource Specifies from where the distortion state information comes
Protected variable UProperty Category, AdvancedDisplay visibleanywhere FLensFileEvaluationInputs EvalInputs Inputs to LensFile evaluation
Protected variable UProperty Category, EditAnywhere EFIZEvaluationMode EvaluationMode Specify how the Lens File should be evaluated
Protected variable UProperty Category, EditAnywhere EFilmbackOverrideSource FilmbackOverride Controls whether this component can override the camera's filmback, and if so, which override to use
Protected variable UProperty TObjectPtr< UCineCameraComponent > LastCameraComponent Cached most recent target camera, used to clean up the old camera when the user changes the target
Protected variable UProperty TObjectPtr< UMaterialInstanceDynamic > LastDistortionMID Cached MID last applied to the target camera
Protected variable UProperty Transient TMap< TSubclassOf< ULensModel >, TObjectPtr< ULensDistortionModelHandlerBase > > LensDistortionHandlerMap Map of lens models to handlers
Protected variable UProperty Category, EditAnywhere, Meta FLensFilePicker LensFilePicker Lens File used to drive distortion with current camera settings
Protected variable UProperty Category, EditAnywhere, Meta TSubclassOf< ULensModel > LensModel The current lens model used for distortion
Protected variable UProperty float OriginalFocalLength Focal length of the target camera before any overscan has been applied
Protected variable UProperty Category, AdvancedDisplay, Interp visibleanywhere FTransform OriginalTrackedComponentTransform Serialized transform of the TrackedComponent prior to nodal offset being applied
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float OverscanMultiplier The percentage of the computed overscan that should be applied to the target camera
Protected variable UProperty Category, AdvancedDisplay, Meta editinstanceonly FComponentReference TargetCameraComponent The CineCameraComponent on which to apply the post-process distortion effect
Protected variable UProperty Transient TWeakObjectPtr< USceneComponent > TrackedComponent Scene component that should have nodal offset applied
Protected variable UProperty FString TrackedComponentName Serialized name of the TrackedComponent, used to determine which component to re-apply nodal offset to in spawnables
Protected variable TWeakObjectPtr< ULensFile > WeakCachedLensFile Weak pointer to the currently set LensFile.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void

ApplyNodalOffset ( USceneComponent* ComponentToOffset,
bool bUseManualInputs,
float ManualFocusInput,
float ManualZoomInput
)

 Manually apply nodal offset to the specified component.
Public function UFunction BlueprintCallable, Category void Reset the distortion state to defaults to represent "no distortion"
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

  
Public function Const UFunction BlueprintPure, Category FCameraFilmbackSettings Get the cropped filmback (only relevant if the filmback override setting is set to use the CroppedFilmback
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGS FDistortionHandlerPicker  
Public function Const UFunction BlueprintPure, Category EDistortionSource Get the distortion source setting
Public function Const UFunction BlueprintPure, Category FLensDistortionState Get the current distortion state
Public function Const UFunction BlueprintPure, Category EFilmbackOverrideSource Get the filmback override setting
Public function Const UFunction BlueprintPure, Category, Meta EFIZEvaluationMode Get the evaluation mode used to evaluate the LensFile
Public function Const UFunction BlueprintCallable, Category ULensDistortionModelHandlerBase * Returns the LensDistortionHandler in use for the current LensModel
Public function Const UFunction BlueprintPure, Category ULensFile * Get the LensFile used by this component
Public function Const UFunction BlueprintPure, Category const FLensFileEvaluationInputs & Get the data used by this component to evaluate the LensFile
Public function Const UFunction BlueprintPure, Category FLensFilePicker Get the LensFile picker used by this component
Public function Const UFunction BlueprintPure, Category TSubclassOf< ULensModel > Get the current lens model
Public function Const UFunction BlueprintPure, Category float Get the original (not adjusted for overscan) focal length of the camera
Public function Const UFunction BlueprintPure, Category float Get the evaluation mode used to evaluate the LensFile
Public function FOnLensComponentModelChanged & Returns the delegate that is triggered when the LensModel changes
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function void Reset the tracked component back to its original tracked pose and reapply nodal offset to it by re-evaluating the LensFile
Public function UFunction BlueprintCallable, Category void

SetApplyDistortion ( bool bApply
)

 Set whether distortion should be applied to the target camera
Public function UFunction BlueprintCallable, Category void

SetApplyNodalOffsetOnTick ( bool bApplyNodalOffset
)

 Set whether nodal offset should be automatically applied during this component's tick
Public function UFunction BlueprintCallable, Category void Set the cropped filmback (only relevant if the filmback override setting is set to use the CroppedFilmback
Public function UFunction BlueprintCallable, Category void Set the distortion source setting
Public function UFunction BlueprintCallable, Category void Set the current distortion state
Public function UFunction BlueprintCallable, Category void Set the filmback override setting
Public function UFunction BlueprintCallable, Category, Meta void Set the evaluation mode used to evaluate the LensFile
Public function UFunction BlueprintCallable, Category void

SetLensFile ( ULensFile* LensFile
)

 Set the LensFile used by this component
Public function UFunction BlueprintCallable, Category void Set the LensFile picker used by this component
Public function UFunction BlueprintCallable, Category void Set the current lens model
Public function UFunction BlueprintCallable, Category void

SetOverscanMultiplier ( float Multiplier
)

 Set the LensFile used by this component
Public function Const UFunction BlueprintPure, Category bool Whether distortion should be applied to the target camera
Public function Const UFunction BlueprintPure, Category bool Returns true if nodal offset will be automatically applied during this component's tick, false otherwise
Public function Virtual void

TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Public function Const UFunction BlueprintPure, Category bool Returns true if distortion was evaluated this tick
Public function Const UFunction BlueprintPure, Category bool Returns true if nodal offset was applied during the current tick, false otherwise

Deprecated Variables

  Type Name Description
Protected variable UProperty Meta PRAGMA_DISABLE_DEPRECATION_WARNINGS FDistortionHandlerPicker DistortionSource_DEPRECATED  
Protected variable UProperty FVector OriginalCameraLocation_DEPRECATED  
Protected variable UProperty FRotator OriginalCameraRotation_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page