OmidivComponent Class Reference

A base component that is subscribed to a bunch of events. More...

Inheritance diagram for OmidivComponent:

Public Attributes
string	ConfigTag = "def"
	Use this to give different instances in difference scenes different saved config.

Protected Member Functions
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual void	Awake ()
virtual void	OnDestroy ()
virtual void	DrawGUI ()
	Override this. Use ImGui to draw most UI elements here.
virtual void	ReadConfig ()
	Override this. Read from Config here. Don't forget to include ConfigTag in your config keys.
virtual void	WriteConfig ()
	Override this. Write to Config here. Don't forget to include ConfigTag in your config keys.
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	Restart ()
	Override this. Called when the visualization restarts (R is pressed).
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	LoadVisuals ()
	Override this. Called when the visuals need to be recreated (like when something in the MIDI Controls window is changed).
virtual void	LoadAudio ()
	Override this. Called when the audio needs to be loaded from the file.

Properties
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 base component that is subscribed to a bunch of events.

Member Function Documentation

Awake()

virtual void OmidivComponent.Awake ( )

protectedvirtual

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

DrawGUI()

virtual void OmidivComponent.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 in AudioPlayer, Base3D< TrackInfo >, Circle2D, Default3DCameraController, DirectionalLightController, MidiManager, Ortho2DCameraController, PostProcessingController, Standard2D, VideoRecorder, and VisualsComponent.

LoadAudio()

virtual void OmidivComponent.LoadAudio ( )

protectedvirtual

Override this. Called when the audio needs to be loaded from the file.

Reimplemented in AudioPlayer.

LoadMidi()

virtual void OmidivComponent.LoadMidi ( )

protectedvirtual

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.

Reimplemented in MidiManager.

LoadVisuals()

virtual void OmidivComponent.LoadVisuals ( )

protectedvirtual

Override this. Called when the visuals need to be recreated (like when something in the MIDI Controls window is changed).

Reimplemented in VisualsComponent.

OnDestroy()

virtual void OmidivComponent.OnDestroy ( )

protectedvirtual

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

Reimplemented in VideoRecorder, and VisualsComponent.

OnDisable()

virtual void OmidivComponent.OnDisable ( )

protectedvirtual

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

Reimplemented in AudioPlayer, ConfigComponent, MidiManager, VideoRecorder, and VisualsComponent.

OnEnable()

virtual void OmidivComponent.OnEnable ( )

protectedvirtual

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

Reimplemented in AudioPlayer, ConfigComponent, MidiManager, VideoRecorder, and VisualsComponent.

OnPlayStart()

virtual void OmidivComponent.OnPlayStart ( )

protectedvirtual

Override this. Called when the visualization starts playing. May be starting from the beginning or resuming.

Reimplemented in AudioPlayer, and VideoRecorder.

OnPlayStop()

virtual void OmidivComponent.OnPlayStop ( )

protectedvirtual

Override this. Called when the visualization stops playing.

Reimplemented in AudioPlayer, and VideoRecorder.

ReadConfig()

virtual void OmidivComponent.ReadConfig ( )

protectedvirtual

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

Reimplemented in Base3D< TrackInfo >, Circle2D, Default3DCameraController, DirectionalLightController, Ortho2DCameraController, PostProcessingController, Standard2D, and VisualsComponent.

Reset_()

virtual void OmidivComponent.Reset_ ( )

protectedvirtual

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.

Reset() is a Unity message, hence the _

Restart()

virtual void OmidivComponent.Restart ( )

protectedvirtual

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

Reimplemented in AudioPlayer, Base3D< TrackInfo >, Circle2D, Default3DCameraController, MidiManager, Ortho2DCameraController, Standard2D, VideoRecorder, and VisualsComponent.

WriteConfig()

virtual void OmidivComponent.WriteConfig ( )

protectedvirtual

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

Reimplemented in Base3D< TrackInfo >, Circle2D, Default3DCameraController, DirectionalLightController, Ortho2DCameraController, PostProcessingController, Standard2D, and VisualsComponent.

Member Data Documentation

ConfigTag

string OmidivComponent.ConfigTag = "def"

Use this to give different instances in difference scenes different saved config.

You must manually add this to your config keys (for now?).

Property Documentation

FrameDeltaTime

double OmidivComponent.FrameDeltaTime

staticget

Time.deltaTime when not recording, 1/recording framerate when recording. In most cases, use this instead of Time.deltaTime so that recordings work properly.

Identical to SceneController.FrameDeltaTime.

IsPlaying

bool OmidivComponent.IsPlaying

staticget

Is the visualization currently playing.

Identical to SceneController.IsPlaying.

---

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

• L:/Coding/Unity/OMIDIV/Assets/Scripts/OmidivComponent.cs