Quantum 3 3.1.0

Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
Quantum.Task.SystemThreadedComponent< T > Class Template Referenceabstract

A multi-threaded system to parallelize updating components. More...

Inheritance diagram for Quantum.Task.SystemThreadedComponent< T >:
Quantum.SystemBase

Public Member Functions

sealed override void OnInit (Frame frame)
 Is called when the system is initialized.
 
abstract void Update (FrameThreadSafe frame, EntityRef entity, T *component)
 
- Public Member Functions inherited from Quantum.SystemBase
 SystemBase ()
 Create a new instance of a system without children. More...
 
 SystemBase (params SystemBase[] children)
 Create a new instance of a system with children. More...
 
 SystemBase (string scheduleSample)
 Create a new instance of a system without children. More...
 
void Disable (Frame frame)
 
void Enable (Frame frame)
 
bool IsEnabledInHierarchy (Frame frame)
 
bool IsEnabledSelf (Frame frame)
 
virtual void OnDisabled (Frame frame)
 Is called when the system was disabled, for example after calling Frame.SystemDisable(Type). The base implementation calls OnDisabled on the child systems that are enabled themselves. More...
 
virtual void OnEnabled (Frame frame)
 Is called when the system was enabled, for example after calling Frame.SystemEnable<T>() or when the game starts with StartEnabled set. The base implementation calls OnEnabled on the child systems that are enabled themselves. More...
 
virtual void OnResync (Frame frame)
 Is called when the simulation is about to start from a snapshot. More...
 
TaskHandle OnSchedule (Frame frame, TaskHandle taskHandle)
 Creates the task graph for the system by calling Schedule and then scheduling the enabled child systems. Exceptions thrown by the children are collected and thrown after all systems were scheduled, so the task handles of the other children are kept. More...
 

Public Attributes

virtual int SliceSize => DEFAULT_SLICE_SIZE
 

Static Public Attributes

const int DEFAULT_SLICE_SIZE = 16
 The default slide size. More...
 

Protected Member Functions

virtual void OnInitUser (Frame frame)
 
override TaskHandle Schedule (Frame frame, TaskHandle taskHandle)
 Override to add tasks to this system.
 

Additional Inherited Members

- Properties inherited from Quantum.SystemBase
IEnumerable< SystemBase > ChildSystems [get]
 The direct child systems of this system. More...
 
IEnumerable< SystemBase > Hierarchy [get]
 Enumerates this system and all of its descendants, depth-first. More...
 
SystemBase ParentSystem [get]
 The parent system in the system hierarchy. More...
 
string ProfilerName [get]
 The name of the system in the profiler, defaults to the type name. More...
 
Int32 RuntimeIndex [get]
 A unique index assigned to identify systems at runtime. More...
 
virtual Boolean StartEnabled [get, set]
 Set to true when the simulation should start with this system enabled. More...
 

Detailed Description

A multi-threaded system to parallelize updating components.

Threaded task: the threads will iterate over a component buffer with a size that is not known at Schedule time. Each thread will acquire a slice of a given (configurable) size until the end of the buffer is reached. While iterating over a slice, the thread will call the Update() method that can be implemented by the inheritor system, passing a FrameThreadSafe, the EntityRef and a T*.

Only access to the component itself and FrameThreadSafe is safe.

For more information request access to the online multi-threading documentation.

Template Parameters
T
Type Constraints
T :unmanaged 
T :IComponent 

Member Data Documentation

◆ DEFAULT_SLICE_SIZE

const int Quantum.Task.SystemThreadedComponent< T >.DEFAULT_SLICE_SIZE = 16
static

The default slide size.