APatternWarningDecalActor 클래스 참조

#include <PatternWarningDecalActor.h>

APatternWarningDecalActor에 대한 상속 다이어그램 :

APatternWarningDecalActor에 대한 협력 다이어그램:

Public 멤버 함수
	APatternWarningDecalActor ()
virtual void	Tick (float DeltaSeconds) override
bool	StartCircleWarningAttached (USceneComponent *AttachParent, const FVector &LocalOffset, float WarningDuration, float FinalRadius, const FPatternWarningDecalSettings &Settings)
bool	StartCircleWarningAtTransform (const FTransform &WorldTransform, float WarningDuration, float FinalRadius, const FPatternWarningDecalSettings &Settings)
bool	StartLineWarningAttached (USceneComponent *AttachParent, const FPatternLineWarningDecalSettings &Settings)
void	SetLineLengthRatio (float LengthRatio) const
void	StopWarning ()
void	CancelWarning ()
void	ReturnToPoolImmediately ()
IObjectPoolingInterface(으)로부터 상속된 Public 멤버 함수
void	OnSpawnFromPool ()
void	OnReturnToPool ()

Protected 멤버 함수
virtual void	OnSpawnFromPool_Implementation () override
virtual void	OnReturnToPool_Implementation () override

Protected 속성
TObjectPtr< USceneComponent >	SceneRootComponent
TObjectPtr< UDecalComponent >	MaxRangeDecalComponent
TObjectPtr< UDecalComponent >	FillDecalComponent

Private 멤버 함수
bool	StartCircleProgress ()
bool	CreateCircleWarningDecals (const FPatternWarningDecalSettings &Settings)
bool	CreateLineWarningDecals (const FPatternLineWarningDecalSettings &Settings)
bool	ConfigureDecalComponent (UDecalComponent *DecalComponent, UMaterialInterface *DecalMaterial, const FVector &DecalSize, int32 SortOrder, float FadeInDuration) const
void	BeginStopWarning (bool bCompleteProgress)
void	ApplyFadeOut (UDecalComponent *DecalComponent, float FadeOutDuration) const
void	UpdateCircleProgress ()
void	UpdateCircleWarning (float Alpha) const
void	ResetRuntimeState ()
void	ResetDecalComponent (UDecalComponent *DecalComponent) const

Private 속성
FVector	CurrentLineStartLocation = FVector::ZeroVector
float	WarningStartTime = 0.0f
float	CurrentWarningDuration = 0.0f
float	CurrentFadeOutDuration = 0.0f
float	CurrentLineLength = 0.0f
float	CurrentCircleStartRadius = 0.0f
float	CurrentCircleFinalRadius = 0.0f
bool	bIsFadingOut = false
EPatternWarningDecalShape	CurrentWarningShape = EPatternWarningDecalShape::None
FTimerHandle	ReturnToPoolTimerHandle

생성자 & 소멸자 문서화

APatternWarningDecalActor()

APatternWarningDecalActor::APatternWarningDecalActor

(

)

{
    PrimaryActorTick.bCanEverTick = true;
    PrimaryActorTick.bStartWithTickEnabled = false;
 
    SceneRootComponent = CreateDefaultSubobject<USceneComponent>(TEXT("SceneRootComponent"));
    SetRootComponent(SceneRootComponent);
 
    MaxRangeDecalComponent = CreateDefaultSubobject<UDecalComponent>(TEXT("MaxRangeDecalComponent"));
    MaxRangeDecalComponent->SetupAttachment(SceneRootComponent);
    MaxRangeDecalComponent->SetVisibility(false);
 
    FillDecalComponent = CreateDefaultSubobject<UDecalComponent>(TEXT("FillDecalComponent"));
    FillDecalComponent->SetupAttachment(SceneRootComponent);
    FillDecalComponent->SetVisibility(false);
}

멤버 함수 문서화

ApplyFadeOut()

void APatternWarningDecalActor::ApplyFadeOut ( UDecalComponent *  DecalComponent, float  FadeOutDuration  ) const

private

{
    if (IsValid(DecalComponent) == false || DecalComponent->IsVisible() == false)
    {
        return;
    }
 
    DecalComponent->SetFadeOut(0.0f, FadeOutDuration, false);
    DecalComponent->SetLifeSpan(0.0f); // 풀링 재사용을 위해 엔진의 자동 파괴 타이머를 해제합니다.
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

BeginStopWarning()

void APatternWarningDecalActor::BeginStopWarning ( bool  bCompleteProgress )

private

{
    if (CurrentWarningShape == EPatternWarningDecalShape::None || bIsFadingOut)
    {
        return;
    }
 
    if (bCompleteProgress && CurrentWarningShape == EPatternWarningDecalShape::Circle)
    {
        UpdateCircleWarning(1.0f);
    }
 
    SetActorTickEnabled(false);
    DetachFromActor(FDetachmentTransformRules::KeepWorldTransform);
 
    const float FadeOutDuration = FMath::Max(CurrentFadeOutDuration, 0.0f);
    if (FadeOutDuration <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return;
    }
 
    bIsFadingOut = true;
    ApplyFadeOut(MaxRangeDecalComponent, FadeOutDuration);
    ApplyFadeOut(FillDecalComponent, FadeOutDuration);
    GetWorldTimerManager().SetTimer(ReturnToPoolTimerHandle, this, &ThisClass::ReturnToPoolImmediately, FadeOutDuration, false);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

CancelWarning()

void APatternWarningDecalActor::CancelWarning

(

)

{
    BeginStopWarning(false);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

ConfigureDecalComponent()

bool APatternWarningDecalActor::ConfigureDecalComponent ( UDecalComponent *  DecalComponent, UMaterialInterface *  DecalMaterial, const FVector &  DecalSize, int32  SortOrder, float  FadeInDuration  ) const

private

{
    if (IsValid(DecalComponent) == false)
    {
        return false;
    }
 
    ResetDecalComponent(DecalComponent);
    if (IsValid(DecalMaterial) == false)
    {
        return false;
    }
 
    DecalComponent->DecalSize = DecalSize;
    DecalComponent->SetDecalMaterial(DecalMaterial);
    DecalComponent->SetSortOrder(SortOrder);
    DecalComponent->SetFadeIn(0.0f, FMath::Max(FadeInDuration, 0.0f));
    DecalComponent->SetVisibility(true);
    DecalComponent->MarkRenderStateDirty();
    return true;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

CreateCircleWarningDecals()

bool APatternWarningDecalActor::CreateCircleWarningDecals ( const FPatternWarningDecalSettings &  Settings )

private

{
    UMaterialInterface* MaxRangeDecalMaterial = Settings.MaxRangeDecalMaterial.Get();
    UMaterialInterface* FillDecalMaterial = Settings.FillDecalMaterial.Get();
    if (IsValid(MaxRangeDecalMaterial) == false && IsValid(FillDecalMaterial) == false)
    {
        return false;
    }
 
    const float FinalRadius = CurrentCircleFinalRadius;
    const float DecalDepth = FMath::Max(Settings.DecalDepth, 0.0f);
    const FVector DecalSize(DecalDepth, FinalRadius, FinalRadius);
 
    const bool bHasMaxRangeDecal = ConfigureDecalComponent(MaxRangeDecalComponent, MaxRangeDecalMaterial, DecalSize, 1, Settings.FadeInDuration);
    const bool bHasFillDecal = ConfigureDecalComponent(FillDecalComponent, FillDecalMaterial, DecalSize, 0, Settings.FadeInDuration);
 
    if (bHasFillDecal)
    {
        const float InitialScale = FMath::Max(CurrentCircleStartRadius, 0.0f) / FinalRadius;
        FillDecalComponent->SetRelativeScale3D(FVector(1.0f, InitialScale, InitialScale));
    }
 
    return bHasMaxRangeDecal || bHasFillDecal;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

CreateLineWarningDecals()

bool APatternWarningDecalActor::CreateLineWarningDecals ( const FPatternLineWarningDecalSettings &  Settings )

private

{
    UMaterialInterface* MaxRangeDecalMaterial = Settings.MaxRangeDecalMaterial.Get();
    UMaterialInterface* FillDecalMaterial = Settings.FillDecalMaterial.Get();
    if (IsValid(MaxRangeDecalMaterial) == false && IsValid(FillDecalMaterial) == false)
    {
        return false;
    }
 
    const float HalfLength = CurrentLineLength * 0.5f;
    const float HalfWidth = Settings.GetWidth() * 0.5f;
    const float DecalDepth = FMath::Max(Settings.DecalDepth, 0.0f);
    const FVector DecalSize(DecalDepth, HalfLength, HalfWidth);
 
    const bool bHasMaxRangeDecal = ConfigureDecalComponent(MaxRangeDecalComponent, MaxRangeDecalMaterial, DecalSize, 1, Settings.FadeInDuration);
    const bool bHasFillDecal = ConfigureDecalComponent(FillDecalComponent, FillDecalMaterial, DecalSize, 0, Settings.FadeInDuration);
 
    return bHasMaxRangeDecal || bHasFillDecal;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

OnReturnToPool_Implementation()

void APatternWarningDecalActor::OnReturnToPool_Implementation ( )

overrideprotectedvirtual

IObjectPoolingInterface(으)로부터 재구현되었습니다.

{
    ResetRuntimeState();
    IObjectPoolingInterface::OnReturnToPool_Implementation();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

OnSpawnFromPool_Implementation()

void APatternWarningDecalActor::OnSpawnFromPool_Implementation ( )

overrideprotectedvirtual

IObjectPoolingInterface(으)로부터 재구현되었습니다.

{
    IObjectPoolingInterface::OnSpawnFromPool_Implementation();
    ResetRuntimeState();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

ResetDecalComponent()

void APatternWarningDecalActor::ResetDecalComponent ( UDecalComponent *  DecalComponent ) const

private

{
    if (IsValid(DecalComponent) == false)
    {
        return;
    }
 
    DecalComponent->SetFadeOut(0.0f, 0.0f, false);
    DecalComponent->SetFadeIn(0.0f, 0.0f);
    DecalComponent->SetDecalMaterial(nullptr);
    DecalComponent->DecalSize = FVector::OneVector;
    DecalComponent->SetRelativeTransform(FTransform::Identity);
    DecalComponent->SetVisibility(false);
    DecalComponent->MarkRenderStateDirty();
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

ResetRuntimeState()

void APatternWarningDecalActor::ResetRuntimeState ( )

private

{
    SetActorTickEnabled(false);
    GetWorldTimerManager().ClearTimer(ReturnToPoolTimerHandle);
    DetachFromActor(FDetachmentTransformRules::KeepWorldTransform);
    SetActorTransform(FTransform::Identity);
 
    ResetDecalComponent(MaxRangeDecalComponent);
    ResetDecalComponent(FillDecalComponent);
 
    CurrentLineStartLocation = FVector::ZeroVector;
    WarningStartTime = 0.0f;
    CurrentWarningDuration = 0.0f;
    CurrentFadeOutDuration = 0.0f;
    CurrentLineLength = 0.0f;
    CurrentCircleStartRadius = 0.0f;
    CurrentCircleFinalRadius = 0.0f;
    bIsFadingOut = false;
    CurrentWarningShape = EPatternWarningDecalShape::None;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

ReturnToPoolImmediately()

void APatternWarningDecalActor::ReturnToPoolImmediately

(

)

{
    SetActorTickEnabled(false);
 
    UWorld* World = GetWorld();
    if (IsValid(World))
    {
        World->GetTimerManager().ClearTimer(ReturnToPoolTimerHandle);
    }
 
    UPoolWorldSubsystem* PoolSubsystem = IsValid(World) ? World->GetSubsystem<UPoolWorldSubsystem>() : nullptr;
    if (IsValid(PoolSubsystem))
    {
        PoolSubsystem->ReturnActorToPool(this);
        return;
    }
 
    ResetRuntimeState();
    SetActorHiddenInGame(true);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

SetLineLengthRatio()

void APatternWarningDecalActor::SetLineLengthRatio

(

float

LengthRatio

)

const

{
    if (CurrentWarningShape != EPatternWarningDecalShape::Line)
    {
        return;
    }
 
    const float ClampedLengthRatio = FMath::Clamp(LengthRatio, 0.0f, 1.0f);
    const float VisibleHalfLength = CurrentLineLength * ClampedLengthRatio * 0.5f;
    const FVector DecalLocation = CurrentLineStartLocation + FVector::ForwardVector * VisibleHalfLength;
    const FVector DecalScale(1.0f, ClampedLengthRatio, 1.0f);
 
    SceneRootComponent->SetRelativeLocation(DecalLocation);
 
    if (IsValid(MaxRangeDecalComponent))
    {
        MaxRangeDecalComponent->SetRelativeScale3D(DecalScale);
    }
 
    if (IsValid(FillDecalComponent))
    {
        FillDecalComponent->SetRelativeScale3D(DecalScale);
    }
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

StartCircleProgress()

bool APatternWarningDecalActor::StartCircleProgress ( )

private

{
    UWorld* World = GetWorld();
    if (IsValid(World) == false || CurrentWarningDuration <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    WarningStartTime = World->GetTimeSeconds();
    UpdateCircleProgress();
    SetActorTickEnabled(true);
    return true;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

StartCircleWarningAttached()

bool APatternWarningDecalActor::StartCircleWarningAttached	(	USceneComponent *	AttachParent,
		const FVector &	LocalOffset,
		float	WarningDuration,
		float	FinalRadius,
		const FPatternWarningDecalSettings &	Settings
	)

{
    if (IsValid(AttachParent) == false || WarningDuration <= KINDA_SMALL_NUMBER || FinalRadius <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    CurrentWarningDuration = WarningDuration;
    CurrentFadeOutDuration = Settings.FadeOutDuration;
    CurrentCircleStartRadius = Settings.StartRadius;
    CurrentCircleFinalRadius = FinalRadius;
    CurrentWarningShape = EPatternWarningDecalShape::Circle;
 
    AttachToComponent(AttachParent, FAttachmentTransformRules::KeepRelativeTransform);
    SceneRootComponent->SetRelativeLocationAndRotation(LocalOffset, FRotator(-90.0f, 0.0f, 0.0f));
 
    if (CreateCircleWarningDecals(Settings) == false)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    return StartCircleProgress();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

StartCircleWarningAtTransform()

bool APatternWarningDecalActor::StartCircleWarningAtTransform	(	const FTransform &	WorldTransform,
		float	WarningDuration,
		float	FinalRadius,
		const FPatternWarningDecalSettings &	Settings
	)

{
    if (WarningDuration <= KINDA_SMALL_NUMBER || FinalRadius <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    CurrentWarningDuration = WarningDuration;
    CurrentFadeOutDuration = Settings.FadeOutDuration;
    CurrentCircleStartRadius = Settings.StartRadius;
    CurrentCircleFinalRadius = FinalRadius;
    CurrentWarningShape = EPatternWarningDecalShape::Circle;
 
    const FRotator WarningRotation = WorldTransform.GetRotation().Rotator();
    SetActorLocationAndRotation(WorldTransform.GetLocation(), FRotator(-90.0f, WarningRotation.Yaw, 0.0f));
 
    if (CreateCircleWarningDecals(Settings) == false)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    return StartCircleProgress();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

StartLineWarningAttached()

bool APatternWarningDecalActor::StartLineWarningAttached	(	USceneComponent *	AttachParent,
		const FPatternLineWarningDecalSettings &	Settings
	)

{
    if (IsValid(AttachParent) == false || Settings.GetLength() <= KINDA_SMALL_NUMBER || Settings.GetWidth() <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    CurrentLineStartLocation = Settings.GetLocalStartLocation();
    CurrentFadeOutDuration = Settings.FadeOutDuration;
    CurrentLineLength = Settings.GetLength();
    CurrentWarningShape = EPatternWarningDecalShape::Line;
 
    // 데칼의 위치는 텍스쳐의 중앙에 위치해야 하기에
    const float HalfLength = CurrentLineLength * 0.5f;
    const FVector DecalLocation = CurrentLineStartLocation + FVector::ForwardVector * HalfLength;
    const FRotator DecalRotation = FRotationMatrix::MakeFromXY(FVector::DownVector, -FVector::ForwardVector).Rotator();
 
    AttachToComponent(AttachParent, FAttachmentTransformRules::KeepRelativeTransform);
    SceneRootComponent->SetRelativeLocationAndRotation(DecalLocation, DecalRotation);
 
    if (CreateLineWarningDecals(Settings) == false)
    {
        ReturnToPoolImmediately();
        return false;
    }
 
    SetLineLengthRatio(1.0f);
    return true;
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

StopWarning()

void APatternWarningDecalActor::StopWarning

(

)

{
    BeginStopWarning(true);
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

Tick()

void APatternWarningDecalActor::Tick ( float  DeltaSeconds )

overridevirtual

{
    Super::Tick(DeltaSeconds);
 
    UpdateCircleProgress();
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

UpdateCircleProgress()

void APatternWarningDecalActor::UpdateCircleProgress ( )

private

{
    UWorld* World = GetWorld();
    if (IsValid(World) == false || CurrentWarningDuration <= KINDA_SMALL_NUMBER)
    {
        ReturnToPoolImmediately();
        return;
    }
 
    const float ElapsedTime = World->GetTimeSeconds() - WarningStartTime;
    const float Alpha = FMath::Clamp(ElapsedTime / CurrentWarningDuration, 0.0f, 1.0f);
    UpdateCircleWarning(Alpha);
 
    if (Alpha >= 1.0f)
    {
        SetActorTickEnabled(false);
    }
}

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

UpdateCircleWarning()

void APatternWarningDecalActor::UpdateCircleWarning ( float  Alpha ) const

private

{
    const float FinalRadius = CurrentCircleFinalRadius;
    if (IsValid(FillDecalComponent) == false || FillDecalComponent->IsVisible() == false || FinalRadius <= KINDA_SMALL_NUMBER)
    {
        return;
    }
 
    const float CurrentRadius = FMath::Lerp(CurrentCircleStartRadius, FinalRadius, Alpha);
    const float RadiusScale = FMath::Max(CurrentRadius, 0.0f) / FinalRadius;
    FillDecalComponent->SetRelativeScale3D(FVector(1.0f, RadiusScale, RadiusScale));
}

이 함수를 호출하는 함수들에 대한 그래프입니다.:

멤버 데이터 문서화

bIsFadingOut

bool APatternWarningDecalActor::bIsFadingOut = false

private

CurrentCircleFinalRadius

float APatternWarningDecalActor::CurrentCircleFinalRadius = 0.0f

private

CurrentCircleStartRadius

float APatternWarningDecalActor::CurrentCircleStartRadius = 0.0f

private

CurrentFadeOutDuration

float APatternWarningDecalActor::CurrentFadeOutDuration = 0.0f

private

CurrentLineLength

float APatternWarningDecalActor::CurrentLineLength = 0.0f

private

CurrentLineStartLocation

FVector APatternWarningDecalActor::CurrentLineStartLocation = FVector::ZeroVector

private

CurrentWarningDuration

float APatternWarningDecalActor::CurrentWarningDuration = 0.0f

private

CurrentWarningShape

EPatternWarningDecalShape APatternWarningDecalActor::CurrentWarningShape = EPatternWarningDecalShape::None

private

FillDecalComponent

TObjectPtr<UDecalComponent> APatternWarningDecalActor::FillDecalComponent

protected

MaxRangeDecalComponent

TObjectPtr<UDecalComponent> APatternWarningDecalActor::MaxRangeDecalComponent

protected

ReturnToPoolTimerHandle

FTimerHandle APatternWarningDecalActor::ReturnToPoolTimerHandle

private

SceneRootComponent

TObjectPtr<USceneComponent> APatternWarningDecalActor::SceneRootComponent

protected

WarningStartTime

float APatternWarningDecalActor::WarningStartTime = 0.0f

private

---

이 클래스에 대한 문서화 페이지는 다음의 파일들로부터 생성되었습니다.:

• Source/CK_UE/Component/Decal/PatternWarningDecalActor.h
• Source/CK_UE/Component/Decal/PatternWarningDecalActor.cpp