UGroomCache

Implements an asset that is used to store an animated groom

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

HairStrandsCore

Header

/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsCore/Public/GroomCache.h

Include

#include "GroomCache.h"

Syntax

UCLASS(BlueprintType)
class UGroomCache :
    public UObject,
    public IInterface_AssetUserData

Remarks

Implements an asset that is used to store an animated groom

Variables

Name Description

Public variable UProperty Category instanced, visibleanywhere

TObjectPtr< cla...

 

AssetImportData

Import options used for this GroomCache

Protected variable

TArray< FGroomC...

 

Chunks

Protected variable UProperty Category visibleanywhere

FGroomCacheInfo

 

GroomCacheInfo

Functions

Name Description

Public function

TArray< FGro...

 

GetChunks()

Public function Const

float

 

GetDuration()

Public function Const

int32

 

GetEndFrame()

Public function Const

int32

 

GetFrameIndexAtTime

(
    const float Time,
    bool bLooping
)

Get the (floored) frame index at the specified time with the index 0 being the start of the animation

Public function

void

 

GetFrameIndicesAtTime

(
    float Time,
    bool bLooping,
    bool bIsPlayingBackwards,
    int32& OutFrameIndex,
    int32& OutNextFrameIndex,
    float& InterpolationFactor
)

Get the frame indices and interpolation factor between them that correspond to the specified time

Public function

void

 

GetFrameIndicesForTimeRange

(
    float StartTime,
    float EndTime,
    bool Looping,
    TArray< int32 >& OutFrameIndices
)

Get the frame indices that correspond to the specified time range

Public function Const

int32

 

GetFrameNumberAtTime

(
    const float Time,
    bool bLooping
)

Get the frame number at the specified time within the animation range which might not start at 0

Public function Const

const FGroom...

 

GetGroomAnimationInfo()

Public function

bool

 

GetGroomDataAtFrameIndex

(
    int32 FrameIndex,
    FGroomCacheAnimationData& AnimData
)

Public function

bool

 

GetGroomDataAtTime

(
    float Time,
    bool bLooping,
    FGroomCacheAnimationData& AnimData
)

Public function Const

int32

 

GetStartFrame()

Public function Const

EGroomCacheT...

 

GetType()

Public function

void

 

Initialize

(
    EGroomCacheType Type
)

Public function

void

 

SetGroomAnimationInfo

(
    const FGroomAnimationInfo& AnimInf...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.