Public API Reference

imesh/genmesh.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_IMESH_GENMESH_H__
#define __CS_IMESH_GENMESH_H__

#include "csutil/scf_interface.h"

struct iDocumentNode;
struct iGenMeshAnimationControl;
struct iGenMeshAnimationControlFactory;
struct iMaterialWrapper;
struct iRenderBuffer;
struct iMeshObject;
struct iString;

class csBox3;
class csColor;
class csColor4;
struct csTriangle;
class csVector2;
class csVector3;
class csEllipsoid;

struct iGeneralMeshSubMesh : public virtual iBase
{
  SCF_INTERFACE (iGeneralMeshSubMesh, 1, 0, 1);
  
  virtual iRenderBuffer* GetIndices () const = 0;

  virtual iMaterialWrapper* GetMaterial () const = 0;
  
  virtual const char* GetName () const = 0;
  
  virtual uint GetMixmode () const = 0;

  virtual void SetMaterial (iMaterialWrapper* material) = 0;
};

struct iGeneralMeshCommonState : public virtual iBase
{
  SCF_INTERFACE (iGeneralMeshCommonState, 1, 2, 0);
  
  virtual void SetLighting (bool l) = 0;
  virtual bool IsLighting () const = 0;
  virtual void SetManualColors (bool m) = 0;
  virtual bool IsManualColors () const = 0;
  virtual void SetShadowCasting (bool m) = 0;
  virtual bool IsShadowCasting () const = 0;
  virtual void SetShadowReceiving (bool m) = 0;
  virtual bool IsShadowReceiving () const = 0;

  virtual bool AddRenderBuffer (const char *name, iRenderBuffer* buffer) = 0;

  virtual bool RemoveRenderBuffer (const char *name) = 0;

  virtual int GetRenderBufferCount () const = 0;

  virtual csRef<iRenderBuffer> GetRenderBuffer (int index) = 0;

  virtual csRef<iString> GetRenderBufferName (int index) const = 0;
};

struct iGeneralMeshState : public virtual iGeneralMeshCommonState
{
  SCF_INTERFACE (iGeneralMeshState, 1, 1, 1);
  
  virtual void SetAnimationControl (iGenMeshAnimationControl* anim_ctrl) = 0;

  virtual iGenMeshAnimationControl* GetAnimationControl () const = 0;
  
  virtual iGeneralMeshSubMesh* FindSubMesh (const char* name) const = 0;
  CS_DEPRECATED_METHOD_MSG("Use AddSubMesh from iGeneralFactoryState instead")
  virtual void AddSubMesh (unsigned int *triangles,
    int tricount,
    iMaterialWrapper *material) = 0;

  CS_DEPRECATED_METHOD_MSG("Use AddSubMesh from iGeneralFactoryState instead")
  virtual void AddSubMesh (unsigned int *triangles,
    int tricount,
    iMaterialWrapper *material, uint mixmode) = 0;
};

struct iGeneralFactoryState : public virtual iGeneralMeshCommonState
{
  SCF_INTERFACE (iGeneralFactoryState, 1, 1, 1);
  
  virtual void SetColor (const csColor& col) = 0;
  virtual const csColor& GetColor () const = 0;
  
  virtual void AddVertex (const csVector3& v,
      const csVector2& uv, const csVector3& normal,
      const csColor4& color) = 0;

  virtual void SetVertexCount (int n) = 0;
  virtual int GetVertexCount () const = 0;
  virtual csVector3* GetVertices () = 0;
  virtual csVector2* GetTexels () = 0;
  virtual csVector3* GetNormals () = 0;
  virtual csColor4* GetColors () = 0;

  virtual void AddTriangle (const csTriangle& tri) = 0;

  virtual void SetTriangleCount (int n) = 0;
  virtual int GetTriangleCount () const = 0;
  virtual csTriangle* GetTriangles () = 0;

  virtual void Invalidate () = 0;

  virtual void CalculateNormals (bool compress = true) = 0;

  virtual void Compress () = 0;

  virtual void GenerateBox (const csBox3& box) = 0;

  virtual void GenerateSphere (const csEllipsoid& ellips, int rim_vertices,
      bool cyl_mapping = false,
      bool toponly = false,
      bool reversed = false) = 0;

  //virtual void GeneratePlane (const csPlane3& plane) = 0;

  virtual void SetBack2Front (bool b2f) = 0;

  virtual bool IsAutoNormals () const = 0;

  virtual bool IsBack2Front () const = 0;

  virtual void SetAnimationControlFactory (
        iGenMeshAnimationControlFactory* anim_ctrl) = 0;

  virtual iGenMeshAnimationControlFactory* GetAnimationControlFactory ()
        const = 0;
  
  virtual void ClearSubMeshes () = 0;
  virtual iGeneralMeshSubMesh* AddSubMesh (iRenderBuffer* indices, 
    iMaterialWrapper *material, const char* name, uint mixmode = (uint)~0) = 0;

  virtual iGeneralMeshSubMesh* FindSubMesh (const char* name) const = 0;
  
  virtual void DeleteSubMesh (iGeneralMeshSubMesh* mesh) = 0;
  
  virtual size_t GetSubMeshCount () const = 0;

  virtual iGeneralMeshSubMesh* GetSubMesh (size_t index) const = 0;
  virtual void DisableAutoNormals () = 0;
};

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

  virtual bool AnimatesVertices () const = 0;
  virtual bool AnimatesTexels () const = 0;
  virtual bool AnimatesNormals () const = 0;
  virtual bool AnimatesColors () const = 0;

  virtual void Update (csTicks current) = 0;

  virtual const csVector3* UpdateVertices (csTicks current,
        const csVector3* verts, int num_verts, uint32 version_id) = 0;

  virtual const csVector2* UpdateTexels (csTicks current,
        const csVector2* texels, int num_texels, uint32 version_id) = 0;

  virtual const csVector3* UpdateNormals (csTicks current,
        const csVector3* normals, int num_normals, uint32 version_id) = 0;

  virtual const csColor4* UpdateColors (csTicks current,
        const csColor4* colors, int num_colors, uint32 version_id) = 0;
};

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

  virtual csPtr<iGenMeshAnimationControl> CreateAnimationControl (
        iMeshObject *mesh) = 0;

  virtual const char* Load (iDocumentNode* node) = 0;

  virtual const char* Save (iDocumentNode* parent) = 0;
};

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

  virtual csPtr<iGenMeshAnimationControlFactory> CreateAnimationControlFactory
        () = 0;
};

#endif // __CS_IMESH_GENMESH_H__

---