ULensDistortionComponent

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CameraCalibration

Header

/Engine/Plugins/VirtualProduction/CameraCalibration/Source/CameraCalibration/Public/LensDistortionComponent.h

Include

#include "LensDistortionComponent.h"

Syntax

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

Remarks

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

Variables

Name Description

Protected variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bApplyDistortion

Whether or not to apply distortion to the target camera component

Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta

bool

 

bApplyNodalOffset

Whether to apply nodal offset to the target camera

Protected variable UProperty Category, EditAnywhere, AdvancedDisplay

bool

 

bEvaluateLensFileForDistortion

Whether to use the specified lens file to drive distortion Enabling this will create a new distortion source and automatically set this component to use it

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 duplicatetransient

FGuid

 

DistortionProducerID

Unique identifier representing the source of distortion data

Protected variable UProperty Category, EditAnywhere BlueprintReadWrite

FDistortionHand...

 

DistortionSource

Structure used to query the camera calibration subsystem for a lens distortion model handler

Protected variable UProperty Transient

UCineCameraComp...

 

LastCameraComponent

Cached most recent target camera, used to clean up the old camera when the user changes the target

Protected variable UProperty

UMaterialInstan...

 

LastDistortionMID

Cached MID last applied to the target camera

Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta

FLensFilePicker

 

LensFilePicker

Lens File used to drive distortion with current camera settings

Protected variable UProperty

FVector

 

OriginalCameraLocation

Original camera location to reset before/after applying nodal offset

Protected variable UProperty

FRotator

 

OriginalCameraRotation

Original camera rotation to reset before/after applying nodal offset

Protected variable UProperty

float

 

OriginalFocalLength

Focal length of the target camera before any overscan has been 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 Transient

ULensDistortion...

 

ProducedLensDistortionHandler

Distortion handler produced by this component

Protected variable UProperty Category, Meta editinstanceonly

FComponentRefer...

 

TargetCameraComponent

The CineCameraComponent on which to apply the post-process distortion effect

Constructors

Name Description

Public function

ULensDistortionComponent()

Functions

Name Description

Protected function

void

 

OnPostActorTick

(
    UWorld* World,
    ELevelTick TickType,
    float DeltaSeconds
)

Verify base transform and apply nodal offset on top of everything else done in tick

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

DestroyComponent

(
    bool bPromoteChildren
)

Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Function called every frame on this ActorComponent.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostDuplicate

(
    bool bDuplicateForPIE
)

Called after duplication & serialization and before PostLoad.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.