Public API Reference

iengine/mesh.h

Go to the documentation of this file.

/*
    Copyright (C) 2000-2001 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_IENGINE_MESH_H__
#define __CS_IENGINE_MESH_H__

#include "csutil/scf.h"

#include "csgeom/box.h"
#include "csgeom/vector3.h"

#include "ivideo/graph3d.h"

struct iCamera;
struct iLightingInfo;
struct iLODControl;
struct iMeshFactoryList;
struct iMeshFactoryWrapper;
struct iMeshList;
struct iMeshObject;
struct iMeshObjectFactory;
struct iMeshWrapper;
struct iMovable;
struct iObject;
struct iPortalContainer;
struct iRenderView;
struct iShaderVariableContext;
struct iShadowCaster;
struct iShadowReceiver;
struct iSharedVariable;
struct iSceneNode;
struct iMaterialWrapper;

struct csRenderMesh;

class csEllipsoid;
class csFlags;
class csReversibleTransform;

#define CS_ENTITY_DETAIL 2

#define CS_ENTITY_CAMERA 4

#define CS_ENTITY_INVISIBLEMESH 8

#define CS_ENTITY_INVISIBLE (CS_ENTITY_INVISIBLEMESH+CS_ENTITY_NOHITBEAM)

#define CS_ENTITY_NOSHADOWS 16

#define CS_ENTITY_NOLIGHTING 32

#define CS_ENTITY_NOHITBEAM 64

#define CS_ENTITY_NOCLIP 128

#define CS_LIGHTINGUPDATE_SORTRELEVANCE 1

#define CS_LIGHTINGUPDATE_ALWAYSUPDATE 2

SCF_VERSION (iMeshDrawCallback, 0, 0, 1);

struct iMeshDrawCallback : public iBase
{
  virtual bool BeforeDrawing (iMeshWrapper* spr, iRenderView* rview) = 0;
};

struct csHitBeamResult
{
  csVector3 isect;
  float r;
  int polygon_idx;
  iMaterialWrapper* material;
  int facehit;
  bool hit;
};

struct csScreenBoxResult
{
  csBox2 sbox;
  csBox3 cbox;
  float distance;
};

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

  virtual iObject *QueryObject () = 0;

  virtual iMeshObject* GetMeshObject () const = 0;
  virtual void SetMeshObject (iMeshObject*) = 0;
  virtual iPortalContainer* GetPortalContainer () const = 0;

  virtual iLightingInfo* GetLightingInfo () const = 0;

  virtual iShadowReceiver* GetShadowReceiver () = 0;

  virtual iShadowCaster* GetShadowCaster () = 0;

  virtual iMeshFactoryWrapper *GetFactory () const = 0;
  virtual void SetFactory (iMeshFactoryWrapper* factory) = 0;

  virtual void SetLightingUpdate (int flags, int num_lights) = 0;

  virtual iMovable* GetMovable () const = 0;

  virtual iSceneNode* QuerySceneNode () = 0;

  virtual iMeshWrapper* FindChildByName (const char* name) = 0;

  virtual void PlaceMesh () = 0;

  CS_DEPRECATED_METHOD_MSG("Use HitBeamBBox() with csHitBeamResult instead.")
  virtual int HitBeamBBox (const csVector3& start,
        const csVector3& end, csVector3& isect, float* pr) = 0;

  CS_DEPRECATED_METHOD_MSG("Use HitBeamOutline() with csHitBeamResult instead.")
  virtual bool HitBeamOutline (const csVector3& start,
        const csVector3& end, csVector3& isect, float* pr) = 0;

  CS_DEPRECATED_METHOD_MSG("Use HitBeamObject() with csHitBeamResult instead.")
  virtual bool HitBeamObject (const csVector3& start,
        const csVector3& end, csVector3& isect, float* pr,
        int* polygon_idx = 0) = 0;

  CS_DEPRECATED_METHOD_MSG("Use HitBeamObject() with csHitBeamResult instead.")
  virtual bool HitBeam (const csVector3& start,
        const csVector3& end, csVector3& isect, float* pr,
        iMaterialWrapper** material = 0) = 0;

  virtual csHitBeamResult HitBeamBBox (const csVector3& start,
        const csVector3& end) = 0;

  virtual csHitBeamResult HitBeamOutline (const csVector3& start,
        const csVector3& end) = 0;

  virtual csHitBeamResult HitBeamObject (const csVector3& start,
        const csVector3& end, bool do_material = false) = 0;

  virtual csHitBeamResult HitBeam (const csVector3& start,
        const csVector3& end, bool do_material = false) = 0;

  virtual void SetDrawCallback (iMeshDrawCallback* cb) = 0;

  virtual void RemoveDrawCallback (iMeshDrawCallback* cb) = 0;

  virtual int GetDrawCallbackCount () const = 0;

  virtual iMeshDrawCallback* GetDrawCallback (int idx) const = 0;

  virtual void SetRenderPriority (long rp) = 0;
  virtual long GetRenderPriority () const = 0;

  virtual void SetRenderPriorityRecursive (long rp) = 0;

  virtual csFlags& GetFlags () = 0;

  virtual void SetFlagsRecursive (uint32 mask, uint32 flags = ~0) = 0;

  virtual void SetZBufMode (csZBufMode mode) = 0;
  virtual csZBufMode GetZBufMode () const = 0;
  virtual void SetZBufModeRecursive (csZBufMode mode) = 0;

  virtual void HardTransform (const csReversibleTransform& t) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetWorldBoundingBox that returns a csBox3 "
                           "instead")
  virtual void GetWorldBoundingBox (csBox3& cbox) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetTransformedBoundingBox that returns a "
                           "csBox3 instead")
  virtual void GetTransformedBoundingBox (const csReversibleTransform& trans, 
    csBox3& cbox) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetScreenBoundingBox() that returns a "
                           "csScreenBoxResult instead")
  virtual float GetScreenBoundingBox (iCamera* camera, csBox2& sbox, 
    csBox3& cbox) = 0;

  virtual const csBox3& GetWorldBoundingBox () = 0;

  virtual csBox3 GetTransformedBoundingBox (
        const csReversibleTransform& trans) = 0;

  virtual csScreenBoxResult GetScreenBoundingBox (iCamera* camera) = 0;

  CS_DEPRECATED_METHOD_MSG("Use GetRadius() that returns csEllipsoid")
  virtual void GetRadius (float& rad, csVector3& cent) const = 0;
  virtual csSphere GetRadius () const = 0;

  virtual void ResetMinMaxRenderDistance () = 0;

  virtual void SetMinimumRenderDistance (float min) = 0;

  virtual float GetMinimumRenderDistance () const = 0;

  virtual void SetMaximumRenderDistance (float min) = 0;

  virtual float GetMaximumRenderDistance () const = 0;

  virtual void SetMinimumRenderDistanceVar (iSharedVariable* min) = 0;

  virtual iSharedVariable* GetMinimumRenderDistanceVar () const = 0;

  virtual void SetMaximumRenderDistanceVar (iSharedVariable* min) = 0;

  virtual iSharedVariable* GetMaximumRenderDistanceVar () const = 0;

  virtual iLODControl* CreateStaticLOD () = 0;

  virtual void DestroyStaticLOD () = 0;

  virtual iLODControl* GetStaticLOD () = 0;

  virtual void AddMeshToStaticLOD (int lod, iMeshWrapper* mesh) = 0;

  virtual void RemoveMeshFromStaticLOD (iMeshWrapper* mesh) = 0;

  virtual iShaderVariableContext* GetSVContext() = 0;
};

struct iMeshFactoryWrapper : public virtual iBase
{
  SCF_INTERFACE(iMeshFactoryWrapper, 2,0,0);
  virtual iObject *QueryObject () = 0;
  virtual iMeshObjectFactory* GetMeshObjectFactory () const = 0;
  virtual void SetMeshObjectFactory (iMeshObjectFactory* fact) = 0;
  virtual void HardTransform (const csReversibleTransform& t) = 0;
  virtual csPtr<iMeshWrapper> CreateMeshWrapper () = 0;

  virtual csFlags& GetFlags () = 0;

  virtual iMeshFactoryWrapper* GetParentContainer () const = 0;
  virtual void SetParentContainer (iMeshFactoryWrapper *p) = 0;

  virtual iMeshFactoryList* GetChildren () = 0;

  virtual csReversibleTransform& GetTransform () = 0;

  virtual void SetTransform (const csReversibleTransform& tr) = 0;

  virtual iLODControl* CreateStaticLOD () = 0;

  virtual void DestroyStaticLOD () = 0;

  virtual iLODControl* GetStaticLOD () = 0;

  virtual void SetStaticLOD (float m, float a) = 0;

  virtual void GetStaticLOD (float& m, float& a) const = 0;

  virtual void AddFactoryToStaticLOD (int lod, iMeshFactoryWrapper* fact) = 0;

  virtual void RemoveFactoryFromStaticLOD (iMeshFactoryWrapper* fact) = 0;

  virtual void SetZBufMode (csZBufMode mode) = 0;
  virtual csZBufMode GetZBufMode () const = 0;
  virtual void SetZBufModeRecursive (csZBufMode mode) = 0;

  virtual void SetRenderPriority (long rp) = 0;
  virtual long GetRenderPriority () const = 0;

  virtual void SetRenderPriorityRecursive (long rp) = 0;

  virtual iShaderVariableContext* GetSVContext() = 0;
};

struct iMeshList : public virtual iBase
{
  SCF_INTERFACE(iMeshList, 2,0,0);
  virtual int GetCount () const = 0;

  virtual iMeshWrapper *Get (int n) const = 0;

  virtual int Add (iMeshWrapper *obj) = 0;

  virtual bool Remove (iMeshWrapper *obj) = 0;

  virtual bool Remove (int n) = 0;

  virtual void RemoveAll () = 0;

  virtual int Find (iMeshWrapper *obj) const = 0;

  virtual iMeshWrapper *FindByName (const char *Name) const = 0;
};

struct iMeshFactoryList : public virtual iBase
{
  SCF_INTERFACE(iMeshFactoryList,2,0,0);
  virtual int GetCount () const = 0;

  virtual iMeshFactoryWrapper *Get (int n) const = 0;

  virtual int Add (iMeshFactoryWrapper *obj) = 0;

  virtual bool Remove (iMeshFactoryWrapper *obj) = 0;

  virtual bool Remove (int n) = 0;

  virtual void RemoveAll () = 0;

  virtual int Find (iMeshFactoryWrapper *obj) const = 0;

  virtual iMeshFactoryWrapper *FindByName (const char *Name) const = 0;
};

struct iMeshWrapperIterator : public virtual iBase
{
  SCF_INTERFACE(iMeshWrapperIterator,2,0,0);
  virtual iMeshWrapper* Next () = 0;

  virtual void Reset () = 0;

  virtual bool HasNext () const = 0;
};


#endif // __CS_IENGINE_MESH_H__

---