DtSoundModel.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2022 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <vrvAudio/vrvAudio.h>

#include <vrvCore/DtUniqueID.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <makAudio/abstractAudio.h>
#include <makAudio/sound.h>

#include <matrix/vlVector.h>

namespace makVrv
{
   class DtDe;

   class DT_DLL_VRVAUDIO DtSoundModel
   {
   public:
      enum class DtSoundState
      {
         STOPPED,
         PAUSED,
         PLAYED
      };

   public:

      DtSoundModel(DtDe& de, DtUniqueID id);

      DtSoundModel() = delete;

      DtSoundModel(const DtSoundModel&) = delete;

      DtSoundModel& operator=(const DtSoundModel&) = delete;

      virtual ~DtSoundModel();

   public:

      virtual void setModelDefinition(const std::string& modelDef);

      virtual void realize(const std::string& filename, float decibels, bool is3d,
         bool isLooping, makAudio::DtAbstractAudio::Priority priority);

      virtual void play();

      virtual void pause();

      virtual void stop();

      virtual void setRelativePosition(bool relative);

      virtual void setPosition(const DtVector& pos);

      virtual void setVelocity(const DtVector& vel);

      virtual void setDecibel(float decibel);

      virtual float decibel();

      virtual void setGain(float vol);

      virtual float gain();

      virtual float maxFalloffDistance();

      virtual void setIs3d(bool is3d);

      virtual bool shouldPlaySound();

      virtual void setIsInteractionSound(bool isInteractionSound);

      virtual bool isInteractionSound();

      virtual void setAttachedEntityEngineRunning(bool running);

      virtual bool attachedEntityEngineRunning();

      virtual makAudio::DtSound* sound();

      virtual const makAudio::DtSound* sound() const;

   protected:
      virtual void createSoundFromDescriptor();
      
      virtual void handleDelayedSoundCreation();

   protected:
      DtDe& myDe;
      DtUniqueID myId;
      DtSignalConnectionManager myConnections;

      makAudio::DtSound* mySound;

      makAudio::DtSoundDescriptor mySoundDescriptor;
      DtVector myPosition;
      DtVector myVelocity;
      bool myIsRelativePosition;
      DtSoundState mySoundState;
      float myGain;

      bool myIsInteractionSound;
      bool myAttachedEntityEngineRunning;
   };
}