Jamba C++ API  5.1.1
IJmbParamDef Class Referenceabstract

Base class for jamba parameters (non templated) More...

#include <ParamDef.h>

Inherits IParamDef.

Inherited by JmbParamDef< T >.

Public Member Functions

 IJmbParamDef (const ParamID iParamID, VstString16 iTitle, Owner const iOwner, bool const iTransient, int16 const iDeprecatedSince, bool const iShared)
 
virtual bool isSerializable () const =0
 
virtual std::shared_ptr< GUI::Params::IGUIJmbParameternewGUIParam ()=0
 Create a new IGUIJmbParameter of the proper subtype. More...
 
virtual void writeDefaultValue (std::ostream &oStreamer) const =0
 
 ~IJmbParamDef () override=default
 
- Public Member Functions inherited from IParamDef
 IParamDef (ParamID const iParamID, VstString16 iTitle, Owner const iOwner, bool const iTransient, int16 const iDeprecatedSince)
 
bool isDeprecated () const
 Returns true if the parameter is deprecated (meaning it can only be used to upgrade to latest version) More...
 
virtual ~IParamDef ()=default
 

Public Attributes

bool const fShared
 
- Public Attributes inherited from IParamDef
const int16 fDeprecatedSince
 
const Owner fOwner
 
const ParamID fParamID
 
const VstString16 fTitle
 
const bool fTransient
 

Additional Inherited Members

- Public Types inherited from IParamDef
enum  Owner { kRT, kGUI }
 Who owns the parameter (mostly for state saving purposes) More...
 
- Static Public Attributes inherited from IParamDef
static constexpr int16 kVersionNotDeprecated = -1
 Special version indicating the parameter is not deprecated. More...
 

Detailed Description

Base class for jamba parameters (non templated)

Constructor & Destructor Documentation

◆ IJmbParamDef()

IJmbParamDef ( const ParamID  iParamID,
VstString16  iTitle,
Owner const  iOwner,
bool const  iTransient,
int16 const  iDeprecatedSince,
bool const  iShared 
)
inline

◆ ~IJmbParamDef()

~IJmbParamDef ( )
overridedefault

Member Function Documentation

◆ isSerializable()

virtual bool isSerializable ( ) const
pure virtual
Returns
true if the parameter can be serialized (so provides a means to be serialized)

Implemented in JmbParamDef< T >.

◆ newGUIParam()

virtual std::shared_ptr<GUI::Params::IGUIJmbParameter> newGUIParam ( )
pure virtual

Create a new IGUIJmbParameter of the proper subtype.

Implemented in JmbParamDef< T >.

◆ writeDefaultValue()

virtual void writeDefaultValue ( std::ostream &  oStreamer) const
pure virtual

Implemented in JmbParamDef< T >.

Member Data Documentation

◆ fShared

bool const fShared

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