1. Epic GamesDeveloper
  3. UGeometryCacheComponent

UGeometryCacheComponent

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

Unreal Engine C++ API Reference > Plugins > GeometryCache

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=(Rendering), HideCategories=(Object, LOD), Meta=(BlueprintSpawnableComponent))  
class UGeometryCacheComponent : public UMeshComponent

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bExtrapolateFrames Enable frame extrapolation for sub-frame sampling of non-constant topologies with imported motion vectors
Protected variable UProperty Category, EditAnywhere, Interp bool bLooping  
Protected variable UProperty Category, EditAnywhere bool bManualTick  
Protected variable UProperty Category, EditAnywhere bool bOverrideWireframeColor Do we override the wireframe rendering color?
Protected variable UProperty Category, EditAnywhere, Interp bool bRunning  
Protected variable UProperty Category BlueprintReadOnly float Duration Duration of the animation (maximum time)
Protected variable UProperty Category Transient visibleanywhere float ElapsedTime  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UGeometryCache > GeometryCache Geometry Cache instance referenced by the component
Protected variable FBoxSphereBounds LocalBounds Component local space bounds of geometry cache mesh
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MotionVectorScale Scale factor to apply to the imported motion vectors
Protected variable UProperty Category visibleanywhere int32 NumTracks  
Protected variable UProperty Category, EditAnywhere, Interp, Meta float PlaybackSpeed  
Protected variable float PlayDirection Play (time) direction, either -1.0f or 1.0f
Protected variable UProperty Category, EditAnywhere, Interp, Meta float StartTimeOffset  
Protected variable TArray< FTrackRenderData > TrackSections Array containing the TrackData (used for rendering) for each individual track
Protected variable UProperty Category, EditAnywhere, Meta FLinearColor WireframeOverrideColor The wireframe override color.

Constructors

  Type Name Description
Public function  

UGeometryCacheComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void ClearTrackData Clean up data that was required for playback of geometry cache tracks
Protected function void

CreateTrackSection ( int32 TrackIndex
)

 CreateTrackSection, Create/replace a track section.
Public function Const UFunction BlueprintCallable, Category float Set the current animation time for GeometryCache.
Public function Const UFunction BlueprintCallable, Category float Get the duration of the playback
Public function Const int32

GetFrameAtTime ( const float Time
)

 Helper to get the frame of the ABC asset at this time
Public function Const UGeometryCache * Getter for Geometry cache instance referred by the component Note: This getter is not exposed to blueprints as you can use the readonly Uproperty for that
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category float Get the motion vector scale.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of frames
Public function Const UFunction BlueprintCallable, Category bool Check whether we are overriding the wireframe color or not.
Public function Const UFunction BlueprintCallable, Category float Set the current animation time for GeometryCache.
Public function Const UFunction BlueprintCallable, Category float Get current playback speed for GeometryCache.
Public function Const UFunction BlueprintCallable, Category float Get current start time offset for GeometryCache.
Public function Const float

GetTimeAtFrame ( const int32 Frame
)

 Helper to get the time at this frame
Public function Const UFunction BlueprintCallable, Category FLinearColor Get the wireframe override color, used when overriding the wireframe color is enabled.
Protected function void Invalidate both the Matrix and Mesh sample indices
Public function Const UFunction BlueprintCallable, Category bool Get whether this GeometryCache is extrapolating frames.
Public function Const UFunction BlueprintCallable, Category bool Get whether this GeometryCache is looping or not.
Public function Const UFunction BlueprintCallable, Category bool Get whether this GeometryCache is playing or not.
Public function Const UFunction BlueprintCallable, Category bool Get whether this GeometryCache is playing in reverse or not.
Public function void

OnObjectReimported ( UGeometryCache* ImportedGeometryCache
)

 OnObjectReimported, Callback function to refresh section data and update scene proxy.
Public function UFunction BlueprintCallable, Category void

Pause ()

 Pause playback of GeometryCache
Public function UFunction BlueprintCallable, Category void

Play ()

 Start playback of GeometryCache
Public function UFunction BlueprintCallable, Category void Start playback of GeometryCache from the start
Public function UFunction BlueprintCallable, Category void Start playback of GeometryCache in reverse
Public function UFunction BlueprintCallable, Category void Start playback of GeometryCache from the end and play in reverse
Protected function void ReleaseResources, clears and removes data stored/copied from GeometryCache instance
Public function void  
Public function UFunction BlueprintCallable, Category void

SetExtrapolateFrames ( const bool bNewExtrapolating
)

 Set whether this GeometryCache is extrapolating frames.
Public function UFunction BlueprintCallable, Category bool

SetGeometryCache ( UGeometryCache* NewGeomCache
)

 Change the Geometry Cache used by this instance.
Public function UFunction BlueprintCallable, Category void

SetLooping ( const bool bNewLooping
)

 Set whether this GeometryCache is looping or not.
Public function void

SetManualTick ( bool bInManualTick
)

 Functions to override the default TickComponent
Public function UFunction BlueprintCallable, Category void

SetMotionVectorScale ( const float NewMotionVectorScale
)

 Set new motion vector scale.
Public function UFunction BlueprintCallable, Category void

SetOverrideWireframeColor ( bool bOverride
)

 Override wireframe color?
Public function UFunction BlueprintCallable, Category void

SetPlaybackSpeed ( const float NewPlaybackSpeed
)

 Set new playback speed for GeometryCache.
Public function UFunction BlueprintCallable, Category void

SetStartTimeOffset ( const float NewStartTimeOffset
)

 Set current start time offset for GeometryCache.
Protected function void SetupTrackData Call CreateTrackSection for all tracks in the GeometryCache assigned to this object.
Public function UFunction BlueprintCallable, Category void Set the color, used when overriding the wireframe color is enabled.
Public function UFunction BlueprintCallable, Category void

Stop ()

 Stop playback of GeometryCache
Public function UFunction BlueprintCallable, Category void

TickAtThisTime ( const float Time,
bool bInIsRunning,
bool bInBackwards,
bool bInIsLooping
)

  
Public function void Update LocalBounds member from the local box of each section
Protected function bool

UpdateTrackSection ( int32 TrackIndex,
float Time
)

 Updates the game thread state of a track section

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 MaterialIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32

GetMaterialIndex ( FName MaterialSlotName
)

  
Public function Virtual Const TArray< FName >  
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called to finish destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called before applying a transaction to the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page