flimSound.h

Go to the documentation of this file.

#pragma once
#ifndef FLIMSOUND_H
#define FLIMSOUND_H


// audio engine includes
#include "SoundEngine.h"
#include "SoundCall.h"
#include "SoundCallRegistry.h"
#include "..\Flim\GameObject.h"
#include "flimReverb.h"
#include "flimFilter.h"
#include "..\Cottage.h"
#include "AzulCore.h"


enum class DistanceCurve
{
    Linear,
    Logarithmic,
    Reverse_Logarithmic
};


enum class SourceType
{
    Point,
    Plane
};

// a collidable with a soundcall; corresponds to emitter on game side


class flimSound : public GameObject
{
public:


    flimSound(SoundCallID id, bool is3DSound = false, bool occ = false);

    flimSound() = delete;
    flimSound(const flimSound&) = default;
    flimSound& operator=(const flimSound&) = default;
    ~flimSound();

    // 3D methods
    snd_err getOrientation(Vect& out) const;
    snd_err setOrientation(const Vect& orient);


    snd_err getPosition(Vect& out) const;


    snd_err setPosition(const Vect& orient);

    //snd_err setOrientation(float xF, float yF, float zF, float xU, float yU, float zU);


    snd_err SetOrientation(const Vect & vect, float xU = 0.0f, float yU = 1.0f, float zU = 0.0f);


    snd_err getDistanceCurve(DistanceCurve& out);


    snd_err setDistanceCurve(const DistanceCurve& distCurve);


    snd_err getReverb(flimReverb& out) const;


    snd_err getFilter(flimFilter& out) const;

    // pass through methods -- to soundcall


    snd_err Pan(float p, int triggerTime = 0);


    snd_err Pan(float from, float to, float time, int triggerTime = 0);


    snd_err Loop(bool toLoop, int triggerTime = 0);


    snd_err Pitch(float p, int triggerTime = 0);


    snd_err Pitch(float from, float to, float time, int triggerTime = 0);


    snd_err Volume(float p, int triggerTime = 0);


    snd_err Volume(float from, float to, float time, int triggerTime = 0);


    snd_err Play(bool toLoop = false, int t = 0, int _priority = 0);


    snd_err Stop(int t = 0);


    snd_err Pause(int t = 0);


    snd_err IsPlaying(bool&);


    snd_err GetTimeSinceStarted(int&);


    snd_err GetVolume(float&);


    snd_err GetPitch(float&);


    snd_err GetPan(float&);


    snd_err GetPriority(int&);


    snd_err GetLoop(bool&);


    snd_err SubmitSoundEndedCallback(CallbackCommand* cmd);

    // game object stuff
    errcode Update() override;


    errcode Collision(GameObject *);


    errcode Collision(Collidable *) override { return errcode::success; };


    errcode CollisionTerrain(const CollisionVolumeAABB& aabb) override; 


    errcode CollisionEnter(Collidable*);


    errcode CollisionExit();


    // reverb


    errcode SetReverbLevel(float level);


    errcode SetReverbTime(float time);


    errcode SetReverbPreDelay(float time);


    errcode SetReverbSize(float size);


    errcode SetReverbDensity(float density);

private:
    SoundCallID sndID;
    SoundCall* snd;

    bool is3D;
    bool occlusionEnabled; // some sort of collision registration with a ray to the listener
    Model* occlusionSphere;
    Vect position;
    Vect orientation;
    DistanceCurve distanceCurve;
    SourceType sourceType;

    //Reverb
    // reverb object -- getters and setters, parameters adjusted internally
    flimReverb reverb;

    //Filter
    // filter object -- getters and setters, parameters adjusted internally
    flimFilter filter;
};



#endif