tools/behaviourtree.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2004-2006 by Jorrit Tyberghein
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_BEHAVIOUR_TREE__
#define __CEL_BEHAVIOUR_TREE__

#include "behaviourlayer/behave.h"
#include "tools/decorators.h"
#include "tools/parameters.h"
#include "tools/rewards.h"
#include "tools/triggers.h"

//-------------------------------------------------------------------------
// Behaviour tree nodes
//-------------------------------------------------------------------------

struct iBTNode : public virtual iBase
{
  SCF_INTERFACE (iBTNode, 0, 0, 1);

  virtual bool Execute (const celParams& params) = 0;

  virtual bool AddChild (iBTNode* child) = 0;

};

//-------------------------------------------------------------------------
// Specific behaviour tree node implementations.
//-------------------------------------------------------------------------

struct iBTAction: public virtual iBase
{
  SCF_INTERFACE (iBTAction, 0, 0, 1);

  virtual void AddReward (iReward* reward) = 0;
};

struct iParameterCheckCondition: public virtual iBase
{
  SCF_INTERFACE (iParameterCheckCondition, 0, 0, 1);

  virtual void SetParameter (const char* parameter) = 0;

  virtual void SetValue (const char* value) = 0;
};


struct iTriggerFiredCondition: public virtual iBase
{
  SCF_INTERFACE (iTriggerFiredCondition, 0, 0, 1);

  virtual void SetTrigger (iTrigger* trigger) = 0;

  virtual void SetFireOnce (bool once) = 0;
};

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

#define CEL_DECLARE_BTNODE(name)                                        \
class cel##name : public scfImplementation2<                            \
                cel##name ,iBTNode, iComponent>                         \
{                                                                       \
private:                                                                \
  iObjectRegistry* object_reg;                                          \
  csRefArray<iBTNode> children;                                         \
public:                                                                 \
  cel##name (iBase* parent);                                            \
  virtual ~cel##name () { }                                             \
  virtual bool Initialize (iObjectRegistry*);                           \
  virtual bool Execute (const celParams& params);                       \
  virtual bool AddChild (iBTNode* child);                               \
};

#define CEL_IMPLEMENT_BTNODE(name)                                      \
cel##name::cel##name (iBase* parent)                                    \
 : scfImplementationType (this, parent), object_reg(0)                  \
{                                                                       \
}                                                                       \
bool cel##name::Initialize (                                            \
        iObjectRegistry* object_reg)                                    \
{                                                                       \
  cel##name::object_reg = object_reg;                                   \
  return true;                                                          \
}                                                                       

#endif // __CEL_BEHAVIOUR_TREE__