InstrumentComponent.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2024 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_INSTRUMENTCOMPONENT_H
#define H2C_INSTRUMENTCOMPONENT_H
 
#include <cassert>
#include <vector>
#include <memory>
 
#include <core/Object.h>
#include <core/License.h>
 
namespace H2Core
{
 
class XMLNode;
class ADSR;
class Drumkit;
class InstrumentLayer;
class DrumkitComponent;
 
class InstrumentComponent : public H2Core::Object<InstrumentComponent>
{
                H2_OBJECT(InstrumentComponent)
        public:
                InstrumentComponent( int related_drumkit_componentID );
                InstrumentComponent( std::shared_ptr<InstrumentComponent> other );
                ~InstrumentComponent();
 
        void                            save_to( XMLNode* node, int component_id, bool bRecentVersion = true, bool bFull = false );
                static std::shared_ptr<InstrumentComponent> load_from( XMLNode* pNode,
                                                                                                                           const QString& sDrumkitPath,
                                                                                                                           const License& drumkitLicense = License(),
                                                                                                                           bool bSilent = false );
 
                std::shared_ptr<InstrumentLayer>        operator[]( int ix );
                std::shared_ptr<InstrumentLayer>        get_layer( int idx );
                void                            set_layer( std::shared_ptr<InstrumentLayer> layer, int idx );
 
                void                            set_drumkit_componentID( int related_drumkit_componentID );
                int                                     get_drumkit_componentID();
 
                void                            set_gain( float gain );
                float                           get_gain() const;
 
                static int                      getMaxLayers();
                static void                     setMaxLayers( int layers );
        
        std::vector<std::shared_ptr<InstrumentLayer>>::iterator begin();
        std::vector<std::shared_ptr<InstrumentLayer>>::iterator end();
 
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;
 
        private:
                int                                     __related_drumkit_componentID;
                float                           __gain;
                
                static int                      m_nMaxLayers;
                std::vector<std::shared_ptr<InstrumentLayer>>   __layers;
};
 
// DEFINITIONS
inline void InstrumentComponent::set_drumkit_componentID( int related_drumkit_componentID )
{
        __related_drumkit_componentID = related_drumkit_componentID;
}
inline int InstrumentComponent::get_drumkit_componentID()
{
        return __related_drumkit_componentID;
}
 
inline void InstrumentComponent::set_gain( float gain )
{
        __gain = gain;
}
 
inline float InstrumentComponent::get_gain() const
{
        return __gain;
}
 
inline std::shared_ptr<InstrumentLayer> InstrumentComponent::operator[]( int idx )
{
        assert( idx >= 0 && idx < m_nMaxLayers );
        return __layers[ idx ];
}
 
inline std::shared_ptr<InstrumentLayer> InstrumentComponent::get_layer( int idx )
{
        assert( idx >= 0 && idx < m_nMaxLayers );
        return __layers[ idx ];
}
 
};
 
 
#endif