UMortarProSignificanceComponent Class Reference

#include <MortarProSignificanceComponent.h>

Inheritance diagram for UMortarProSignificanceComponent:

Collaboration diagram for UMortarProSignificanceComponent:

Public Member Functions
	UMortarProSignificanceComponent ()

Public Attributes
uint32	bManageSignificance: 1
EMortarProSignificanceValue	CurrentSignificance
FMortarProEndSignificanceChanged	OnSignificanceChanged
TArray< FMortarProSignificanceDistance >	SignificanceDistanceThresholds

Protected Member Functions
virtual void	BeginPlay () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

Protected Attributes
uint32	bInsignificantWhenOwnerIsHidden: 1

Private Member Functions
float	GetSignificanceByDistance (const float &Distance) const
void	PostSignficanceFunction (USignificanceManager::FManagedObjectInfo *ObjectInfo, float OldSignificance, float Significance, bool bFinal)
virtual void	RegisterToSignificanceManager ()
float	SignficanceFunction (USignificanceManager::FManagedObjectInfo *ObjectInfo, const FTransform &Viewpoint)

Private Attributes
FName	RegisterObjectTag

Detailed Description

Generic Actor Component Class that manages Significance of the owner actor Actor then can handle in its class what to do with significance value. FMortarProEndSignificanceChanged is generated when significance value changes

Constructor & Destructor Documentation

UMortarProSignificanceComponent()

UMortarProSignificanceComponent::UMortarProSignificanceComponent

(

)

Member Function Documentation

BeginPlay()

virtual void UMortarProSignificanceComponent::BeginPlay ( )

overrideprotectedvirtual

Register Owner Actor Here

EndPlay()

virtual void UMortarProSignificanceComponent::EndPlay ( const EEndPlayReason::Type  EndPlayReason )

overrideprotectedvirtual

Unregister Object from Significance Manager

GetSignificanceByDistance()

float UMortarProSignificanceComponent::GetSignificanceByDistance ( const float &  Distance ) const

private

Gets Significance Value By Distance

Parameters

[in]

Distance

float variable containing Current Distance

Returns

Significance Value

PostSignficanceFunction()

void UMortarProSignificanceComponent::PostSignficanceFunction ( USignificanceManager::FManagedObjectInfo *  ObjectInfo, float  OldSignificance, float  Significance, bool  bFinal  )

private

Post Signficance Function

See also

https://docs.unrealengine.com/5.3/en-US/API/Plugins/SignificanceManager/USignificanceManager/FPostSignificanceFunction/

RegisterToSignificanceManager()

virtual void UMortarProSignificanceComponent::RegisterToSignificanceManager ( )

privatevirtual

Function To register Owner to Significance Manager

SignficanceFunction()

float UMortarProSignificanceComponent::SignficanceFunction ( USignificanceManager::FManagedObjectInfo *  ObjectInfo, const FTransform &  Viewpoint  )

private

Significance Function used for returning Significance Value

See also

https://docs.unrealengine.com/5.3/en-US/API/Plugins/SignificanceManager/USignificanceManager/FSignificanceFunction/

Member Data Documentation

bInsignificantWhenOwnerIsHidden

uint32 UMortarProSignificanceComponent::bInsignificantWhenOwnerIsHidden

protected

Whether to set siginificance value to lowest when actor is hidden

bManageSignificance

uint32 UMortarProSignificanceComponent::bManageSignificance

Whether to register with Significance Manager to optimize Tick. By Default value is true

CurrentSignificance

EMortarProSignificanceValue UMortarProSignificanceComponent::CurrentSignificance

Stores Current Significance

OnSignificanceChanged

FMortarProEndSignificanceChanged UMortarProSignificanceComponent::OnSignificanceChanged

Event Generated whenever significance value is changed

RegisterObjectTag

FName UMortarProSignificanceComponent::RegisterObjectTag

private

Tag Name of the registered object

SignificanceDistanceThresholds

TArray<FMortarProSignificanceDistance> UMortarProSignificanceComponent::SignificanceDistanceThresholds

MaxDistance per Significance, defaults to 0.0 (lowest) Significance if outside bounds of distances specified here.

---

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

• Public/Components/MortarProSignificanceComponent.h