UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GeometryCollection::Facades::FMuscleActivationFacade Class Reference

#include <CollectionMuscleActivationFacade.h>

Public Member Functions

CHAOS_API FMuscleActivationFacade (FManagedArrayCollection &InCollection)
 
CHAOS_API FMuscleActivationFacade (const FManagedArrayCollection &InCollection)
 
CHAOS_API void DefineSchema ()
 
bool IsConst () const
 
CHAOS_API bool IsValid () const
 
CHAOS_API int32 AddMuscleActivationData (const FMuscleActivationData &InputData)
 
CHAOS_API bool UpdateMuscleActivationData (const int32 DataIndex, const FMuscleActivationData &InputData)
 
CHAOS_API FMuscleActivationData GetMuscleActivationData (const int32 DataIndex) const
 
bool IsValidGeometryIndex (const int32 Index) const
 
bool IsValidElementIndex (const int32 Index) const
 
int32 NumMuscles () const
 
bool IsValidMuscleIndex (const int32 Index) const
 
CHAOS_API int32 MuscleVertexOffset (const int32 MuscleIndex) const
 
CHAOS_API int32 NumMuscleVertices (const int32 MuscleIndex) const
 
CHAOS_API FString FindMuscleName (const int32 MuscleIndex) const
 
CHAOS_API int32 FindMuscleIndexByName (const FString MuscleName) const
 
CHAOS_API int32 FindMuscleGeometryIndex (const int32 MuscleIndex) const
 
CHAOS_API int32 RemoveInvalidMuscles ()
 
CHAOS_API bool SetUpMuscleActivation (const TArray< int32 > &Origin, const TArray< int32 > &Insertion, float ContractionVolumeScale=1.f)
 
CHAOS_API void UpdateGlobalMuscleActivationParameters (float InGlobalContractionVolumeScale, float InGlobalFiberLengthRatioAtMaxActivation, float InGlobalMuscleLengthRatioThresholdForMaxActivation, float InGlobalInflationVolumeScale)
 
CHAOS_API bool UpdateMuscleActivationParameters (int32 MuscleIndex, float InContractionVolumeScale, float InFiberLengthRatioAtMaxActivation, float InMuscleLengthRatioThresholdForMaxActivation, float InInflationVolumeScale)
 
CHAOS_API void UpdateGlobalLengthActivationCurve (const Chaos::FLinearCurve &InGlobalLengthActivationCurve)
 
CHAOS_API void UpdateLengthActivationCurve (int32 MuscleIndex, const Chaos::FLinearCurve &InLengthActivationCurve)
 
CHAOS_API Chaos::FLinearCurve GetLengthActivationCurve (int32 MuscleIndex) const
 
CHAOS_API TArray< TArray< TArray< FVector3f > > > BuildStreamlines (const TArray< int32 > &Origin, const TArray< int32 > &Insertion, int32 NumLinesMultiplier, int32 MaxStreamlineIterations, int32 MaxPointsPerLine)
 
CHAOS_API int32 AssignCurveName (const FString &CurveName, const FString &MuscleName)
 
CHAOS_API TArray< int32FindMuscleIndexByCurveName (const FString &CurveName) const
 

Static Public Attributes

static CHAOS_API const FName GroupName
 
static CHAOS_API const FName GeometryGroupIndex
 
static CHAOS_API const FName MuscleActivationElement
 
static CHAOS_API const FName OriginInsertionPair
 
static CHAOS_API const FName OriginInsertionRestLength
 
static CHAOS_API const FName FiberDirectionMatrix
 
static CHAOS_API const FName ContractionVolumeScale
 
static CHAOS_API const FName FiberLengthRatioAtMaxActivation
 
static CHAOS_API const FName MuscleLengthRatioThresholdForMaxActivation
 
static CHAOS_API const FName InflationVolumeScale
 
static CHAOS_API const FName FiberStreamline
 
static CHAOS_API const FName FiberStreamlineRestLength
 
static CHAOS_API const FName MuscleActivationCurveName
 
static CHAOS_API const FName LengthActivationCurve
 

Constructor & Destructor Documentation

◆ FMuscleActivationFacade() [1/2]

GeometryCollection::Facades::FMuscleActivationFacade::FMuscleActivationFacade ( FManagedArrayCollection InCollection)

◆ FMuscleActivationFacade() [2/2]

GeometryCollection::Facades::FMuscleActivationFacade::FMuscleActivationFacade ( const FManagedArrayCollection InCollection)

Member Function Documentation

◆ AddMuscleActivationData()

int32 GeometryCollection::Facades::FMuscleActivationFacade::AddMuscleActivationData ( const FMuscleActivationData InputData)

◆ AssignCurveName()

int32 GeometryCollection::Facades::FMuscleActivationFacade::AssignCurveName ( const FString &  CurveName,
const FString &  MuscleName 
)

◆ BuildStreamlines()

TArray< TArray< TArray< FVector3f > > > GeometryCollection::Facades::FMuscleActivationFacade::BuildStreamlines ( const TArray< int32 > &  Origin,
const TArray< int32 > &  Insertion,
int32  NumLinesMultiplier,
int32  MaxStreamlineIterations,
int32  MaxPointsPerLine 
)

◆ DefineSchema()

void GeometryCollection::Facades::FMuscleActivationFacade::DefineSchema ( )

Create the facade attributes.

◆ FindMuscleGeometryIndex()

int32 GeometryCollection::Facades::FMuscleActivationFacade::FindMuscleGeometryIndex ( const int32  MuscleIndex) const

◆ FindMuscleIndexByCurveName()

TArray< int32 > GeometryCollection::Facades::FMuscleActivationFacade::FindMuscleIndexByCurveName ( const FString &  CurveName) const

◆ FindMuscleIndexByName()

int32 GeometryCollection::Facades::FMuscleActivationFacade::FindMuscleIndexByName ( const FString  MuscleName) const

◆ FindMuscleName()

FString GeometryCollection::Facades::FMuscleActivationFacade::FindMuscleName ( const int32  MuscleIndex) const

◆ GetLengthActivationCurve()

Chaos::FLinearCurve GeometryCollection::Facades::FMuscleActivationFacade::GetLengthActivationCurve ( int32  MuscleIndex) const

◆ GetMuscleActivationData()

FMuscleActivationData GeometryCollection::Facades::FMuscleActivationFacade::GetMuscleActivationData ( const int32  DataIndex) const

◆ IsConst()

bool GeometryCollection::Facades::FMuscleActivationFacade::IsConst ( ) const
inline

Is the facade defined constant.

◆ IsValid()

bool GeometryCollection::Facades::FMuscleActivationFacade::IsValid ( ) const

Is the Facade defined on the collection?

◆ IsValidElementIndex()

bool GeometryCollection::Facades::FMuscleActivationFacade::IsValidElementIndex ( const int32  Index) const
inline

◆ IsValidGeometryIndex()

bool GeometryCollection::Facades::FMuscleActivationFacade::IsValidGeometryIndex ( const int32  Index) const
inline

◆ IsValidMuscleIndex()

bool GeometryCollection::Facades::FMuscleActivationFacade::IsValidMuscleIndex ( const int32  Index) const
inline

◆ MuscleVertexOffset()

int32 GeometryCollection::Facades::FMuscleActivationFacade::MuscleVertexOffset ( const int32  MuscleIndex) const

◆ NumMuscles()

int32 GeometryCollection::Facades::FMuscleActivationFacade::NumMuscles ( ) const
inline

◆ NumMuscleVertices()

int32 GeometryCollection::Facades::FMuscleActivationFacade::NumMuscleVertices ( const int32  MuscleIndex) const

◆ RemoveInvalidMuscles()

int32 GeometryCollection::Facades::FMuscleActivationFacade::RemoveInvalidMuscles ( )

◆ SetUpMuscleActivation()

bool GeometryCollection::Facades::FMuscleActivationFacade::SetUpMuscleActivation ( const TArray< int32 > &  Origin,
const TArray< int32 > &  Insertion,
float  ContractionVolumeScale = 1.f 
)

◆ UpdateGlobalLengthActivationCurve()

void GeometryCollection::Facades::FMuscleActivationFacade::UpdateGlobalLengthActivationCurve ( const Chaos::FLinearCurve InGlobalLengthActivationCurve)

◆ UpdateGlobalMuscleActivationParameters()

void GeometryCollection::Facades::FMuscleActivationFacade::UpdateGlobalMuscleActivationParameters ( float  InGlobalContractionVolumeScale,
float  InGlobalFiberLengthRatioAtMaxActivation,
float  InGlobalMuscleLengthRatioThresholdForMaxActivation,
float  InGlobalInflationVolumeScale 
)

◆ UpdateLengthActivationCurve()

void GeometryCollection::Facades::FMuscleActivationFacade::UpdateLengthActivationCurve ( int32  MuscleIndex,
const Chaos::FLinearCurve InLengthActivationCurve 
)

◆ UpdateMuscleActivationData()

bool GeometryCollection::Facades::FMuscleActivationFacade::UpdateMuscleActivationData ( const int32  DataIndex,
const FMuscleActivationData InputData 
)

◆ UpdateMuscleActivationParameters()

bool GeometryCollection::Facades::FMuscleActivationFacade::UpdateMuscleActivationParameters ( int32  MuscleIndex,
float  InContractionVolumeScale,
float  InFiberLengthRatioAtMaxActivation,
float  InMuscleLengthRatioThresholdForMaxActivation,
float  InInflationVolumeScale 
)

Member Data Documentation

◆ ContractionVolumeScale

const FName GeometryCollection::Facades::FMuscleActivationFacade::ContractionVolumeScale
static

◆ FiberDirectionMatrix

const FName GeometryCollection::Facades::FMuscleActivationFacade::FiberDirectionMatrix
static

◆ FiberLengthRatioAtMaxActivation

const FName GeometryCollection::Facades::FMuscleActivationFacade::FiberLengthRatioAtMaxActivation
static

◆ FiberStreamline

const FName GeometryCollection::Facades::FMuscleActivationFacade::FiberStreamline
static

◆ FiberStreamlineRestLength

const FName GeometryCollection::Facades::FMuscleActivationFacade::FiberStreamlineRestLength
static

◆ GeometryGroupIndex

const FName GeometryCollection::Facades::FMuscleActivationFacade::GeometryGroupIndex
static

◆ GroupName

const FName GeometryCollection::Facades::FMuscleActivationFacade::GroupName
static

◆ InflationVolumeScale

const FName GeometryCollection::Facades::FMuscleActivationFacade::InflationVolumeScale
static

◆ LengthActivationCurve

const FName GeometryCollection::Facades::FMuscleActivationFacade::LengthActivationCurve
static

◆ MuscleActivationCurveName

const FName GeometryCollection::Facades::FMuscleActivationFacade::MuscleActivationCurveName
static

◆ MuscleActivationElement

const FName GeometryCollection::Facades::FMuscleActivationFacade::MuscleActivationElement
static

◆ MuscleLengthRatioThresholdForMaxActivation

const FName GeometryCollection::Facades::FMuscleActivationFacade::MuscleLengthRatioThresholdForMaxActivation
static

◆ OriginInsertionPair

const FName GeometryCollection::Facades::FMuscleActivationFacade::OriginInsertionPair
static

◆ OriginInsertionRestLength

const FName GeometryCollection::Facades::FMuscleActivationFacade::OriginInsertionRestLength
static

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