Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CameraCalibration > ULensDistortionComponent

Light Theme

Dark Theme

ULensDistortionComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

ULensDistortionComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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
bool	bApplyDistortion	Whether or not to apply distortion to the target camera component
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
bool	bIsDistortionSetup	Whether a distortion effect is currently being applied to the target camera component
FGuid	DistortionProducerID	Unique identifier representing the source of distortion data
FDistortionHand...	DistortionSource	Structure used to query the camera calibration subsystem for a lens distortion model handler
UCineCameraComp...	LastCameraComponent	Cached most recent target camera, used to clean up the old camera when the user changes the target
UMaterialInstan...	LastDistortionMID	Cached MID last applied to the target camera
FLensFilePicker	LensFilePicker	Lens File used to drive distortion with current camera settings
float	OriginalFocalLength	Focal length of the target camera before any overscan has been applied
ULensDistortion...	ProducedLensDistortionHandler	Distortion handler produced by this component
FComponentRefer...	TargetCameraComponent	The CineCameraComponent on which to apply the post-process distortion effect

Constructors

	Name	Description
	ULensDistortionComponent()

Overridden from UActorComponent

	Name	Description
void	DestroyComponent ( bool bPromoteChildren )	Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	TickComponent ( float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

	Name	Description
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss