components/sound/SoundSourceComponent.h

Go to the documentation of this file.

// /////////////////////////////////////////////////////////////////////////////
//
// Name:            SoundSourceComponent.h
// Author:          Michael Bartsch (ZCCdark203)
//
// Desc :           Declaration of the SoundSourceComponent class.
//
// License:         Copyright (C) 2009 Michael Bartsch and Contributors
//
//                  This program is free software: you can redistribute it
//                  and/or modify it under the terms of the zlib/libpng License.
//                  See main.cpp for conditions of distribution and use.
//
// /////////////////////////////////////////////////////////////////////////////

#ifndef __SOUNDSOURCECOMPONENT_H__
#define __SOUNDSOURCECOMPONENT_H__

// Include files
#include "../../dependencies.h"
#ifdef __COMPILE_WITH_SFML_AUDIO__
#include "../../core/EntityComponent.h"


// SoundSourceComponent class
class SoundSourceComponent : public EntityComponent
{
public:

    // Initialisation and deinitialisation
    SoundSourceComponent(Entity *parent);
    ~SoundSourceComponent();

    // Methods
    sf::Sound* getSound();
    sf::Music* getMusic();

    bool loadMusic(const std::string &fileName);
    bool loadMusicFromMemory(c8 *buffer, long length);
    bool loadSoundBuffer(const std::string &bufferName);

    void unloadData();

    void play();
    void pause();
    void stop();

    f32 getAttenuation() const;
    bool getIsPaused() const;
    bool getIsPlaying() const;
    bool getIsStopped() const;
    bool getLoop() const;
    f32 getMinDistance() const;
    f32 getOffset() const;
    f32 getPitch() const;
    f32 getVolume() const;

    void setAttenuation(f32 attenuation);
    void setLoop(bool value);
    void setMinDistance(f32 minDistance);
    void setOffset(f32 offset);
    void setPitch(f32 pitch);
    void setVolume(f32 volume);

    // Events
    void onPositionChange(void *p);
    void onPause(void *p);
    void onUnPause(void *p);
    void onSound(void *p);

    // XML
    static bool parseXML(IXMLReader *file, Entity *entity);

private:

    // Members
    sf::Sound *mSound;
    sf::Music *mMusic;

    c8 *mBuffer;
    long mBufferSize;
    std::string mSoundFileName;

    f32 mAttenuation;
    bool mLoop;
    f32 mMinDistance;
    f32 mPitch;
    vector3df mPosition;
    f32 mVolume;

    bool mWasPaused;

};

#endif // __COMPILE_WITH_SFML_AUDIO__

#endif

---