FNiagaraSimCacheCreateParameters Struct Reference

Public Member Functions
Functions
bool	GetbAllowInterpolation () const
	When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.
bool	GetbAllowRebasing () const
	When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component's location.
void	SetbAllowRebasing (bool Value)
	When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component's location.
bool	GetbAllowDataInterfaceCaching () const
	When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used.
void	SetbAllowDataInterfaceCaching (bool Value)
	When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used.
FNiagaraSimCacheCreateParameters &	opAssign (FNiagaraSimCacheCreateParameters Other)
void	SetbAllowInterpolation (bool Value)
	When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.
bool	GetbAllowVelocityExtrapolation () const
	When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.
void	SetbAllowVelocityExtrapolation (bool Value)
	When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.
bool	GetbAllowSerializeLargeCache () const
	When enabled the cache will support serializing large amounts of cache data.
void	SetbAllowSerializeLargeCache (bool Value)
	When enabled the cache will support serializing large amounts of cache data.

Public Attributes
SimCache
TArray< FName >	ExplicitCaptureAttributes
	List of attributes to capture when the capture attribute capture mode is set to explicit. For example, adding MyEmitter.Particles.Position will only gather that attribute inside the cache.
TArray< FName >	RebaseIncludeAttributes
	List of Attributes to force include in the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter.
TArray< FName >	RebaseExcludeAttributes
	List of Attributes to force exclude from the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter.
TArray< FName >	InterpolationIncludeAttributes
	List of specific Attributes to include when using interpolation. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.
TArray< FName >	InterpolationExcludeAttributes
	List of specific Attributes to exclude interpolation for. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.
ENiagaraSimCacheAttributeCaptureMode	AttributeCaptureMode
	How do we want to capture attributes for the simulation cache. The mode selected depends on what situations the cache can be used in.
Variables
bool	bAllowDataInterfaceCaching
bool	bAllowInterpolation
bool	bAllowVelocityExtrapolation
bool	bAllowSerializeLargeCache
bool	bAllowRebasing

Member Function Documentation

GetbAllowDataInterfaceCaching()

bool GetbAllowDataInterfaceCaching

(

)

const

When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used.

GetbAllowInterpolation()

bool GetbAllowInterpolation

(

)

const

When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.

GetbAllowRebasing()

bool GetbAllowRebasing

(

)

const

When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component's location.

GetbAllowSerializeLargeCache()

bool GetbAllowSerializeLargeCache

(

)

const

When enabled the cache will support serializing large amounts of cache data.

GetbAllowVelocityExtrapolation()

bool GetbAllowVelocityExtrapolation

(

)

const

When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.

opAssign()

FNiagaraSimCacheCreateParameters & opAssign

(

FNiagaraSimCacheCreateParameters

Other

)

SetbAllowDataInterfaceCaching()

void SetbAllowDataInterfaceCaching

(

bool

Value

)

When enabled Data Interface data will be stored in the SimCache. This can result in a large increase to the cache size, depending on what Data Interfaces are used.

SetbAllowInterpolation()

void SetbAllowInterpolation

(

bool

Value

)

When enabled we allow the cache to be generated for interpolation. This will increase the memory usage for the cache slightly but can allow you to reduce the capture rate. By default we will capture and interpolate all Position & Quat types, you can adjust this using the include / exclude list.

SetbAllowRebasing()

void SetbAllowRebasing

(

bool

Value

)

When enabled allows the SimCache to be re-based. i.e. World space emitters can be moved to the new component's location.

SetbAllowSerializeLargeCache()

void SetbAllowSerializeLargeCache

(

bool

Value

)

When enabled the cache will support serializing large amounts of cache data.

SetbAllowVelocityExtrapolation()

void SetbAllowVelocityExtrapolation

(

bool

Value

)

When enabled we allow the cache to be generated for extrapolation. This will force the velocity attribute to be maintained.

Member Data Documentation

AttributeCaptureMode

ENiagaraSimCacheAttributeCaptureMode AttributeCaptureMode

How do we want to capture attributes for the simulation cache. The mode selected depends on what situations the cache can be used in.

bAllowDataInterfaceCaching

bool bAllowDataInterfaceCaching

bAllowInterpolation

bool bAllowInterpolation

bAllowRebasing

bool bAllowRebasing

bAllowSerializeLargeCache

bool bAllowSerializeLargeCache

bAllowVelocityExtrapolation

bool bAllowVelocityExtrapolation

ExplicitCaptureAttributes

TArray<FName> ExplicitCaptureAttributes

List of attributes to capture when the capture attribute capture mode is set to explicit. For example, adding MyEmitter.Particles.Position will only gather that attribute inside the cache.

InterpolationExcludeAttributes

TArray<FName> InterpolationExcludeAttributes

List of specific Attributes to exclude interpolation for. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

InterpolationIncludeAttributes

TArray<FName> InterpolationIncludeAttributes

List of specific Attributes to include when using interpolation. They must be types that are supported for interpolation. For example, MyEmitter.Particles.MyPosition would force MyPosition to be interpolated.

RebaseExcludeAttributes

TArray<FName> RebaseExcludeAttributes

List of Attributes to force exclude from the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter.

RebaseIncludeAttributes

TArray<FName> RebaseIncludeAttributes

List of Attributes to force include in the SimCache rebase, they should be the full path to the attribute For example, MyEmitter.Particles.MyQuat would force the particle attribute MyQuat to be included for MyEmitter.