Quantum.SystemBase Class Reference

The Quantum system base class. More...

Inheritance diagram for Quantum.SystemBase:

Public Member Functions
	SystemBase ()
	Constructor. More...
	SystemBase (params SystemBase[] children)
	Create a new instance of a system with children. More...
	SystemBase (string scheduleSample)
	Create a new instance and setting the sample name. More...
virtual void	OnDisabled (Frame f)
	Is called when the system was disabled for example after Frame.SystemDisable(Type). More...
virtual void	OnEnabled (Frame f)
	Is called when the system was enabled for example after calling Frame.SystemEnable<T>() or during QuantumGame.InitSystems(Photon.Deterministic.DeterministicFrame). More...
virtual void	OnInit (Frame f)
	Is called when the system is initialized. More...
TaskHandle	OnSchedule (Frame f, TaskHandle taskHandle)
	Creates the task graph for the system. More...

Protected Member Functions
abstract TaskHandle	Schedule (Frame f, TaskHandle taskHandle)
	Override to add tasks to this system. More...

Properties
IEnumerable< SystemBase >	ChildSystems [get]
	The enumerable child systems. More...
IEnumerable< SystemBase >	Hierarchy [get]
	Creates the complete sub graph of child systems. More...
SystemBase	ParentSystem [get]
	The parent system in the system hierarchy. More...
string	ProfilerName [get]
	Profiler 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

The Quantum system base class.

Only advised for advanced uses only.

Constructor & Destructor Documentation

SystemBase() [1/3]

Quantum.SystemBase.SystemBase ( )

inline

Constructor.

SystemBase() [2/3]

Quantum.SystemBase.SystemBase ( string  scheduleSample )

inline

Create a new instance and setting the sample name.

Parameters

scheduleSample

The name of the system to identify in the profiler.

SystemBase() [3/3]

Quantum.SystemBase.SystemBase ( params SystemBase[]  children )

inline

Create a new instance of a system with children.

Parameters

children

Children systems to create a hierarchy to toggle.

Member Function Documentation

OnInit()

virtual void Quantum.SystemBase.OnInit ( Frame  f )

inlinevirtual

Is called when the system is initialized.

Parameters

f	The referenced frame.

Reimplemented in Quantum.Core.PhysicsSystem3D, Quantum.Task.SystemThreadedFilter< T >, Quantum.Task.SystemArrayFilter< T >, Quantum.Task.SystemThreadedComponent< T >, Quantum.Task.SystemArrayComponent< T >, Quantum.Core.EntityPrototypeSystem, and Quantum.Core.PhysicsSystem2D.

OnEnabled()

virtual void Quantum.SystemBase.OnEnabled ( Frame  f )

inlinevirtual

Is called when the system was enabled for example after calling Frame.SystemEnable<T>() or during QuantumGame.InitSystems(Photon.Deterministic.DeterministicFrame).

Parameters

f	The referenced frame.

OnDisabled()

virtual void Quantum.SystemBase.OnDisabled ( Frame  f )

inlinevirtual

Is called when the system was disabled for example after Frame.SystemDisable(Type).

Parameters

f	The referenced frame.

OnSchedule()

TaskHandle Quantum.SystemBase.OnSchedule ( Frame  f, TaskHandle  taskHandle  )

inline

Creates the task graph for the system.

Parameters

f	The referenced frame.
taskHandle	The initial task handle.

Returns

The system task graph.

Schedule()

abstract TaskHandle Quantum.SystemBase.Schedule ( Frame  f, TaskHandle  taskHandle  )

protectedpure virtual

Override to add tasks to this system.

Parameters

f	The referenced frame.
taskHandle	The initial task handle.

Returns

The system task graph.

Implemented in Quantum.Core.PhysicsSystem3D, Quantum.SystemMainThread, Quantum.Task.SystemThreadedFilter< T >, Quantum.Task.SystemArrayFilter< T >, Quantum.Task.SystemArrayComponent< T >, Quantum.Task.SystemThreadedComponent< T >, Quantum.SystemMainThreadGroup, Quantum.SystemGroup, Quantum.Core.CullingSystem3D, Quantum.Core.PhysicsSystem2D, Quantum.Core.NavigationSystem, Quantum.SystemSignalsOnly, and Quantum.Core.CullingSystem2D.

Property Documentation

RuntimeIndex

Int32 Quantum.SystemBase.RuntimeIndex

get

A unique index assigned to identify systems at runtime.

ParentSystem

SystemBase Quantum.SystemBase.ParentSystem

get

The parent system in the system hierarchy.

ChildSystems

IEnumerable<SystemBase> Quantum.SystemBase.ChildSystems

get

The enumerable child systems.

Hierarchy

IEnumerable<SystemBase> Quantum.SystemBase.Hierarchy

get

Creates the complete sub graph of child systems.

StartEnabled

virtual Boolean Quantum.SystemBase.StartEnabled

getset

Set to true when the simulation should start with this system enabled.

ProfilerName

string Quantum.SystemBase.ProfilerName

getprotected

Profiler name.