FWorldPartitionStreamingSource Struct Reference

#include <WorldPartitionStreamingSource.h>

Inheritance diagram for FWorldPartitionStreamingSource:

Public Member Functions
	FWorldPartitionStreamingSource ()
	FWorldPartitionStreamingSource (FName InName, const FVector &InLocation, const FRotator &InRotation, EStreamingSourceTargetState InTargetState, bool bInBlockOnSlowLoading, EStreamingSourcePriority InPriority, bool bRemote, FVector InVelocity=FVector::Zero())
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FWorldPartitionStreamingSource (const FWorldPartitionStreamingSource &Other)=default
FWorldPartitionStreamingSource &	operator= (const FWorldPartitionStreamingSource &Other)=default
	FWorldPartitionStreamingSource (FWorldPartitionStreamingSource &&Other)=default
FWorldPartitionStreamingSource &	operator= (FWorldPartitionStreamingSource &&Other)=default
PRAGMA_ENABLE_DEPRECATION_WARNINGS FColor	GetDebugColor () const
ENGINE_API void	UpdateHash ()
uint32	GetHash (bool bInclude3DInformation=true) const
FBox	CalcBounds (float InGridLoadingRange, FName InGridName, bool bCalcIn2D=false) const
void	ForEachShape (float InGridLoadingRange, bool bInProjectIn2D, TFunctionRef< void(const FSphericalSector &)> InOperation) const
void	ForEachShape (float InGridLoadingRange, FName InGridName, bool bInProjectIn2D, TFunctionRef< void(const FSphericalSector &)> InOperation) const
FString	ToString () const

Static Public Member Functions
static int32	GetLocationQuantization ()
static int32	GetRotationQuantization ()

Public Attributes
FName	Name
FVector	Location
FRotator	Rotation
EStreamingSourceTargetState	TargetState
bool	bBlockOnSlowLoading
EStreamingSourcePriority	Priority
FVector	Velocity
bool	bUseVelocityContributionToCellsSorting
FColor	DebugColor
EStreamingSourceTargetBehavior	TargetBehavior
TSet< FName >	TargetGrids
TSet< FSoftObjectPath >	TargetHLODLayers
TArray< FStreamingSourceShape >	Shapes
bool	bReplay
bool	bRemote
bool	bForce2D

Friends
struct	FSetStreamingSourceExtraRadius
struct	FSetStreamingSourceExtraAngle

Detailed Description

Structure containing all properties required to stream from a source

Constructor & Destructor Documentation

FWorldPartitionStreamingSource() [1/4]

FWorldPartitionStreamingSource::FWorldPartitionStreamingSource ( )

inline

FWorldPartitionStreamingSource() [2/4]

FWorldPartitionStreamingSource::FWorldPartitionStreamingSource ( FName  InName, const FVector &  InLocation, const FRotator &  InRotation, EStreamingSourceTargetState  InTargetState, bool  bInBlockOnSlowLoading, EStreamingSourcePriority  InPriority, bool  bRemote, FVector  InVelocity = FVector::Zero()  )

inline

FWorldPartitionStreamingSource() [3/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FWorldPartitionStreamingSource::FWorldPartitionStreamingSource ( const FWorldPartitionStreamingSource &  Other )

default

FWorldPartitionStreamingSource() [4/4]

FWorldPartitionStreamingSource::FWorldPartitionStreamingSource ( FWorldPartitionStreamingSource &&  Other )

default

Member Function Documentation

CalcBounds()

FBox FWorldPartitionStreamingSource::CalcBounds ( float  InGridLoadingRange, FName  InGridName, bool  bCalcIn2D = false  ) const

inline

Returns a box encapsulating all shapes.

ForEachShape() [1/2]

void FWorldPartitionStreamingSource::ForEachShape ( float  InGridLoadingRange, bool  bInProjectIn2D, TFunctionRef< void(const FSphericalSector &)>  InOperation  ) const

inline

Helper method that iterates over all shapes. If none is provided, it will still pass a sphere shape using grid's loading range.

ForEachShape() [2/2]

void FWorldPartitionStreamingSource::ForEachShape ( float  InGridLoadingRange, FName  InGridName, bool  bInProjectIn2D, TFunctionRef< void(const FSphericalSector &)>  InOperation  ) const

inline

Helper method that iterates over all shapes affecting a specific grid. If none is provided, it will still pass a sphere shape using grid's loading range.

GetDebugColor()

PRAGMA_ENABLE_DEPRECATION_WARNINGS FColor FWorldPartitionStreamingSource::GetDebugColor ( ) const

inline

GetHash()

uint32 FWorldPartitionStreamingSource::GetHash ( bool  bInclude3DInformation = true ) const

inline

GetLocationQuantization()

static int32 FWorldPartitionStreamingSource::GetLocationQuantization ( )

inlinestatic

GetRotationQuantization()

static int32 FWorldPartitionStreamingSource::GetRotationQuantization ( )

inlinestatic

operator=() [1/2]

FWorldPartitionStreamingSource & FWorldPartitionStreamingSource::operator= ( const FWorldPartitionStreamingSource &  Other )

default

operator=() [2/2]

FWorldPartitionStreamingSource & FWorldPartitionStreamingSource::operator= ( FWorldPartitionStreamingSource &&  Other )

default

ToString()

FString FWorldPartitionStreamingSource::ToString

(

)

const

UpdateHash()

void FWorldPartitionStreamingSource::UpdateHash

(

)

Friends And Related Symbol Documentation

FSetStreamingSourceExtraAngle

friend struct FSetStreamingSourceExtraAngle

friend

FSetStreamingSourceExtraRadius

friend struct FSetStreamingSourceExtraRadius

friend

Member Data Documentation

bBlockOnSlowLoading

bool FWorldPartitionStreamingSource::bBlockOnSlowLoading

Whether this source will be considered when world partition detects slow loading and waits for cell streaming to complete.

bForce2D

bool FWorldPartitionStreamingSource::bForce2D

If true, this streaming source will force intersecting cells in 2D

bRemote

bool FWorldPartitionStreamingSource::bRemote

If true, this streaming source is from a remote session

bReplay

bool FWorldPartitionStreamingSource::bReplay

If true, this streaming source is from a replay recording

bUseVelocityContributionToCellsSorting

bool FWorldPartitionStreamingSource::bUseVelocityContributionToCellsSorting

Use velocity contribution to streaming cells priority streaming.

DebugColor

FColor FWorldPartitionStreamingSource::DebugColor

Color used for debugging.

Location

FVector FWorldPartitionStreamingSource::Location

Source location.

Name

FName FWorldPartitionStreamingSource::Name

Source unique name.

Priority

EStreamingSourcePriority FWorldPartitionStreamingSource::Priority

Streaming source priority.

Rotation

FRotator FWorldPartitionStreamingSource::Rotation

Source orientation (can impact streaming cell prioritization).

Shapes

TArray<FStreamingSourceShape> FWorldPartitionStreamingSource::Shapes

Source internal shapes. When none are provided, a sphere is automatically used. It's radius is equal to grid's loading range and center equals source's location.

TargetBehavior

EStreamingSourceTargetBehavior FWorldPartitionStreamingSource::TargetBehavior

Defines how TargetGrids/TargetHLODLayers will be applied to this streaming source.

TargetGrids

TSet<FName> FWorldPartitionStreamingSource::TargetGrids

When set, this will change how this streaming source is applied to the provided runtime streaming grids based on the TargetBehavior.

TargetHLODLayers

TSet<FSoftObjectPath> FWorldPartitionStreamingSource::TargetHLODLayers

When set, this will change how this streaming source is applied to the provided HLODLayers based on the TargetBehavior.

TargetState

EStreamingSourceTargetState FWorldPartitionStreamingSource::TargetState

Target streaming state.

Velocity

FVector FWorldPartitionStreamingSource::Velocity

Source velocity (computed automatically).

---

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

• Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartitionStreamingSource.h
• Engine/Source/Runtime/Engine/Private/WorldPartition/WorldPartitionStreamingSource.cpp