UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRawDistribution Struct Reference

#include <Distribution.h>

+ Inheritance diagram for FRawDistribution:

Public Member Functions

 FRawDistribution ()
 
ENGINE_API bool Serialize (FArchive &Ar)
 
ENGINE_API void GetValue (float Time, float *Value, int32 NumCoords, int32 Extreme, struct FRandomStream *InRandomStream) const
 
ENGINE_API void GetValue1 (float Time, float *Value, int32 Extreme, struct FRandomStream *InRandomStream) const
 
ENGINE_API void GetValue3 (float Time, float *Value, int32 Extreme, struct FRandomStream *InRandomStream) const
 
void GetValue1None (float Time, float *InValue) const
 
void GetValue3None (float Time, float *InValue) const
 
ENGINE_API void GetValue1Extreme (float Time, float *Value, int32 Extreme, struct FRandomStream *InRandomStream) const
 
ENGINE_API void GetValue3Extreme (float Time, float *Value, int32 Extreme, struct FRandomStream *InRandomStream) const
 
ENGINE_API void GetValue1Random (float Time, float *Value, struct FRandomStream *InRandomStream) const
 
ENGINE_API void GetValue3Random (float Time, float *Value, struct FRandomStream *InRandomStream) const
 
bool IsSimple ()
 

Static Public Member Functions

static ENGINE_API UObjectTryGetDistributionObjectFromRawDistributionProperty (FStructProperty *Property, uint8 *Data)
 

Public Attributes

FDistributionLookupTable Table
 

Protected Attributes

FDistributionLookupTable LookupTable
 

Detailed Description

Raw distribution used to quickly sample distributions at runtime.

Constructor & Destructor Documentation

◆ FRawDistribution()

FRawDistribution::FRawDistribution ( )
inline

Default constructor.

Member Function Documentation

◆ GetValue()

void FRawDistribution::GetValue ( float  Time,
float Value,
int32  NumCoords,
int32  Extreme,
struct FRandomStream InRandomStream 
) const

Calcuate the float or vector value at the given time

Parameters
TimeThe time to evaluate
ValueAn array of (1 or 3) FLOATs to receive the values
NumCoordsThe number of floats in the Value array
ExtremeFor distributions that use one of the extremes, this is which extreme to use

◆ GetValue1()

void FRawDistribution::GetValue1 ( float  Time,
float Value,
int32  Extreme,
struct FRandomStream InRandomStream 
) const

◆ GetValue1Extreme()

void FRawDistribution::GetValue1Extreme ( float  Time,
float Value,
int32  Extreme,
struct FRandomStream InRandomStream 
) const

◆ GetValue1None()

void FRawDistribution::GetValue1None ( float  Time,
float InValue 
) const
inline

◆ GetValue1Random()

void FRawDistribution::GetValue1Random ( float  Time,
float Value,
struct FRandomStream InRandomStream 
) const

◆ GetValue3()

void FRawDistribution::GetValue3 ( float  Time,
float Value,
int32  Extreme,
struct FRandomStream InRandomStream 
) const

◆ GetValue3Extreme()

void FRawDistribution::GetValue3Extreme ( float  Time,
float Value,
int32  Extreme,
struct FRandomStream InRandomStream 
) const

◆ GetValue3None()

void FRawDistribution::GetValue3None ( float  Time,
float InValue 
) const
inline

◆ GetValue3Random()

void FRawDistribution::GetValue3Random ( float  Time,
float Value,
struct FRandomStream InRandomStream 
) const

◆ IsSimple()

bool FRawDistribution::IsSimple ( )
inline

◆ Serialize()

ENGINE_API bool FRawDistribution::Serialize ( FArchive Ar)

Serialization.

Parameters
Ar- The archive with which to serialize.
Returns
true if serialization was successful.

◆ TryGetDistributionObjectFromRawDistributionProperty()

UObject * FRawDistribution::TryGetDistributionObjectFromRawDistributionProperty ( FStructProperty Property,
uint8 Data 
)
static

Return the UDistribution* variable if the given StructProperty points to a FRawDistribution* struct

Parameters
PropertySome UStructProperty
DataMemory that owns the property
Returns
The UDisitribution* object if this is a FRawDistribution* struct, or NULL otherwise

Member Data Documentation

◆ LookupTable

FDistributionLookupTable FRawDistribution::LookupTable
protected

Lookup table of values

◆ Table

FDistributionLookupTable FRawDistribution::Table

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