Torque3D/Engine/source/BadBehavior/leaf/WaitForSignal.cpp

//-----------------------------------------------------------------------------
// Copyright (c) 2014 Guy Allard
//
// 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 "WaitForSignal.h"
#include "BadBehavior/core/Runner.h"

#include "console/consoleTypes.h"

using namespace BadBehavior;

//------------------------------------------------------------------------------
// WaitForSignal leaf node
//------------------------------------------------------------------------------
IMPLEMENT_CONOBJECT(WaitForSignal);

WaitForSignal::WaitForSignal()
   : mTimeoutMs(0)
{
}

void WaitForSignal::initPersistFields()
{
   addGroup( "Behavior" );
   
   addField( "signalName", TypeRealString, Offset(mSignalName, WaitForSignal),
      "The time in ms that the node should wait before completion." );

   addProtectedField( "timeoutMs", TypeS32, Offset(mTimeoutMs, WaitForSignal), &_setTimeout, &defaultProtectedGetFn,
      "The maximum time in ms that the node should wait for the signal.\n"
      "A value of 0 indicates no limit");

   endGroup( "Behavior" );

   Parent::initPersistFields();
}

Task *WaitForSignal::createTask(SimObject &owner, BehaviorTreeRunner &runner)
{
   return new WaitForSignalTask(*this, owner, runner);
}

bool WaitForSignal::_setTimeout(void *object, const char *index, const char *data)
{
   WaitForSignal *node = static_cast<WaitForSignal *>( object );
   node->mTimeoutMs = getMax(0, dAtoi( data ));
   return false;
}

//------------------------------------------------------------------------------
// Wait task
//------------------------------------------------------------------------------
WaitForSignalTask::WaitForSignalTask(Node &node, SimObject &owner, BehaviorTreeRunner &runner)
   : Parent(node, owner, runner),
   mEventId(0)
{
}

WaitForSignalTask::~WaitForSignalTask()
{
   unsubscribe();
   cancelEvent();
}

void WaitForSignalTask::subscribe()
{
   mRunner->subscribeToSignal(static_cast<WaitForSignal *>(mNodeRep)->getSignalName().c_str(), this);
}

void WaitForSignalTask::unsubscribe()
{
   mRunner->unsubscribeFromSignal(static_cast<WaitForSignal *>(mNodeRep)->getSignalName().c_str(), this);
}

void WaitForSignalTask::onSignal()
{
   onResume();
}

void WaitForSignalTask::onTimeout()
{
   mStatus = FAILURE;
}

void WaitForSignalTask::cancelEvent()
{
   if(mEventId != 0 && Sim::isEventPending(mEventId))
   {
      Sim::cancelEvent(mEventId);
      mEventId = 0;
   }
}

void WaitForSignalTask::onInitialize()
{
   Parent::onInitialize();
   subscribe();
   cancelEvent();
}

void WaitForSignalTask::onTerminate()
{
   Parent::onTerminate();
   unsubscribe();
   cancelEvent();
}

Task* WaitForSignalTask::update() 
{ 
   if(mStatus == RESUME)
   {
      mStatus = SUCCESS;
   }
   else if (mStatus == INVALID)
   {
      mStatus = SUSPENDED;
      
      S32 timeout = static_cast<WaitForSignal *>(mNodeRep)->getTimeoutMs();
      if(timeout > 0)
         mEventId = Sim::postEvent(mRunner, new WaitForSignalTimeoutEvent(*this), Sim::getCurrentTime() + timeout);
   }

   if(mStatus == SUCCESS || mStatus == FAILURE)
      mIsComplete = true;

   return NULL; 
}