Circle2D Class Reference

A visualization where the pitches of the track appear as pads placed radially. The pads light up when that pitch is played. More...

Inheritance diagram for Circle2D:

Protected Member Functions
void	Start ()
override void	Update ()
override void	CreateVisuals ()
override void	ClearVisuals ()
override void	Restart ()
	Override this. Called when the visualization restarts (R is pressed).
override void	MovePlay (decimal ticks, decimal microseconds)
override void	DrawGUI ()
	Override this. Use ImGui to draw most UI elements here.
override void	WriteConfig ()
	Override this. Write to Config here. Don't forget to include ConfigTag in your config keys.
override void	ReadConfig ()
	Override this. Read from Config here. Don't forget to include ConfigTag in your config keys.
Protected Member Functions inherited from VisualsComponent
void	CreateVisuals ()
	Create your visualization here. Happens every time visuals reload after a call to ClearVisuals.
void	ClearVisuals ()
	Clear all created visuals here.
void	MovePlay (decimal ticks, decimal microseconds)
	Move your visualization forward or backward (in case midi delay is adjusted).
override void	OnEnable ()
override void	OnDisable ()
override void	OnDestroy ()
override void	ReadConfig ()
override void	WriteConfig ()
override void	LoadVisuals ()
	Clears and creates the visuals.
override void	DrawGUI ()
override void	Restart ()
	Override this. Called when the visualization restarts (R is pressed).
Protected Member Functions inherited from OmidivComponent
virtual void	Awake ()
virtual void	OnPlayStart ()
	Override this. Called when the visualization starts playing. May be starting from the beginning or resuming.
virtual void	OnPlayStop ()
	Override this. Called when the visualization stops playing.
virtual void	Reset_ ()
	Override this. Called when SceneController.OnReset is fired. LoadAudio and LoadMidi will also be called afterwards, so don't do any of that here, but do reload any other resources your component needs.
virtual void	LoadMidi ()
	Override this. Called when the midi information needs to be loaded from the file. LoadVisuals will also be called afterwards, so don't do any of that here.
virtual void	LoadAudio ()
	Override this. Called when the audio needs to be loaded from the file.

Protected Attributes
float	LastTrackUpdate = -1f
float	LastNoteUpdate = -1f
float	LastReloadVisuals = -1f

Additional Inherited Members
Public Attributes inherited from OmidivComponent
string	ConfigTag = "def"
	Use this to give different instances in difference scenes different saved config.
Static Public Attributes inherited from VisualsComponent
static readonly SortedList< int, Color >	TrackColors = new SortedList<int, Color>()
Properties inherited from VisualsComponent
bool	AutoApplyChanges = true [get, set]
	Whether changes that require recreating the visualization should apply automatically (true) or manually with F6 (false).
Properties inherited from OmidivComponent
static bool	IsPlaying [get]
	Is the visualization currently playing.
static double	FrameDeltaTime [get]
	Time.deltaTime when not recording, 1/recording framerate when recording. In most cases, use this instead of Time.deltaTime so that recordings work properly.

Detailed Description

A visualization where the pitches of the track appear as pads placed radially. The pads light up when that pitch is played.

Member Function Documentation

DrawGUI()

override void Circle2D.DrawGUI ( )

protectedvirtual

Override this. Use ImGui to draw most UI elements here.

Subscribe to ImGuiManager.DrawMainMenuItems to add to main menu bar menus instead of here.

Reimplemented from OmidivComponent.

ReadConfig()

override void Circle2D.ReadConfig ( )

protectedvirtual

Override this. Read from Config here.
Don't forget to include ConfigTag in your config keys.

Reimplemented from OmidivComponent.

Restart()

override void Circle2D.Restart ( )

protectedvirtual

Override this. Called when the visualization restarts (R is pressed).

Reimplemented from OmidivComponent.

Update()

override void Circle2D.Update ( )

protectedvirtual

Please call base.Update() if overriding this unless you know what you're doing.

Reimplemented from VisualsComponent.

WriteConfig()

override void Circle2D.WriteConfig ( )

protectedvirtual

Override this. Write to Config here.
Don't forget to include ConfigTag in your config keys.

Reimplemented from OmidivComponent.

---

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

• L:/Coding/Unity/OMIDIV/Assets/Scripts/RenderScenes/Circle2D.cs