tools/triggers.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_TRIGGERS__
#define __CEL_TRIGGERS__

#include "behaviourlayer/behave.h"
#include "tools/parameters.h"
#include "tools/sequences.h"

//-------------------------------------------------------------------------
// Triggers
//-------------------------------------------------------------------------

struct iTrigger;

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

  virtual void TriggerFired (iTrigger* trigger, iCelParameterBlock* params) = 0;
};

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

  virtual void RegisterCallback (iTriggerCallback* callback) = 0;

  virtual void ClearCallback () = 0;

  virtual void ActivateTrigger () = 0;

  virtual void DeactivateTrigger () = 0;

  virtual bool Check () = 0;

  virtual bool LoadAndActivateTrigger (iCelDataBuffer* databuf) = 0;

  virtual void SaveTriggerState (iCelDataBuffer* databuf) = 0;
};

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

  virtual csPtr<iTrigger> CreateTrigger (
        const celParams& params) = 0;

  virtual bool Load (iDocumentNode* node) = 0;
};

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

  virtual const char* GetName () const = 0;
  
  virtual csPtr<iTriggerFactory> CreateTriggerFactory () = 0;
};

//-------------------------------------------------------------------------
// Specific trigger implementations.
//-------------------------------------------------------------------------
struct iEnterSectorTriggerFactory : public virtual iBase
{
  SCF_INTERFACE (iEnterSectorTriggerFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetSectorParameter (const char* sector) = 0;
};

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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetChildEntityParameter (const char* child_entity) = 0;
};

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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;
};

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

  virtual void SetEntityParameter (const char* entity) = 0;

  virtual void SetMaskParameter (const char* mask) = 0;
};


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

  virtual void SetOperationParameter (const char* operation) = 0;
  virtual csRefArray<iTriggerFactory> &GetTriggerFactories () = 0;
};

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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetPropertyParameter (const char* prop) = 0;

  virtual void SetValueParameter (const char* value) = 0;

  virtual void SetOperationParameter (const char* op) = 0;

  virtual void SetOnChangeOnly (bool on_change) = 0;
};

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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetSequenceParameter (const char* sequence) = 0;

  virtual void SetSequence (iCelSequence* sequence) = 0;
};

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

  virtual void SetTimeoutParameter (const char* timeout_par) = 0;
};


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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void EnableLeave () = 0;
};

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

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetTargetEntityParameter (const char* entity,
      const char* tag = 0) = 0;

  virtual void SetChecktimeParameter (const char* time) = 0;

  virtual void SetRadiusParameter (const char* radius) = 0;

  virtual void SetOffsetParameter (const char* offsetx,
      const char* offsety, const char* offsetz) = 0;
};

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

#define CEL_DECLARE_TRIGGERTYPE(name,id)                                \
class cel##name##TriggerType : public scfImplementation2<               \
                cel##name##TriggerType,iTriggerType,iComponent>         \
{                                                                       \
public:                                                                 \
  iObjectRegistry* object_reg;                                          \
  csWeakRef<iCelPlLayer> pl;                                            \
  cel##name##TriggerType (iBase* parent);                       \
  virtual ~cel##name##TriggerType () { }                                \
  virtual bool Initialize (iObjectRegistry*);                   \
  virtual const char* GetName () const { return id; }                   \
  virtual csPtr<iTriggerFactory> CreateTriggerFactory ();               \
};

#define CEL_IMPLEMENT_TRIGGERTYPE(name)                                 \
cel##name##TriggerType::cel##name##TriggerType (                                \
        iBase* parent) : scfImplementationType (this, parent),  \
        object_reg(0)                                                                                   \
{                                                                                                                       \
}                                                                                                                       \
bool cel##name##TriggerType::Initialize (                                       \
        iObjectRegistry* object_reg)                                                    \
{                                                                       \
  cel##name##TriggerType::object_reg = object_reg;                      \
  pl = csQueryRegistry<iCelPlLayer> (object_reg);                       \
  return true;                                                                                          \
}                                                                       \
csPtr<iTriggerFactory> cel##name##TriggerType::CreateTriggerFactory () \
{                                                                       \
  cel##name##TriggerFactory* fact = new cel##name##TriggerFactory (this); \
  return fact;                                                          \
}

#endif // __CEL_TRIGGERS__