ICameraLensEffectInterface Class Reference

#include <CameraLensEffectInterface.h>

Inheritance diagram for ICameraLensEffectInterface:

Public Member Functions
virtual ENGINE_API TArray< UFXSystemComponent * >	GetParticleComponents () const
virtual ENGINE_API UFXSystemComponent *	GetPrimaryParticleComponent () const
virtual const FTransform &	GetRelativeTransform () const =0
virtual float	GetBaseFOV () const =0
virtual bool	ShouldAllowMultipleInstances () const =0
virtual bool	ResetWhenTriggered () const =0
virtual void	NotifyWillBePooled ()
virtual bool	ShouldTreatEmitterAsSame (TSubclassOf< AActor > OtherEmitter) const =0
virtual void	RegisterCamera (APlayerCameraManager *CameraManager)=0
virtual void	NotifyRetriggered ()=0
virtual void	ActivateLensEffect ()=0
virtual void	DeactivateLensEffect ()=0
virtual ENGINE_API void	UpdateLocation (const FVector &CamLoc, const FRotator &CamRot, float CamFOVDeg)
virtual void	AdjustBaseFOV (float NewFOV)=0
virtual bool	IsLooping () const =0

Static Public Member Functions
static ENGINE_API FTransform	GetAttachedEmitterTransform (const AActor *Emitter, const FVector &CamLoc, const FRotator &CamRot, float CamFOVDeg)

Member Function Documentation

ActivateLensEffect()

virtual void ICameraLensEffectInterface::ActivateLensEffect ( )

pure virtual

This will actually activate the lens Effect. We want this separated from PostInitializeComponents so we can cache these emitters

Implemented in AEmitterCameraLensEffectBase.

AdjustBaseFOV()

virtual void ICameraLensEffectInterface::AdjustBaseFOV ( float  NewFOV )

pure virtual

Implemented in AEmitterCameraLensEffectBase.

DeactivateLensEffect()

virtual void ICameraLensEffectInterface::DeactivateLensEffect ( )

pure virtual

Deactivtes the particle system. If bDestroyOnSystemFinish is true, actor will die after particles are all dead.

Implemented in AEmitterCameraLensEffectBase.

GetAttachedEmitterTransform()

FTransform ICameraLensEffectInterface::GetAttachedEmitterTransform ( const AActor *  Emitter, const FVector &  CamLoc, const FRotator &  CamRot, float  CamFOVDeg  )

static

GetBaseFOV()

virtual float ICameraLensEffectInterface::GetBaseFOV ( ) const

pure virtual

Implemented in AEmitterCameraLensEffectBase.

GetParticleComponents()

TArray< UFXSystemComponent * > ICameraLensEffectInterface::GetParticleComponents ( ) const

virtual

GetPrimaryParticleComponent()

UFXSystemComponent * ICameraLensEffectInterface::GetPrimaryParticleComponent ( ) const

virtual

GetRelativeTransform()

virtual const FTransform & ICameraLensEffectInterface::GetRelativeTransform ( ) const

pure virtual

Implemented in AEmitterCameraLensEffectBase.

IsLooping()

virtual bool ICameraLensEffectInterface::IsLooping ( ) const

pure virtual

Returns true if any associated particle system is set to looping

Implemented in AEmitterCameraLensEffectBase.

NotifyRetriggered()

virtual void ICameraLensEffectInterface::NotifyRetriggered ( )

pure virtual

Called when this emitter is re-triggered, for bAllowMultipleInstances=false emitters.

Implemented in AEmitterCameraLensEffectBase.

NotifyWillBePooled()

virtual void ICameraLensEffectInterface::NotifyWillBePooled ( )

inlinevirtual

If this type needs to handle being pooled, override this function

Reimplemented in AEmitterCameraLensEffectBase.

RegisterCamera()

virtual void ICameraLensEffectInterface::RegisterCamera ( APlayerCameraManager *  CameraManager )

pure virtual

Called when being added to the player camera manager. Typically happens before PreInitializeComponents (when handled from PlayerCameraManager).

Implemented in AEmitterCameraLensEffectBase.

ResetWhenTriggered()

virtual bool ICameraLensEffectInterface::ResetWhenTriggered ( ) const

pure virtual

Implemented in AEmitterCameraLensEffectBase.

ShouldAllowMultipleInstances()

virtual bool ICameraLensEffectInterface::ShouldAllowMultipleInstances ( ) const

pure virtual

Implemented in AEmitterCameraLensEffectBase.

ShouldTreatEmitterAsSame()

virtual bool ICameraLensEffectInterface::ShouldTreatEmitterAsSame ( TSubclassOf< AActor >  OtherEmitter ) const

pure virtual

Is this emitter functionally equivalent to the class OtherEmitter?

Implemented in AEmitterCameraLensEffectBase.

UpdateLocation()

void ICameraLensEffectInterface::UpdateLocation ( const FVector &  CamLoc, const FRotator &  CamRot, float  CamFOVDeg  )

virtual

Given updated camera information, adjust this effect to display appropriately.

Reimplemented in AEmitterCameraLensEffectBase.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Camera/CameraLensEffectInterface.h
• Engine/Source/Runtime/Engine/Private/Camera/CameraLensEffectInterface.cpp