actionaudio.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_ACTIONAUDIO_H
#define FIFE_ACTIONAUDIO_H

// Standard C++ library includes

// Platform specific includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "model/metamodel/modelcoords.h"

namespace FIFE {

    class ActionAudio {
    public:

        ActionAudio();
        ~ActionAudio();

        void setSoundFileName(const std::string& name);

        const std::string& getSoundFileName() const;

        void setGroupName(const std::string& name);

        const std::string& getGroupName() const;

        void setGain(float gain);

        float getGain() const;

        void setMaxGain(float gain);

        float getMaxGain() const;

        void setMinGain(float gain);

        float getMinGain() const;

        void setReferenceDistance(float distance);

        float getReferenceDistance() const;

        void setMaxDistance(float distance);

        float getMaxDistance() const;

        void setRolloff(float rolloff);

        float getRolloff() const;

        void setPitch(float pitch);

        float getPitch() const;

        void setConeInnerAngle(float inner);

        float getConeInnerAngle() const;

        void setConeOuterAngle(float outer);

        float getConeOuterAngle() const;

        void setConeOuterGain(float gain);

        float getConeOuterGain() const;

        void setVelocity(const AudioSpaceCoordinate& velocity);

        const AudioSpaceCoordinate& getVelocity() const;

        void setLooping(bool loop);

        bool isLooping() const;

        void setRelativePositioning(bool relative);

        bool isRelativePositioning() const;

        void setDirection(bool direction);

        bool isDirection() const;
    
    private:
        std::string m_name;
        std::string m_group;
        float m_volume;
        float m_maxVolume;
        float m_minVolume;
        float m_refDistance;
        float m_maxDistance;
        float m_rolloff;
        float m_pitch;
        float m_coneInnerAngle;
        float m_coneOuterAngle;
        float m_coneOuterGain;
        AudioSpaceCoordinate m_velocity;
        bool m_looping;
        bool m_positioning;
        bool m_direction;

    };
}

#endif