Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > GeometryCache > UGeometryCacheComponent

Light Theme

Dark Theme

UGeometryCacheComponent

GeometryCacheComponent, encapsulates a GeometryCache asset instance and implements functionality for rendering/and playback of GeometryCaches

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UGeometryCacheComponent

	UGeometryCacheAbcFileComponent
	UGeometryCacheUsdComponent

References

Module	GeometryCache
Header	/Engine/Plugins/Experimental/GeometryCache/Source/GeometryCache/Classes/GeometryCacheComponent.h
Include	#include "GeometryCacheComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(Rendering, Common), HideCategories=(Object, LOD),
Meta=(BlueprintSpawnableComponent), Experimental, ClassGroup=Experimental)
class UGeometryCacheComponent : public UMeshComponent

Remarks

GeometryCacheComponent, encapsulates a GeometryCache asset instance and implements functionality for rendering/and playback of GeometryCaches

Variables

	Name	Description
bool	bExtrapolateFrames	Enable frame extrapolation for sub-frame sampling of non-constant topologies with imported motion vectors
bool	bLooping
bool	bManualTick
bool	bRunning
float	Duration	Duration of the animation (maximum time)
float	ElapsedTime
UGeometryCache ...	GeometryCache	Geometry Cache instance referenced by the component
FBoxSphereBound...	LocalBounds	Component local space bounds of geometry cache mesh
float	MotionVectorScale	Scale factor to apply to the imported motion vectors
int32	NumTracks
float	PlaybackSpeed
float	PlayDirection	Play (time) direction, either -1.0f or 1.0f
float	StartTimeOffset
TArray< FTrackR...	TrackSections	Array containing the TrackData (used for rendering) for each individual track

Constructors

	Name	Description
	UGeometryCacheComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	ClearTrackData()	ClearTrackData Clean up data that was required for playback of geometry cache tracks
void	CreateTrackSection ( int32 TrackIndex )	CreateTrackSection, Create/replace a track section.
float	GetAnimationTime()	Set the current animation time for GeometryCache.
float	GetDuration()	Get the duration of the playback
int32	GetFrameAtTime ( const float Time )	Helper to get the frame of the ABC asset at this time
UGeometryCac...	GetGeometryCache()	Getter for Geometry cache instance referred by the component
bool	GetManualTick()
float	GetMotionVectorScale()	Get the motion vector scale.
int32	GetNumberOfFrames()	Get the number of frames
float	GetPlaybackDirection()	Set the current animation time for GeometryCache.
float	GetPlaybackSpeed()	Get current playback speed for GeometryCache.
float	GetStartTimeOffset()	Get current start time offset for GeometryCache.
float	GetTimeAtFrame ( const int32 Frame )	Helper to get the time at this frame
void	InvalidateTrackSampleIndices()	Invalidate both the Matrix and Mesh sample indices
bool	IsExtrapolatingFrames()	Get whether this GeometryCache is extrapolating frames.
bool	IsLooping()	Get whether this GeometryCache is looping or not.
bool	IsPlaying()	Get whether this GeometryCache is playing or not.
bool	IsPlayingReversed()	Get whether this GeometryCache is playing in reverse or not.
void	OnObjectReimported ( UGeometryCache* ImportedGeomet... )	OnObjectReimported, Callback function to refresh section data and update scene proxy.
void	Pause()	Pause playback of GeometryCache
void	Play()	Start playback of GeometryCache
void	PlayFromStart()	Start playback of GeometryCache from the start
void	PlayReversed()	Start playback of GeometryCache in reverse
void	PlayReversedFromEnd()	Start playback of GeometryCache from the end and play in reverse
void	ReleaseResources()	ReleaseResources, clears and removes data stored/copied from GeometryCache instance
void	ResetAnimationTime()
void	SetExtrapolateFrames ( const bool bNewExtrapolating )	Set whether this GeometryCache is extrapolating frames.
bool	SetGeometryCache ( UGeometryCache* NewGeomCache )	Change the Geometry Cache used by this instance.
void	SetLooping ( const bool bNewLooping )	Set whether this GeometryCache is looping or not.
void	SetManualTick ( bool bInManualTick )	Functions to override the default TickComponent
void	SetMotionVectorScale ( const float NewMotionVectorScale )	Set new motion vector scale.
void	SetPlaybackSpeed ( const float NewPlaybackSpeed )	Set new playback speed for GeometryCache.
void	SetStartTimeOffset ( const float NewStartTimeOffset )	Set current start time offset for GeometryCache.
void	SetupTrackData()	SetupTrackData Call CreateTrackSection for all tracks in the GeometryCache assigned to this object.
void	Stop()	Stop playback of GeometryCache
void	TickAtThisTime ( const float Time, bool bInIsRunning, bool bInBackwards, bool bInIsLooping )
void	UpdateLocalBounds()	Update LocalBounds member from the local box of each section
bool	UpdateTrackSection ( int32 TrackIndex )	Updates the game thread state of a track section

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
int32	GetNumMaterials()	Return number of material elements in this primitive

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

	Name	Description
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	FinishDestroy()	Called to finish destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditUndo()	Called before applying a transaction to the object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss