Etterna 0.74.4
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SMALoader Struct Reference

Reads a Song from a .SMA file. More...

#include <NotesLoaderSMA.h>

Inheritance diagram for SMALoader:
Inheritance graph
[legend]
Collaboration diagram for SMALoader:
Collaboration graph
[legend]

Public Member Functions

bool LoadFromSimfile (const std::string &sPath, Song &out, bool bFromCache=false) override
 Attempt to load the specified sm file.
 
void ProcessBeatsPerMeasure (TimingData &out, const std::string &sParam)
 
void ProcessMultipliers (TimingData &out, int iRowsPerBeat, const std::string &sParam)
 
void ProcessSpeeds (TimingData &out, const std::string &line, int rowsPerBeat) override
 Process the Speed Segments from the string.
 
- Public Member Functions inherited from SMLoader
 SMLoader (std::string ext)
 
virtual bool LoadFromDir (const std::string &sPath, Song &out)
 Attempt to load a song from a specified path.
 
virtual bool LoadNoteDataFromSimfile (const std::string &path, Steps &out)
 Retrieve the relevant notedata from the simfile.
 
virtual void GetApplicableFiles (const std::string &sPath, std::vector< std::string > &out)
 Retrieve the list of .sm files.
 
virtual bool LoadFromBGChangesString (BackgroundChange &change, const std::string &sBGChangeExpression)
 
void ParseBPMs (std::vector< std::pair< float, float > > &out, const std::string &line, const int rowsPerBeat=-1)
 Parse BPM Changes data from a string.
 
void ProcessBPMs (TimingData &out, const std::vector< std::pair< float, float > > &vBPMChanges)
 Process the BPM Segments from the string.
 
void ParseStops (std::vector< std::pair< float, float > > &out, const std::string &line, const int rowsPerBeat=-1)
 Parse Stops data from a string.
 
void ProcessStops (TimingData &out, const std::vector< std::pair< float, float > > &vStops)
 Process the Stop Segments from the data.
 
void ProcessBPMsAndStops (TimingData &out, std::vector< std::pair< float, float > > &vBPMs, std::vector< std::pair< float, float > > &vStops)
 Process BPM and stop segments from the data.
 
void ProcessDelays (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
 Process the Delay Segments from the string.
 
void ProcessTimeSignatures (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
 Process the Time Signature Segments from the string.
 
void ProcessTickcounts (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
 Process the Tickcount Segments from the string.
 
virtual void ProcessCombos (TimingData &, const std::string &line, const int=-1)
 
virtual void ProcessFakes (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
 Process the Fake Segments from the string.
 
virtual void ProcessBGChanges (Song &out, const std::string &sValueName, const std::string &sPath, const std::string &sParam)
 
void ProcessInstrumentTracks (Song &out, const std::string &sParam)
 
virtual void SetSongTitle (const std::string &title)
 Set the song title.
 
virtual std::string GetSongTitle () const
 Get the song title.
 

Additional Inherited Members

- Static Public Member Functions inherited from SMLoader
static void TidyUpData (Song &song, bool bFromCache)
 Perform some cleanup on the loaded song.
 
static void ProcessDelays (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)
 
static void ProcessTimeSignatures (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)
 
static void ProcessTickcounts (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)
 
static void ProcessSpeeds (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)
 
static void ProcessFakes (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)
 
static float RowToBeat (const std::string &line, const int rowsPerBeat)
 Convert a row value to the proper beat value.
 
- Protected Member Functions inherited from SMLoader
virtual void LoadFromTokens (std::string sStepsType, std::string sDescription, std::string sDifficulty, std::string sMeter, std::string sNoteData, Steps &out)
 Process the different tokens we have available to get NoteData.
 
std::string GetFileExtension () const
 Retrieve the file extension associated with this loader.
 
std::string GetChartPath () const
 Get the chart path.
 

Detailed Description

Reads a Song from a .SMA file.

Member Function Documentation

◆ LoadFromSimfile()

bool SMALoader::LoadFromSimfile ( const std::string &  sPath,
Song out,
bool  bFromCache = false 
)
overridevirtual

Attempt to load the specified sm file.

Parameters
sPatha const reference to the path on the hard drive to check.
outa reference to the Song that will retrieve the song information.
bFromCachea check to see if we are getting certain information from the cache file.
Returns
its success or failure.

Reimplemented from SMLoader.

◆ ProcessSpeeds()

void SMALoader::ProcessSpeeds ( TimingData out,
const std::string &  line,
int  rowsPerBeat 
)
overridevirtual

Process the Speed Segments from the string.

Parameters
outthe TimingData being modified.
linethe string in question.
rowsPerBeatthe number of rows per beat for this purpose.

Reimplemented from SMLoader.


The documentation for this struct was generated from the following files: