Torque3D/Engine/source/sfx/sfxModifier.cpp
2017-04-19 14:02:45 -04:00

197 lines
6 KiB
C++

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
#include "console/simBase.h"
#include "console/engineAPI.h"
#include "sfx/sfxModifier.h"
#include "sfx/sfxSource.h"
//=============================================================================
// SFXOneShotModifier.
//=============================================================================
//-----------------------------------------------------------------------------
SFXOneShotModifier::SFXOneShotModifier( SFXSource* source, F32 triggerPos, bool removeWhenDone )
: Parent( source, removeWhenDone ),
mTriggerPos( triggerPos )
{
}
//-----------------------------------------------------------------------------
bool SFXOneShotModifier::update()
{
if( mSource->getElapsedPlayTimeCurrentCycle() >= mTriggerPos )
{
_onTrigger();
return mRemoveWhenDone;
}
else
return true;
}
//=============================================================================
// SFXRangeModifier.
//=============================================================================
//-----------------------------------------------------------------------------
SFXRangeModifier::SFXRangeModifier( SFXSource* source, F32 startTime, F32 endTime, bool removeWhenDone )
: Parent( source, removeWhenDone ),
mStartTime( startTime ),
mIsActive( false ),
mEndTime( endTime )
{
}
//-----------------------------------------------------------------------------
bool SFXRangeModifier::update()
{
if( !isActive() )
{
SFXStatus status = mSource->getStatus();
if( ( status == SFXStatusPlaying || status == SFXStatusBlocked )
&& mSource->getElapsedPlayTimeCurrentCycle() >= mStartTime )
{
mIsActive = true;
_onStart();
}
}
if( isActive() )
_onUpdate();
if( isActive() )
{
SFXStatus status = mSource->getStatus();
if( ( status == SFXStatusPlaying || status == SFXStatusBlocked )
&& mSource->getElapsedPlayTimeCurrentCycle() > mEndTime )
{
_onEnd();
mIsActive = false;
return mRemoveWhenDone;
}
}
return true;
}
//=============================================================================
// SFXFadeModifier.
//=============================================================================
//-----------------------------------------------------------------------------
SFXFadeModifier::SFXFadeModifier( SFXSource* source, F32 time, F32 endVolume, F32 startTime, EOnEnd onEndDo, bool removeWhenDone )
: Parent( source, startTime, startTime + time, removeWhenDone ),
mEndVolume( endVolume ),
mOnEnd( onEndDo )
{
}
//-----------------------------------------------------------------------------
SFXFadeModifier::~SFXFadeModifier()
{
// If the fade is still ongoing, restore the source's volume.
// For fade-in, set to end volume. For fade-out, set to start volume.
if( isActive() )
{
if( mStartVolume > mEndVolume )
mSource->setVolume( mStartVolume );
else
mSource->setVolume( mEndVolume );
}
}
//-----------------------------------------------------------------------------
void SFXFadeModifier::_onStart()
{
mStartVolume = mSource->getVolume();
mCurrentVolume = mStartVolume;
}
//-----------------------------------------------------------------------------
void SFXFadeModifier::_onUpdate()
{
F32 multiplier = ( mSource->getElapsedPlayTimeCurrentCycle() - mStartTime ) / ( mEndTime - mStartTime );
F32 newVolume;
if( mStartVolume > mEndVolume )
newVolume = mStartVolume - ( ( mStartVolume - mEndVolume ) * multiplier );
else
newVolume = mStartVolume + ( ( mEndVolume - mStartVolume ) * multiplier );
if( newVolume != mCurrentVolume )
{
mCurrentVolume = newVolume;
mSource->setVolume( mCurrentVolume );
}
}
//-----------------------------------------------------------------------------
void SFXFadeModifier::_onEnd()
{
mSource->setVolume( mEndVolume );
switch( mOnEnd )
{
case ON_END_Pause:
mSource->pause( 0.f ); // Pause without fade.
break;
case ON_END_Stop:
mSource->stop( 0.f ); // Stop without fade.
break;
case ON_END_Nop: ;
}
}
//=============================================================================
// SFXMarkerModifier.
//=============================================================================
//-----------------------------------------------------------------------------
SFXMarkerModifier::SFXMarkerModifier( SFXSource* source, const String& name, F32 pos, bool removeWhenDone )
: Parent( source, pos, removeWhenDone ),
mMarkerName( name )
{
}
//-----------------------------------------------------------------------------
void SFXMarkerModifier::_onTrigger()
{
Con::executef( mSource, "onMarkerPassed", mMarkerName.c_str() );
}