API reference

UpdateDriverGroup Class

Extends MonoBehaviour
Implements IUpdateDriver
An UpdateDriverGroup updates a set of IUpdateDrivers a specified number of times per update.
It acts as the root driver for a provided set of IUpdateDrivers.

Protected Fields

Drivers : List< IUpdateDriver >
Signature
List<IUpdateDriver> Drivers

Properties

IsRootDriver : bool
[Get][Set]
Returns true if the current instance is responsible for invoking its own Drive method, false otherwise.
If this IUpdateDriver is not a root driver, then some other instance (typically another IUpdateDriver) is responsible for invoking execution. In this way, IUpdateDriver instances form a tree, with Drive execution beginning from the root.
Signature
bool IsRootDriver
Iterations : int
[Get][Set]
Signature
int Iterations

Protected Methods

Awake ()
Signature
virtual void Awake()
Returns
void
Start ()
Signature
virtual void Start()
Returns
void
Update ()
Signature
virtual void Update()
Returns
void

Methods

Drive ()
Runs the processing to "update" the current instance.
This is conceptually similar to Unity's built-in update mechanism, but bound to a structure which allows execution order to be more explicitly controlled. This is part of Interaction SDK core logic, and it is not recommended that direct dependencies be taken on this execution order. Instead, changes to interaction state should be handled by observing events such as IInteractorView.WhenStateChanged, which will allow correct handling without depending on the details of execution order.
Signature
void Drive()
Returns
void
InjectAllUpdateDriverGroup ( updateDrivers )
Signature
void InjectAllUpdateDriverGroup(List< IUpdateDriver > updateDrivers)
Parameters
updateDrivers: List< IUpdateDriver >
Returns
void
InjectUpdateDrivers ( updateDrivers )
Signature
void InjectUpdateDrivers(List< IUpdateDriver > updateDrivers)
Parameters
updateDrivers: List< IUpdateDriver >
Returns
void