Public API Reference

ivaria/bugplug.h

Go to the documentation of this file.

/*
    Copyright (C) 2002 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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IVARIA_BUGPLUG_H__
#define __CS_IVARIA_BUGPLUG_H__

#include "csutil/scf.h"
#include "ivideo/graph3d.h"

struct iBugPlug;
struct iMeshObject;

class csBox3;
class csReversibleTransform;
class csVector2;
class csVector3;

struct iBugPlugRenderObject : public virtual iBase
{
  SCF_INTERFACE(iBugPlugRenderObject, 2,0,0);
  virtual void Render (iGraphics3D* g3d, iBugPlug* bugplug) = 0;
};


struct iBugPlug : public virtual iBase
{
  SCF_INTERFACE(iBugPlug,2,0,1);
  //=========================================================================

  virtual void SetupDebugSector () = 0;

  virtual void DebugSectorBox (const csBox3& box, float r, float g, float b,
        const char* name = 0, iMeshObject* mesh = 0,
        uint mixmode = CS_FX_COPY) = 0;

  virtual void DebugSectorTriangle (const csVector3& s1, const csVector3& s2,
        const csVector3& s3, float r, float g, float b,
        uint mixmode = CS_FX_ADD) = 0;

  virtual void SwitchDebugSector (const csReversibleTransform& trans,
        bool clear = true) = 0;

  virtual bool CheckDebugSector () const = 0;

  //=========================================================================

  virtual void SetupDebugView () = 0;

  virtual int DebugViewPoint (const csVector2& point) = 0;

  virtual void DebugViewLine (int i1, int i2) = 0;

  virtual void DebugViewBox (int i1, int i2) = 0;

  virtual int DebugViewPointCount () const = 0;

  virtual const csVector2& DebugViewGetPoint (int i) const = 0;

  virtual int DebugViewLineCount () const = 0;

  virtual void DebugViewGetLine (int i, int& i1, int& i2) const = 0;

  virtual int DebugViewBoxCount () const = 0;

  virtual void DebugViewGetBox (int i, int& i1, int& i2) const = 0;

  virtual void DebugViewRenderObject (iBugPlugRenderObject* obj) = 0;

  virtual void DebugViewClearScreen (bool cs) = 0;

  virtual void SwitchDebugView (bool clear = true) = 0;

  virtual bool CheckDebugView () const = 0;

  //=========================================================================

  virtual void AddCounter (const char* countername, int amount = 1) = 0;

  virtual void AddCounterEnum (const char* countername, int enumval,
        int amount = 1) = 0;

  virtual void ResetCounter (const char* countername, int value = 0) = 0;

  virtual void RemoveCounter (const char* countername) = 0;

  //=========================================================================
  
  virtual bool ExecCommand (const char* command) = 0;
};

#endif // __CS_IVARIA_BUGPLUG_H__

---