Public API Reference

propclass/trigger.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2004 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_PF_TRIGGER__
#define __CEL_PF_TRIGGER__

#include "cstypes.h"
#include "csgeom/vector3.h"
#include "csgeom/box.h"
#include "csutil/scf.h"
#include "csutil/weakrefarr.h"

struct iCelEntity;
struct iPcTrigger;
struct iPcMesh;

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

  virtual void EntityEnters (iPcTrigger* trigger, iCelEntity* entity) = 0;

  virtual void EntityLeaves (iPcTrigger* trigger, iCelEntity* entity) = 0;

  virtual void EnterTrigger (iPcTrigger* trigger, iCelEntity* entity) = 0;

  virtual void LeaveTrigger (iPcTrigger* trigger, iCelEntity* entity) = 0;
};

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

  virtual void AddTriggerListener (iPcTriggerListener* listener) = 0;
  virtual void RemoveTriggerListener (iPcTriggerListener* listener) = 0;

  virtual void SetupTriggerSphere (iSector* sector,
        const csVector3& center, float radius) = 0;

  virtual void SetupTriggerSphere (iSector* sector,
        const char* center_name, float radius) = 0;

  virtual void SetupTriggerBox (iSector* sector, const csBox3& box) = 0;

  virtual void SetupTriggerBeam (iSector* sector, const csVector3& start,
        const csVector3& end) = 0;

  virtual void SetupTriggerAboveMesh (iPcMesh* mesh, float maxdistance) = 0;

  virtual void MonitorEntity (const char* entityname) = 0;

  virtual const char* GetMonitorEntity () const = 0;

  virtual void SetMonitorDelay (csTicks delay, csTicks jitter) = 0;

  virtual void EnableMonitorInvisible (bool en) = 0;

  virtual void EnableMessagesToSelf (bool en) = 0;

  virtual void EnableMessagesToOthers (bool en) = 0;

  virtual void EnableTrigger (bool en) = 0;

  virtual bool IsEnabled () const = 0;

  virtual const csWeakRefArray<iCelEntity>& GetEntitiesInTrigger () const = 0;

  virtual bool Check () = 0;
};

#endif // __CEL_PF_TRIGGER__

---