OMIDIV
ConfigComponent Class Reference

Adds the Open Config, Save Config, and Save Config As buttons to the File menu. More...

Inheritance diagram for ConfigComponent:
OmidivComponent

Protected Member Functions

override void OnEnable ()
 
override void OnDisable ()
 
void DrawMainMenuItems (string menuName)
 
- Protected Member Functions inherited from OmidivComponent
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.
 

Additional Inherited Members

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

 
- 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

Adds the Open Config, Save Config, and Save Config As buttons to the File menu.

Member Function Documentation

◆ OnDisable()

override void ConfigComponent.OnDisable ( )
protectedvirtual

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

Reimplemented from OmidivComponent.

◆ OnEnable()

override void ConfigComponent.OnEnable ( )
protectedvirtual

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

Reimplemented from OmidivComponent.


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