1. Epic GamesDeveloper
  3. TStateStream

TStateStream

[TStateStream](API\Runtime\StateStream\TStateStream) is a generic implementation of [IStateStream](API\Runtime\StateStream\IStateStream) that contains all the boiler plate code related to ticks, interpolation, etc.

API > API/Runtime > API/Runtime/StateStream

TStateStream is a generic implementation of IStateStream that contains all the boiler plate code related to ticks, interpolation, etc. Should be the default goto implementation. Inherit this class for each type of state stream Provide a subclass of TStateStreamSettings as template parameter

   
Name TStateStream
Type class
Header File /Engine/Source/Runtime/StateStream/Public/GenericStateStream.h
Include Path #include "GenericStateStream.h"

Syntax

template<typename Settings>  
class TStateStream :  
    public IStateStream ,  
    public Settings::InterfaceType,  
    public IStateStreamHandleOwner

Inheritance Hierarchy

  • Settings::InterfaceType → TStateStream

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  GenericStateStream.h  
  GenericStateStream.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~TStateStream()

   GenericStateStream.h  

Structs

Name Remarks
FInstance Information about instance.
FTick Tick produced by game side.

Enums

Public

Name Remarks
TStateStream  

Typedefs

Name Type Remarks Include Path
FDynamicState typename InterfaceType::DynamicState   GenericStateStream.h
FHandle typename InterfaceType::Handle   GenericStateStream.h
FStaticState typename InterfaceType::StaticState   GenericStateStream.h
FUserDataType typename Settings::UserDataType   GenericStateStream.h
InterfaceType typename Settings::InterfaceType   GenericStateStream.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentTick FTick *   GenericStateStream.h  
CurrentTickLock FRWLock   GenericStateStream.h  
DeferredDestroys TArray< FInstance * >   GenericStateStream.h  
DynamicStates TStateStreamStore< FDynamicState >   GenericStateStream.h  
Instances TStateStreamStore< FInstance >   GenericStateStream.h  
NewestAvailableTick FTick *   GenericStateStream.h  
OldestAvailableTick FTick *   GenericStateStream.h  
RendTick FTick *   GenericStateStream.h  
RendTime StateStreamTime   GenericStateStream.h  
TickCounter uint32   GenericStateStream.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FHandle Game_CreateInstance ( const FStaticState& Ss,
const FDynamicState& Ds
)

 InterfaceType. GenericStateStream.h  

uint32 GetUsedDynamicstatesCount()

   GenericStateStream.h  

uint32 GetUsedInstancesCount()

 For unit tests. GenericStateStream.h  

const FDynamicState & Render_GetDynamicState ( const FHandle& Handle
)

   GenericStateStream.h  

FUserDataType *& Render_GetUserData ( const FHandle& Handle
)

   GenericStateStream.h  

virtual void Render_OnCreate ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData,
bool IsDestroyedInSameFrame
)

 Specialize to do custom things. GenericStateStream.h  

void Render_OnCreateInline ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData,
bool IsDestroyedInSameFrame
)

 ... or use template specialization to avoid virtual calls GenericStateStream.h  

virtual void Render_OnDestroy ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData
)

   GenericStateStream.h  

void Render_OnDestroyInline ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData
)

   GenericStateStream.h  

virtual void Render_OnUpdate ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData
)

   GenericStateStream.h  

void Render_OnUpdateInline ( const FStaticState& Ss,
const FDynamicState& Ds,
FUserDataType*& UserData
)

   GenericStateStream.h  

Overridden from IStateStream

Name Remarks Include Path Unreal Specifiers

virtual void DebugRender ( IStateStreamDebugRenderer& Renderer
)

   GenericStateStream.h  

virtual void Game_BeginTick()

 IStateStream (used by StateStreamManagerImpl) GenericStateStream.h  

virtual void Game_EndTick ( StateStreamTime AbsoluteTime
)

   GenericStateStream.h  

virtual void Game_Exit()

   GenericStateStream.h  

virtual void * Game_GetVoidPointer()

   GenericStateStream.h  

virtual const TCHAR * GetDebugName()

   GenericStateStream.h  

virtual uint32 GetId()

   GenericStateStream.h  

virtual void Render_Exit()

   GenericStateStream.h  

virtual void Render_GarbageCollect()

   GenericStateStream.h  

virtual void Render_PostUpdate()

   GenericStateStream.h  

virtual void Render_Update ( StateStreamTime AbsoluteTime
)

   GenericStateStream.h  

Overridden from IStateStreamHandleOwner

Name Remarks Include Path Unreal Specifiers

virtual void Game_AddRef ( uint32 HandleId
)

 IStateStreamHandleOwner (used by state stream handles on game side) GenericStateStream.h  

virtual void * Game_Edit ( uint32 HandleId,
double TimeFactor,
uint64 UserData
)

   GenericStateStream.h  

virtual void Game_Release ( uint32 HandleId
)

   GenericStateStream.h  

virtual void Game_Update ( uint32 HandleId,
const void* Ds,
double TimeFactor,
uint64 UserData
)

   GenericStateStream.h  

virtual void * Render_GetUserData ( uint32 HandleId
)

   GenericStateStream.h  

Protected

Name Remarks Include Path Unreal Specifiers

FDynamicState & Edit ( uint32 HandleId,
double TimeFactor
)

   GenericStateStream.h  

void Update ( uint32 HandleId,
const InDynamicState& Ds,
double TimeFactor
)

   GenericStateStream.h  

Operators

Name Remarks Include Path Unreal Specifiers

TStateStream & operator= ( const TStateStream&
)

   GenericStateStream.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page