UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Softs::FPBDFlatWeightMapView Class Referencefinal

#include <PBDFlatWeightMap.h>

Public Member Functions

 FPBDFlatWeightMapView (const FSolverVec2 &InWeightedValue, const TConstArrayView< FSolverReal > &Multipliers, int32 InNumElements)
 
 ~FPBDFlatWeightMapView ()=default
 
 FPBDFlatWeightMapView (const FPBDFlatWeightMapView &)=default
 
 FPBDFlatWeightMapView (FPBDFlatWeightMapView &&)=default
 
FPBDFlatWeightMapViewoperator= (const FPBDFlatWeightMapView &)=default
 
FPBDFlatWeightMapViewoperator= (FPBDFlatWeightMapView &&)=default
 
int32 Num () const
 
bool HasWeightMap () const
 
void SetWeightedValue (const FSolverVec2 &InWeightedValue)
 
const FSolverVec2GetOffsetRange () const
 
FSolverReal operator[] (int32 Index) const
 
FSolverReal GetLow () const
 
FSolverReal GetHigh () const
 
FSolverReal GetValue (int32 Index) const
 
 operator FSolverReal () const
 
void SetMapValues (const TConstArrayView< FSolverReal > &InMapValues)
 
TConstArrayView< FSolverRealGetMapValues () const
 

Detailed Description

Simple weight map wrapping existing weight values. Also holds low/high values, but these are multiplied against the map each time the operator[] is called.

Constructor & Destructor Documentation

◆ FPBDFlatWeightMapView() [1/3]

Chaos::Softs::FPBDFlatWeightMapView::FPBDFlatWeightMapView ( const FSolverVec2 InWeightedValue,
const TConstArrayView< FSolverReal > &  Multipliers,
int32  InNumElements 
)
inline

◆ ~FPBDFlatWeightMapView()

Chaos::Softs::FPBDFlatWeightMapView::~FPBDFlatWeightMapView ( )
default

◆ FPBDFlatWeightMapView() [2/3]

Chaos::Softs::FPBDFlatWeightMapView::FPBDFlatWeightMapView ( const FPBDFlatWeightMapView )
default

◆ FPBDFlatWeightMapView() [3/3]

Chaos::Softs::FPBDFlatWeightMapView::FPBDFlatWeightMapView ( FPBDFlatWeightMapView &&  )
default

Member Function Documentation

◆ GetHigh()

FSolverReal Chaos::Softs::FPBDFlatWeightMapView::GetHigh ( ) const
inline

Return the value at the High weight.

◆ GetLow()

FSolverReal Chaos::Softs::FPBDFlatWeightMapView::GetLow ( ) const
inline

Return the value at the Low weight.

◆ GetMapValues()

TConstArrayView< FSolverReal > Chaos::Softs::FPBDFlatWeightMapView::GetMapValues ( ) const
inline

Return the table of stiffnesses as a read only array.

◆ GetOffsetRange()

const FSolverVec2 & Chaos::Softs::FPBDFlatWeightMapView::GetOffsetRange ( ) const
inline

Return the values set for this map as an Offset and Range (Low = OffsetRange[0], High = OffsetRange[0] + OffsetRange[1])

◆ GetValue()

FSolverReal Chaos::Softs::FPBDFlatWeightMapView::GetValue ( int32  Index) const
inline

◆ HasWeightMap()

bool Chaos::Softs::FPBDFlatWeightMapView::HasWeightMap ( ) const
inline

Return whether this object contains weight map values.

◆ Num()

int32 Chaos::Softs::FPBDFlatWeightMapView::Num ( ) const
inline

Return the number of values stored in the weight map.

◆ operator FSolverReal()

Chaos::Softs::FPBDFlatWeightMapView::operator FSolverReal ( ) const
inlineexplicit

Return the value when the weight map is not used.

◆ operator=() [1/2]

FPBDFlatWeightMapView & Chaos::Softs::FPBDFlatWeightMapView::operator= ( const FPBDFlatWeightMapView )
default

◆ operator=() [2/2]

FPBDFlatWeightMapView & Chaos::Softs::FPBDFlatWeightMapView::operator= ( FPBDFlatWeightMapView &&  )
default

◆ operator[]()

FSolverReal Chaos::Softs::FPBDFlatWeightMapView::operator[] ( int32  Index) const
inline

Lookup for the weighted value at the specified weight map index. This function will assert if it is called with a non zero index on an empty weight map.

◆ SetMapValues()

void Chaos::Softs::FPBDFlatWeightMapView::SetMapValues ( const TConstArrayView< FSolverReal > &  InMapValues)
inline

◆ SetWeightedValue()

void Chaos::Softs::FPBDFlatWeightMapView::SetWeightedValue ( const FSolverVec2 InWeightedValue)
inline

Set the low and high values of the weight map.


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