C# Class GAudio.AGATPulseClient

You can extend this base class and override OnPulse for custom handling of pulse signals fired by MasterPulseModule and SubPulseModule. Inheriting from this class provides automatic subscription to a pulse and the option to subscribe to only specific step indexes.

Inheritance: UnityEngine.MonoBehaviour, IGATPulseClient

Mostra file Open project: gregzo/G-Audio

Public Methods

Method	Description
OnPulse ( IGATPulseInfo pulseInfo ) : void	Check if _subscribedSteps[ pulseInfo.StepIndex ] when overriding.

Protected Methods

Method	Description
Awake ( ) : void	Call base.Awake() first if you override
CanSubscribeToPulse ( ) : bool	You can override this method to add constraints
IGATPulseClient ( bool newSteps ) : void
NewPulseStepShouldStartChecked ( int stepIndex ) : bool	If a new step has been added to the pulse, should _subscribedSteps[ stepIndex ] start true?
OnDisable ( ) : void	Call base.OnDisable() first if you override
OnEnable ( ) : void	Call base.OnEnable() first if you override
SubscribeToPulseIfNeeded ( ) : void	If CanSubscribeToPulse() is true, will subscribe
UnsubscribeToPulse ( ) : void	Unsubscribes to the pulse.
UpdateSubscribedSteps ( bool newSteps ) : void

Method Details

Awake() protected method

Call base.Awake() first if you override

protected Awake ( ) : void
return	void

CanSubscribeToPulse() protected method

You can override this method to add constraints

protected CanSubscribeToPulse ( ) : bool
return	bool

IGATPulseClient() protected method

protected IGATPulseClient ( bool newSteps ) : void
newSteps	bool
return	void

NewPulseStepShouldStartChecked() protected method

If a new step has been added to the pulse, should _subscribedSteps[ stepIndex ] start true?

protected NewPulseStepShouldStartChecked ( int stepIndex ) : bool
stepIndex	int
return	bool

OnDisable() protected method

Call base.OnDisable() first if you override

protected OnDisable ( ) : void
return	void

OnEnable() protected method

Call base.OnEnable() first if you override

protected OnEnable ( ) : void
return	void

OnPulse() public abstract method

Check if _subscribedSteps[ pulseInfo.StepIndex ] when overriding.

public abstract OnPulse ( IGATPulseInfo pulseInfo ) : void
pulseInfo	IGATPulseInfo
return	void

SubscribeToPulseIfNeeded() protected method

If CanSubscribeToPulse() is true, will subscribe

protected SubscribeToPulseIfNeeded ( ) : void
return	void

UnsubscribeToPulse() protected method

Unsubscribes to the pulse.

protected UnsubscribeToPulse ( ) : void
return	void

UpdateSubscribedSteps() protected method

protected UpdateSubscribedSteps ( bool newSteps ) : void
newSteps	bool
return	void