FModuleInputValue Struct Reference

#include <ModuleInput.h>

Public Types
using	MAxis1D = double
using	MAxis2D = FVector2D
using	MAxis3D = FVector
using	MInteger = int32

Public Member Functions
	FModuleInputValue ()=default
	FModuleInputValue (const FModuleInputValue &)=default
FModuleInputValue &	operator= (const FModuleInputValue &)=default
	FModuleInputValue (bool bInValue)
	FModuleInputValue (MInteger InValue)
	FModuleInputValue (MAxis1D InValue)
	FModuleInputValue (MAxis2D InValue)
	FModuleInputValue (MAxis3D InValue)
FModuleInputValue	ReturnQuantized (EModuleInputQuantizationType InInputQuantizationType) const
	FModuleInputValue (EModuleInputValueType InValueType, MAxis3D InValue)
	FModuleInputValue (EModuleInputValueType InValueType, MInteger InValue)
void	Reset ()
FModuleInputValue &	operator+= (const FModuleInputValue &Rhs)
FModuleInputValue &	operator-= (const FModuleInputValue &Rhs)
FModuleInputValue &	operator*= (float Scalar)
template<typename T >
T	Get () const
float	operator[] (int32 Index) const
bool	IsQuantizedNonZero (EModuleInputQuantizationType InInputQuantizationType, float Tolerance=KINDA_SMALL_NUMBER) const
UE_API bool	IsNonZero (float Tolerance=KINDA_SMALL_NUMBER) const
FModuleInputValue &	ConvertToType (EModuleInputValueType Type)
FModuleInputValue &	ConvertToType (const FModuleInputValue &Other)
EModuleInputValueType	GetValueType () const
UE_API float	GetMagnitudeSq () const
UE_API float	GetMagnitude () const
UE_API int32	GetMagnitudeInt () const
UE_API void	Serialize (FArchive &Ar, UPackageMap *Map, bool &bOutSuccess, EModuleInputQuantizationType InInputQuantizationType)
UE_API void	NetSerialize (FArchive &Ar, UPackageMap *Map, bool &bOutSuccess, EModuleInputQuantizationType InInputQuantizationType)
UE_API void	DeltaNetSerialize (FArchive &Ar, UPackageMap *Map, bool &bOutSuccess, const FModuleInputValue &PreviousInputValue, EModuleInputQuantizationType InInputQuantizationType)
UE_API void	Set (const FModuleInputValue &In)
UE_API void	Lerp (const FModuleInputValue &Min, const FModuleInputValue &Max, float Alpha)
UE_API void	Merge (const FModuleInputValue &From)
UE_API void	Combine (const FModuleInputValue &With)
UE_API void	Decay (const float DecayAmount)
UE_API FString	ToString () const
void	SetApplyInputDecay (const bool bInApplyInputDecay)
bool	ShouldApplyInputDecay () const
void	SetClearAfterConsumed (const bool bInClearAfterConsumed)
bool	ShouldClearAfterConsumed () const
template<>
bool	Get () const
template<>
FModuleInputValue::MAxis1D	Get () const
template<>
FModuleInputValue::MAxis2D	Get () const
template<>
FModuleInputValue::MAxis3D	Get () const
template<>
FModuleInputValue::MInteger	Get () const

Static Public Member Functions
static void	Quantize (double &InOutValue, EModuleInputQuantizationType InInputQuantizationType)
static bool	SerializeQuantized (double &InOutValue, FArchive &Ar, EModuleInputQuantizationType InInputQuantizationType)
static FModuleInputValue	Clamp (const FModuleInputValue &InValue, const float InMin, const float InMax)

Protected Member Functions
void	SetMagnitude (float NewSize)

Protected Attributes
FVector	Value = FVector::ZeroVector
int32	ValueInt = 0
EModuleInputValueType	ValueType = EModuleInputValueType::MBoolean
bool	bApplyInputDecay = false
bool	bClearAfterConsumed = false

Friends
FModuleInputValue	operator+ (const FModuleInputValue &Lhs, const FModuleInputValue &Rhs)
FModuleInputValue	operator- (const FModuleInputValue &Lhs, const FModuleInputValue &Rhs)
FModuleInputValue	operator* (const FModuleInputValue &Lhs, const float Rhs)

Member Typedef Documentation

MAxis1D

using FModuleInputValue::MAxis1D = double

MAxis2D

using FModuleInputValue::MAxis2D = FVector2D

MAxis3D

using FModuleInputValue::MAxis3D = FVector

MInteger

using FModuleInputValue::MInteger = int32

Constructor & Destructor Documentation

FModuleInputValue() [1/9]

FModuleInputValue::FModuleInputValue ( )

default

FModuleInputValue() [2/9]

FModuleInputValue::FModuleInputValue ( const FModuleInputValue &  )

default

FModuleInputValue() [3/9]

FModuleInputValue::FModuleInputValue ( bool  bInValue )

inline

FModuleInputValue() [4/9]

FModuleInputValue::FModuleInputValue ( MInteger  InValue )

inline

FModuleInputValue() [5/9]

FModuleInputValue::FModuleInputValue ( MAxis1D  InValue )

inline

FModuleInputValue() [6/9]

FModuleInputValue::FModuleInputValue ( MAxis2D  InValue )

inline

FModuleInputValue() [7/9]

FModuleInputValue::FModuleInputValue ( MAxis3D  InValue )

inline

FModuleInputValue() [8/9]

FModuleInputValue::FModuleInputValue ( EModuleInputValueType  InValueType, MAxis3D  InValue  )

inline

FModuleInputValue() [9/9]

FModuleInputValue::FModuleInputValue ( EModuleInputValueType  InValueType, MInteger  InValue  )

inline

Member Function Documentation

Clamp()

static FModuleInputValue FModuleInputValue::Clamp ( const FModuleInputValue &  InValue, const float  InMin, const float  InMax  )

inlinestatic

Combine()

void FModuleInputValue::Combine

(

const FModuleInputValue &

With

)

ConvertToType() [1/2]

FModuleInputValue & FModuleInputValue::ConvertToType ( const FModuleInputValue &  Other )

inline

ConvertToType() [2/2]

FModuleInputValue & FModuleInputValue::ConvertToType ( EModuleInputValueType  Type )

inline

Decay()

void FModuleInputValue::Decay

(

const float

DecayAmount

)

DeltaNetSerialize()

void FModuleInputValue::DeltaNetSerialize	(	FArchive &	Ar,
		UPackageMap *	Map,
		bool &	bOutSuccess,
		const FModuleInputValue &	PreviousInputValue,
		EModuleInputQuantizationType	InInputQuantizationType
	)

Get() [1/6]

template<typename T >

T FModuleInputValue::Get ( ) const

inline

Get() [2/6]

template<>

bool FModuleInputValue::Get ( ) const

inline

Get() [3/6]

template<>

FModuleInputValue::MAxis1D FModuleInputValue::Get ( ) const

inline

Get() [4/6]

template<>

FModuleInputValue::MAxis2D FModuleInputValue::Get ( ) const

inline

Get() [5/6]

template<>

FModuleInputValue::MAxis3D FModuleInputValue::Get ( ) const

inline

Get() [6/6]

template<>

FModuleInputValue::MInteger FModuleInputValue::Get ( ) const

inline

GetMagnitude()

float FModuleInputValue::GetMagnitude

(

)

const

GetMagnitudeInt()

int32 FModuleInputValue::GetMagnitudeInt

(

)

const

GetMagnitudeSq()

float FModuleInputValue::GetMagnitudeSq

(

)

const

GetValueType()

EModuleInputValueType FModuleInputValue::GetValueType ( ) const

inline

IsNonZero()

bool FModuleInputValue::IsNonZero

(

float

Tolerance = KINDA_SMALL_NUMBER

)

const

IsQuantizedNonZero()

bool FModuleInputValue::IsQuantizedNonZero ( EModuleInputQuantizationType  InInputQuantizationType, float  Tolerance = KINDA_SMALL_NUMBER  ) const

inline

Lerp()

void FModuleInputValue::Lerp	(	const FModuleInputValue &	Min,
		const FModuleInputValue &	Max,
		float	Alpha
	)

Merge()

void FModuleInputValue::Merge

(

const FModuleInputValue &

From

)

NetSerialize()

void FModuleInputValue::NetSerialize	(	FArchive &	Ar,
		UPackageMap *	Map,
		bool &	bOutSuccess,
		EModuleInputQuantizationType	InInputQuantizationType
	)

operator*=()

FModuleInputValue & FModuleInputValue::operator*= ( float  Scalar )

inline

operator+=()

FModuleInputValue & FModuleInputValue::operator+= ( const FModuleInputValue &  Rhs )

inline

operator-=()

FModuleInputValue & FModuleInputValue::operator-= ( const FModuleInputValue &  Rhs )

inline

operator=()

FModuleInputValue & FModuleInputValue::operator= ( const FModuleInputValue &  )

default

operator[]()

float FModuleInputValue::operator[] ( int32  Index ) const

inline

Quantize()

void FModuleInputValue::Quantize ( double &  InOutValue, EModuleInputQuantizationType  InInputQuantizationType  )

static

Reset()

void FModuleInputValue::Reset ( )

inline

ReturnQuantized()

FModuleInputValue FModuleInputValue::ReturnQuantized

(

EModuleInputQuantizationType

InInputQuantizationType

)

const

Serialize()

void FModuleInputValue::Serialize	(	FArchive &	Ar,
		UPackageMap *	Map,
		bool &	bOutSuccess,
		EModuleInputQuantizationType	InInputQuantizationType
	)

SerializeQuantized()

bool FModuleInputValue::SerializeQuantized ( double &  InOutValue, FArchive &  Ar, EModuleInputQuantizationType  InInputQuantizationType  )

static

Set()

void FModuleInputValue::Set

(

const FModuleInputValue &

In

)

Set only the value without overriding the other properties in FModuleInputValue

SetApplyInputDecay()

void FModuleInputValue::SetApplyInputDecay ( const bool  bInApplyInputDecay )

inline

During physics resimulation, apply decay for this input while it's being extrapolated

SetClearAfterConsumed()

void FModuleInputValue::SetClearAfterConsumed ( const bool  bInClearAfterConsumed )

inline

After simulation first consumes the input, clear the value doesn't persist across multiple async physics ticks

SetMagnitude()

void FModuleInputValue::SetMagnitude ( float  NewSize )

protected

ShouldApplyInputDecay()

bool FModuleInputValue::ShouldApplyInputDecay ( ) const

inline

ShouldClearAfterConsumed()

bool FModuleInputValue::ShouldClearAfterConsumed ( ) const

inline

ToString()

FString FModuleInputValue::ToString

(

)

const

Friends And Related Symbol Documentation

operator*

FModuleInputValue operator* ( const FModuleInputValue &  Lhs, const float  Rhs  )

friend

operator+

FModuleInputValue operator+ ( const FModuleInputValue &  Lhs, const FModuleInputValue &  Rhs  )

friend

operator-

FModuleInputValue operator- ( const FModuleInputValue &  Lhs, const FModuleInputValue &  Rhs  )

friend

Member Data Documentation

bApplyInputDecay

bool FModuleInputValue::bApplyInputDecay = false

protected

bClearAfterConsumed

bool FModuleInputValue::bClearAfterConsumed = false

protected

Value

FVector FModuleInputValue::Value = FVector::ZeroVector

protected

ValueInt

int32 FModuleInputValue::ValueInt = 0

protected

ValueType

EModuleInputValueType FModuleInputValue::ValueType = EModuleInputValueType::MBoolean

protected

---

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

• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/ModuleInput.h
• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Private/SimModule/ModuleInput.cpp