Method removeSoundscape

Engine/source/sfx/sfxSoundscape.cpp:303–404

//-----------------------------------------------------------------------------

void SFXSoundscapeManager::removeSoundscape( SFXSoundscape* soundscape )
{
   AssertFatal( soundscape != getGlobalSoundscape(),
      "SFXSoundscapeManager::removeSoundscape() - trying to remove the global soundscape" );
      
   // Find the soundscape on the stack.
            
   U32 index = 1;
   for( ; index < mStack.size(); ++ index )
      if( mStack[ index ] == soundscape )
         break;
         
   AssertFatal( index < mStack.size(),
      "SFXSoundscapeManager::removeSoundscape() - soundscape not on stack" );
      
   // Find out if the soundscape has the current reverb
   // environment.  If so, we need to change the reverb to
   // the next one higher up the stack.

   const bool isCurrentReverb = ( _findTopmostReverbOnStack( mStack ) == index );
   
   // Remove the soundscape from the stack.

   mStack.erase( index );
   
   // Update reverb, if necessary.
   
   if( isCurrentReverb )
   {
      S32 reverbIndex = _findTopmostReverbOnStack( mStack );
      if( reverbIndex != -1 )
         SFX->setReverb( mStack[ reverbIndex ]->getAmbience()->getEnvironment()->getReverb() );
   }
   
   // Deactivate states.
   
   for( U32 i = 0; i < SFXAmbience::MaxStates; ++ i )
      if( soundscape->mStates[ i ] )
      {
         soundscape->mStates[ i ]->deactivate();
         soundscape->mStates[ i ] = NULL;
      }
   
   // If the soundscape is the only instance of its ambience, move
   // it to the fade stack.  Otherwise delete the soundscape.
   
   if( soundscape->_isUnique() && soundscape->mSource != NULL )
   {
      #ifdef DEBUG_SPEW
      Platform::outputDebugString( "[SFXSoundscapeManager] Moving ambience '%s' at index #%i to fade stack",
         soundscape->getAmbience()->getName(), index );
      #endif
      
      soundscape->mSource->stop();
      mFadeStack.push_back( soundscape );      
   }
   else
   {