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

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

   
Name ULensComponent
Type class
Header File /Engine/Plugins/VirtualProduction/LensComponent/Source/LensComponent/Public/LensComponent.h
Include Path #include "LensComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ULensComponent()

   LensComponent.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bWasDistortionEvaluated bool Whether distortion was evaluated this tick LensComponent.h  
bWasLiveLinkFIZUpdated bool Whether LiveLink FIZ was received this tick LensComponent.h  
bWasNodalOffsetAppliedThisTick bool Whether or not nodal offset was applied to a tracked component this tick LensComponent.h  
FLensComponentDetailCustomization friend   LensComponent.h  
LastFocalLength float Latest focal length of the target camera, used to track external changes to the original (no overscan applied) focal length LensComponent.h  
LiveLinkFocus float Latest LiveLink FIZ data, used to evaluate the LensFile LensComponent.h  
LiveLinkIris float   LensComponent.h  
LiveLinkZoom float   LensComponent.h  
OnLensComponentModelChangedDelegate FOnLensComponentModelChanged Delegate that is triggered when the LensModel changes LensComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Manually apply nodal offset to the specified component. LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"
  • Meta=(AdvancedDisplay=1)

void ClearDistortionState()

 Reset the distortion state to defaults to represent "no distortion" LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

FCameraFilmbackSettings GetCroppedFilmback()

 Get the cropped filmback (only relevant if the filmback override setting is set to use the CroppedFilmback LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

PRAGMA_DISABLE_DEPRECATION_WARNINGS FDistortionHandlerPicker GetDistortionHandlerPicker()

   LensComponent.h  

EDistortionSource GetDistortionSource()

 Get the distortion source setting LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

FLensDistortionState GetDistortionState()

 Get the current distortion state LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

EFilmbackOverrideSource GetFilmbackOverrideSetting()

 Get the filmback override setting LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

EFIZEvaluationMode GetFIZEvaluationMode()

 Get the evaluation mode used to evaluate the LensFile LensComponent.h
  • BlueprintPure
  • Category="Lens Component"
  • Meta=(DisplayName="Get FIZ Evaluation Mode")

ULensDistortionModelHandlerBase * GetLensDistortionHandler()

 Returns the LensDistortionHandler in use for the current LensModel LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

ULensFile * GetLensFile()

 Get the LensFile used by this component LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

const FLensFileEvaluationInputs & GetLensFileEvaluationInputs()

 Get the data used by this component to evaluate the LensFile LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

FLensFilePicker GetLensFilePicker()

 Get the LensFile picker used by this component LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

TSubclassOf< ULensModel > GetLensModel()

 Get the current lens model LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

float GetOriginalFocalLength()

 Get the original (not adjusted for overscan) focal length of the camera LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

float GetOverscanMultiplier()

 Get the evaluation mode used to evaluate the LensFile LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

FOnLensComponentModelChanged & OnLensComponentModelChanged()

 Returns the delegate that is triggered when the LensModel changes LensComponent.h  

void ReapplyNodalOffset()

 Reset the tracked component back to its original tracked pose and reapply nodal offset to it by re-evaluating the LensFile LensComponent.h  

void SetApplyDistortion ( bool bApply
)

 Set whether distortion should be applied to the target camera LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetApplyNodalOffsetOnTick ( bool bApplyNodalOffset
)

 Set whether nodal offset should be automatically applied during this component's tick LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetCroppedFilmback ( FCameraFilmbackSettings Filmback
)

 Set the cropped filmback (only relevant if the filmback override setting is set to use the CroppedFilmback LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetDistortionSource ( EDistortionSource Source
)

 Set the distortion source setting LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetDistortionState ( FLensDistortionState State
)

 Set the current distortion state LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetFilmbackOverrideSetting ( EFilmbackOverrideSource Setting
)

 Set the filmback override setting LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetFIZEvaluationMode ( EFIZEvaluationMode Mode
)

 Set the evaluation mode used to evaluate the LensFile LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"
  • Meta=(DisplayName="Set FIZ Evaluation Mode")

void SetLensFile ( ULensFile* LensFile
)

 Set the LensFile used by this component LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetLensFileEvaluationInputs ( float InFocus,
float InZoom
)

 Set the data used by this component to evaluate the LensFile LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetLensFilePicker ( FLensFilePicker LensFile
)

 Set the LensFile picker used by this component LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetLensModel ( TSubclassOf< ULensModel > Model
)

 Set the current lens model LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

void SetOverscanMultiplier ( float Multiplier
)

 Set the LensFile used by this component LensComponent.h
  • BlueprintCallable
  • Category="Lens Component"

bool ShouldApplyDistortion()

 Whether distortion should be applied to the target camera LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

bool ShouldApplyNodalOffsetOnTick()

 Returns true if nodal offset will be automatically applied during this component's tick, false otherwise LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

bool WasDistortionEvaluated()

 Returns true if distortion was evaluated this tick LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

bool WasNodalOffsetAppliedThisTick()

 Returns true if nodal offset was applied during the current tick, false otherwise LensComponent.h
  • BlueprintPure
  • Category="Lens Component"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void DestroyComponent ( bool bPromoteChildren
)

   LensComponent.h  

virtual void OnRegister()

   LensComponent.h  

virtual void OnUnregister()

   LensComponent.h  

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

   LensComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   LensComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   LensComponent.h  

virtual void PostEditImport()

   LensComponent.h  

virtual void PostLoad()

   LensComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DistortionSource_DEPRECATED PRAGMA_DISABLE_DEPRECATION_WARNINGS FDistortionHandlerPicker   LensComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="This property has been deprecated. Use GetDistortionSource() and SetDistortionSource() instead.")
OriginalCameraLocation_DEPRECATED FVector   LensComponent.h  
OriginalCameraRotation_DEPRECATED FRotator   LensComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page