1. Epic GamesDeveloper
  3. UGeometryCacheComponent

UGeometryCacheComponent

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

API > API/Plugins > API/Plugins/GeometryCache

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

   
Name UGeometryCacheComponent
Type class
Header File /Engine/Plugins/Runtime/GeometryCache/Source/GeometryCache/Classes/GeometryCacheComponent.h
Include Path #include "GeometryCacheComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UGeometryCacheComponent ( const FObjectInitializer& ObjectInitializer
)

   GeometryCacheComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GeometryCache TObjectPtr< UGeometryCache > Geometry Cache instance referenced by the component GeometryCacheComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=GeometryCache

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BackwardEnd()

   GeometryCacheComponent.h  

void ForwardEnd()

   GeometryCacheComponent.h  

float GetAnimationTime ()

 Get the current animation time for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetDuration()

 Get the duration of the playback GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetElapsedTime()

 Get the current elapsed time for GeometryCache. Doesn't include the influence of StartTimeOffset GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

int32 GetFrameAtTime ( const float Time
) const

 Helper to get the frame of the ABC asset at time provided GeometryCacheComponent.h  

UGeometryCache * GetGeometryCache()

 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 GeometryCacheComponent.h  

bool GetManualTick()

   GeometryCacheComponent.h  

float GetMotionVectorScale()

 Get the motion vector scale. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

int32 GetNumberOfFrames()

 Get the number of frames GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

int32 GetNumberOfTracks()

 Get the number of tracks GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool GetOverrideWireframeColor()

 Check whether we are overriding the wireframe color or not. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetPlaybackDirection()

 Get the playback direction for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetPlaybackSpeed()

 Get current playback speed for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetStartTimeOffset()

 Get current start time offset for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

float GetTimeAtFrame ( const int32 Frame
) const

 Helper to get the time at this frame GeometryCacheComponent.h  

TArray< FString > GetTrackNames()

   GeometryCacheComponent.h  

FLinearColor GetWireframeOverrideColor()

 Get the wireframe override color, used when overriding the wireframe color is enabled. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool IsExtrapolatingFrames()

 Get whether this GeometryCache is extrapolating frames. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool IsLooping()

 Get whether this GeometryCache is looping or not. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool IsPlaying()

 Get whether this GeometryCache is playing or not. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool IsPlayingReversed()

 Get whether this GeometryCache is playing in reverse or not. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void OnObjectReimported ( UGeometryCache* ImportedGeometryCache
)

 OnObjectReimported, Callback function to refresh section data and update scene proxy. GeometryCacheComponent.h  

void Pause()

 Pause playback of GeometryCache GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void Play()

 Start playback of GeometryCache GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void PlayFromStart()

 Start playback of GeometryCache from the start GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void PlayReversed()

 Start playback of GeometryCache in reverse GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void PlayReversedFromEnd()

 Start playback of GeometryCache from the end and play in reverse GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void ResetAnimationTime()

   GeometryCacheComponent.h  

void SetCurrentTime ( const float Time
)

 Helper to make the animation jump to this time GeometryCacheComponent.h  

void SetExtrapolateFrames ( const bool bNewExtrapolating
)

 Set whether this GeometryCache is extrapolating frames. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

bool SetGeometryCache ( UGeometryCache* NewGeomCache
)

 Change the Geometry Cache used by this instance. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetLooping ( const bool bNewLooping
)

 Set whether this GeometryCache is looping or not. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetManualTick ( bool bInManualTick
)

 Functions to override the default TickComponent GeometryCacheComponent.h  

void SetMotionVectorScale ( const float NewMotionVectorScale
)

 Set new motion vector scale. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetOverrideWireframeColor ( bool bOverride
)

 Override wireframe color? GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetPlaybackSpeed ( const float NewPlaybackSpeed
)

 Set new playback speed for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetStartTimeOffset ( const float NewStartTimeOffset
)

 Set current start time offset for GeometryCache. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void SetWireframeOverrideColor ( const FLinearColor Color
)

 Set the color, used when overriding the wireframe color is enabled. GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void StepBackward()

   GeometryCacheComponent.h  

void StepForward()

 Animation Helpers for Transport Controls. GeometryCacheComponent.h  

void Stop()

 Stop playback of GeometryCache GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

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

   GeometryCacheComponent.h
  • BlueprintCallable
  • Category="Components|GeometryCache"

void ToggleLooping()

   GeometryCacheComponent.h  
Update LocalBounds member from the local box of each section GeometryCacheComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   GeometryCacheComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 MaterialIndex
) const

   GeometryCacheComponent.h  

virtual int32 GetMaterialIndex ( FName MaterialSlotName
) const

   GeometryCacheComponent.h  

virtual TArray< FName > GetMaterialSlotNames()

   GeometryCacheComponent.h  

virtual int32 GetNumMaterials()

   GeometryCacheComponent.h  

virtual bool IsMaterialSlotNameValid ( FName MaterialSlotName
) const

   GeometryCacheComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   GeometryCacheComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnRegister()

   GeometryCacheComponent.h  

virtual void OnUnregister()

   GeometryCacheComponent.h  

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

   GeometryCacheComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GeometryCacheComponent.h  

virtual void FinishDestroy()

   GeometryCacheComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   GeometryCacheComponent.h  

virtual void PostEditUndo()

   GeometryCacheComponent.h  

virtual void PostLoad()

   GeometryCacheComponent.h  

virtual void PreEditUndo()

   GeometryCacheComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearTrackData()

 ClearTrackData Clean up data that was required for playback of geometry cache tracks GeometryCacheComponent.h  

void CreateTrackSection ( int32 TrackIndex
)

 CreateTrackSection, Create/replace a track section. GeometryCacheComponent.h  

void InvalidateTrackSampleIndices()

 Invalidate both the Matrix and Mesh sample indices GeometryCacheComponent.h  

void JumpAnimationToTime ( float Time,
bool bInIsRunning,
bool bInBackwards,
bool bInIsLooping
)

 Jumps animation to time specified. GeometryCacheComponent.h  

void ReleaseResources()

 ReleaseResources, clears and removes data stored/copied from GeometryCache instance GeometryCacheComponent.h  

void SetupTrackData()

 SetupTrackData Call CreateTrackSection for all tracks in the GeometryCache assigned to this object. GeometryCacheComponent.h  

void StepAnimationFrame ( bool bInBackwards
)

 Helper method to tick animation by one frame in PlayDirection GeometryCacheComponent.h  

bool UpdateTrackSection ( int32 TrackIndex,
float Time
)

 Updates the game thread state of a track section GeometryCacheComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page