Public API Reference

imesh/thing.h

Go to the documentation of this file.

/*
    Copyright (C) 1998-2003 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_IMESH_THING_H__
#define __CS_IMESH_THING_H__

#include "csutil/scf.h"
#include "igraphic/image.h"

struct iMaterialWrapper;
struct iMeshObject;
struct iMeshObjectFactory;
struct iRenderBuffer;
struct iThingState;
struct iThingFactoryState;

class csFlags;
class csMatrix3;
class csPlane3;
class csVector2;
class csVector3;

struct csPolygonRange
{
  int start, end;
  csPolygonRange (int start, int end)
  {
    csPolygonRange::start = start;
    csPolygonRange::end = end;
  }
  void Set (int start, int end)
  {
    csPolygonRange::start = start;
    csPolygonRange::end = end;
  }
  void Set (int idx)
  {
    csPolygonRange::start = idx;
    csPolygonRange::end = idx;
  }
};

#define CS_POLY_LIGHTING 0x00000001

#define CS_POLY_COLLDET 0x00000002

#define CS_POLY_VISCULL 0x00000004

#define CS_POLYRANGE(s1,s2) csPolygonRange (s1, s2)

#define CS_POLYRANGE_SINGLE(idx) csPolygonRange (idx, idx)

#define CS_POLYRANGE_LAST csPolygonRange (-1, -1)

#define CS_POLYRANGE_ALL csPolygonRange (0, 2000000000)

#define CS_POLYINDEX_LAST -1

#define CS_THING_NOCOMPRESS 0x00010000

#define CS_THING_MOVE_NEVER 0
#define CS_THING_MOVE_OCCASIONAL 2

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

  virtual iThingFactoryState* GetThingFactoryState () const = 0;

  virtual iMeshObjectFactory* GetMeshObjectFactory () const = 0;

  virtual iThingState* GetThingState () const = 0;

  virtual iMeshObject* GetMeshObject () const = 0;

  virtual int GetIndex () const = 0;
};


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

  virtual void CompressVertices () = 0;

  virtual int GetPolygonCount () = 0;
  virtual void RemovePolygon (int idx) = 0;
  virtual void RemovePolygons () = 0;

  virtual int FindPolygonByName (const char* name) = 0;

  virtual int AddEmptyPolygon () = 0;

  virtual int AddTriangle (const csVector3& v1, const csVector3& v2,
        const csVector3& v3) = 0;
  virtual int AddQuad (const csVector3& v1, const csVector3& v2,
        const csVector3& v3, const csVector3& v4) = 0;

  virtual int AddPolygon (csVector3* vertices, int num) = 0;

  virtual int AddPolygon (int num, ...) = 0;

  virtual int AddOutsideBox (const csVector3& bmin, const csVector3& bmax) = 0;

  virtual int AddInsideBox (const csVector3& bmin, const csVector3& bmax) = 0;

  virtual void SetPolygonName (const csPolygonRange& range,
        const char* name) = 0;

  virtual const char* GetPolygonName (int polygon_idx) = 0;

  virtual csPtr<iPolygonHandle> CreatePolygonHandle (int polygon_idx) = 0;

  virtual void SetPolygonMaterial (const csPolygonRange& range,
        iMaterialWrapper* material) = 0;

  virtual iMaterialWrapper* GetPolygonMaterial (int polygon_idx) = 0;

  virtual void AddPolygonVertex (const csPolygonRange& range,
        const csVector3& vt) = 0;

  virtual void AddPolygonVertex (const csPolygonRange& range, int vt) = 0;

  virtual void SetPolygonVertexIndices (const csPolygonRange& range,
        int num, int* indices) = 0;

  virtual int GetPolygonVertexCount (int polygon_idx) = 0;

  virtual const csVector3& GetPolygonVertex (int polygon_idx,
        int vertex_idx) = 0;

  virtual int* GetPolygonVertexIndices (int polygon_idx) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        const csMatrix3& m, const csVector3& v) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        const csVector2& uv1, const csVector2& uv2, const csVector2& uv3) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        const csVector3& p1, const csVector2& uv1,
        const csVector3& p2, const csVector2& uv2,
        const csVector3& p3, const csVector2& uv3) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        const csVector3& v_orig, const csVector3& v, float len) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        const csVector3& v_orig,
        const csVector3& v1, float len1,
        const csVector3& v2, float len2) = 0;

  virtual bool SetPolygonTextureMapping (const csPolygonRange& range,
        float len) = 0;

  virtual void GetPolygonTextureMapping (int polygon_idx,
        csMatrix3& m, csVector3& v) = 0;

  virtual void SetPolygonTextureMappingEnabled (const csPolygonRange& range,
        bool enabled) = 0;

  virtual bool IsPolygonTextureMappingEnabled (int polygon_idx) const = 0;

  virtual void SetPolygonFlags (const csPolygonRange& range, uint32 flags) = 0;

  virtual void SetPolygonFlags (const csPolygonRange& range, uint32 mask,
        uint32 flags) = 0;

  virtual void ResetPolygonFlags (const csPolygonRange& range,
        uint32 flags) = 0;

  virtual csFlags& GetPolygonFlags (int polygon_idx) = 0;

  virtual const csPlane3& GetPolygonObjectPlane (int polygon_idx) = 0;

  virtual bool IsPolygonTransparent (int polygon_idx) = 0;

  virtual bool PointOnPolygon (int polygon_idx, const csVector3& v) = 0;

  virtual int GetVertexCount () const = 0;
  virtual const csVector3 &GetVertex (int idx) const = 0;
  virtual const csVector3* GetVertices () const = 0;
  virtual int CreateVertex (const csVector3& vt) = 0;
  virtual void SetVertex (int idx, const csVector3& vt) = 0;
  virtual void DeleteVertex (int idx) = 0;
  virtual void DeleteVertices (int from, int to) = 0;

  virtual void SetSmoothingFlag (bool smoothing) = 0;

  virtual bool GetSmoothingFlag () = 0;
  
  virtual csVector3* GetNormals () = 0;

  virtual float GetCosinusFactor () const = 0;
  virtual void SetCosinusFactor (float cosfact) = 0;

  virtual bool AddPolygonRenderBuffer (int polygon_idx, const char* name,
    iRenderBuffer* buffer) = 0;
    
  virtual bool GetLightmapLayout (int polygon_idx, size_t& slm, 
    csRect& slmSubRect, float* slmCoord) = 0;
};

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

  virtual const csVector3 &GetVertexW (int idx) const = 0;
  virtual const csVector3* GetVerticesW () const = 0;

  virtual int GetMovingOption () const = 0;

  virtual void SetMovingOption (int opt) = 0;

  virtual void Prepare () = 0;

  virtual void Unprepare () = 0;

  virtual void ReplaceMaterial (iMaterialWrapper* oldmat,
        iMaterialWrapper* newmat) = 0;

  virtual void ClearReplacedMaterials () = 0;

  virtual void SetMixMode (uint mode) = 0;
  virtual uint GetMixMode () const = 0;

  virtual csPtr<iPolygonHandle> CreatePolygonHandle (int polygon_idx) = 0;

  virtual const csPlane3& GetPolygonWorldPlane (int polygon_idx) = 0;
  

  virtual csPtr<iImage> GetPolygonLightmap (int polygon_idx) = 0;
  virtual bool GetPolygonPDLight (int polygon_idx, size_t pdlight_index, 
    csRef<iImage>& map, iLight*& light) = 0;
  virtual iMaterialWrapper* GetReplacedMaterial (iMaterialWrapper* oldMat) = 0;
};

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

  virtual void Clear () = 0;

  virtual int GetLightmapCellSize () const = 0;
  virtual void SetLightmapCellSize (int Size) = 0;
  virtual int GetDefaultLightmapCellSize () const = 0;
};

#endif // __CS_IMESH_THING_H__

---