Synth8.BaseOscillator Class Reference

The base class to all oscillator nodes. More...

Inheritance diagram for Synth8.BaseOscillator:

Public Member Functions
override void	Init ()
	Called when initializing the node. More...
override void	Randomize ()
	Called when randomizing the node's parameters. More...
override float	GetSample ()
	The node's main method. This return is used to pass values to other nodes. More...
override void	OnSetTime (float length, float time)
	Called when jumping to a certain time of the audio being rendered. More...
override void	OnUpdateTime (float length, float deltaTime, float time)
	Called when updating the position in time of the audio being rendered. More...

Public Attributes
Wave	wave
	The wave node that controls the oscillation. More...
SynthModulatedParameter	amplitude = new SynthModulatedParameter( 1.0f )
	The amplitude of the oscillation. More...
Public Attributes inherited from Synth8.SynthClipNode
int	x
	The node's x position in the graph. More...
int	y
	The node's y position in the graph. More...

Protected Member Functions
virtual float	GetHertz (float length, float time)
	The the hertz frequency of the oscillator at the given time. More...

Detailed Description

The base class to all oscillator nodes.

Member Function Documentation

virtual float Synth8.BaseOscillator.GetHertz ( float  length, float  time  )

protectedvirtual

The the hertz frequency of the oscillator at the given time.

Parameters

length
time

Returns

Reimplemented in Synth8.LFO, and Synth8.Oscillator.

override float Synth8.BaseOscillator.GetSample ( )

virtual

The node's main method. This return is used to pass values to other nodes.

Returns

Reimplemented from Synth8.SynthClipNode.

override void Synth8.BaseOscillator.Init ( )

virtual

Called when initializing the node.

Reimplemented from Synth8.SynthClipNode.

override void Synth8.BaseOscillator.OnSetTime ( float  length, float  time  )

virtual

Called when jumping to a certain time of the audio being rendered.

Parameters

length
time

Reimplemented from Synth8.SynthClipNode.

override void Synth8.BaseOscillator.OnUpdateTime ( float  length, float  deltaTime, float  time  )

virtual

Called when updating the position in time of the audio being rendered.

Parameters

length
deltaTime
time

Reimplemented from Synth8.SynthClipNode.

override void Synth8.BaseOscillator.Randomize ( )

virtual

Called when randomizing the node's parameters.

Reimplemented from Synth8.SynthClipNode.

Reimplemented in Synth8.LFO, and Synth8.Oscillator.

Member Data Documentation

SynthModulatedParameter Synth8.BaseOscillator.amplitude = new SynthModulatedParameter( 1.0f )

The amplitude of the oscillation.

Wave Synth8.BaseOscillator.wave

The wave node that controls the oscillation.

---

The documentation for this class was generated from the following file:

• SynthClipNodes/Oscilators/BaseOscillator.cs