XJ music engine  1.9.6
In-game runtime engine for XJ music.
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
XJ::InstrumentConfig Class Reference

#include <InstrumentConfig.h>

Inheritance diagram for XJ::InstrumentConfig:
XJ::ConfigParser

Public Member Functions

 InstrumentConfig ()
 
 InstrumentConfig (const std::string &input)
 
std::string toString () const
 
bool oneShotObserveLengthOfEventsContains (const std::string &eventName) const
 
- Public Member Functions inherited from XJ::ConfigParser
 ConfigParser (const std::string &input)
 
 ConfigParser (const std::string &input, const ConfigParser &defaults)
 
ConfigSingleValue getSingleValue (const std::string &key)
 
ConfigListValue getListValue (const std::string &key)
 
ConfigObjectValue getObjectValue (const std::string &key)
 
bool operator== (const ConfigParser &other) const
 
void operator= (const ConfigParser &other)
 

Static Public Member Functions

static std::string getDefaultString ()
 
- Static Public Member Functions inherited from XJ::ConfigParser
static std::string format (const bool &value)
 
static std::string format (const int &value)
 
static std::string format (const float &value)
 
static std::string format (const std::string &value)
 
static std::string format (const std::vector< std::string > &values)
 
static std::string format (const std::set< std::string > &values)
 
static std::vector< std::string > splitCsvTopLevel (const std::string &basicString)
 

Public Attributes

bool isAudioSelectionPersistent
 
bool isMultiphonic
 
bool isOneShot
 
bool isOneShotCutoffEnabled
 
bool isTonal
 
int releaseMillis
 
std::vector< std::string > oneShotObserveLengthOfEvents
 

Static Public Attributes

static const std::string DEFAULT
 

Constructor & Destructor Documentation

◆ InstrumentConfig() [1/2]

InstrumentConfig::InstrumentConfig ( )
explicit

◆ InstrumentConfig() [2/2]

InstrumentConfig::InstrumentConfig ( const std::string &  input)
explicit

Member Function Documentation

◆ getDefaultString()

std::string InstrumentConfig::getDefaultString ( )
static

Get the default InstrumentConfig as a HOCON string

◆ oneShotObserveLengthOfEventsContains()

bool InstrumentConfig::oneShotObserveLengthOfEventsContains ( const std::string &  eventName) const

Check if the one-shot observe length of events contains a given event name

Parameters
eventNameThe event name
Returns
True if the one-shot observe length of events contains the event name

◆ toString()

std::string InstrumentConfig::toString ( ) const

Format the InstrumentConfig as a HOCON string

Returns
The HOCON string

Member Data Documentation

◆ DEFAULT

const std::string InstrumentConfig::DEFAULT
static
Initial value:
= R"(
isAudioSelectionPersistent = true
isMultiphonic = false
isOneShot = false
isOneShotCutoffEnabled = true
isTonal = false
oneShotObserveLengthOfEvents = []
releaseMillis = 5
)"

◆ isAudioSelectionPersistent

bool XJ::InstrumentConfig::isAudioSelectionPersistent

◆ isMultiphonic

bool XJ::InstrumentConfig::isMultiphonic

◆ isOneShot

bool XJ::InstrumentConfig::isOneShot

◆ isOneShotCutoffEnabled

bool XJ::InstrumentConfig::isOneShotCutoffEnabled

◆ isTonal

bool XJ::InstrumentConfig::isTonal

◆ oneShotObserveLengthOfEvents

std::vector<std::string> XJ::InstrumentConfig::oneShotObserveLengthOfEvents

◆ releaseMillis

int XJ::InstrumentConfig::releaseMillis

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