iengine/portal.h
Go to the documentation of this file.00001 /* 00002 Copyright (C) 2003 by Jorrit Tyberghein 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public 00015 License along with this library; if not, write to the Free 00016 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00017 */ 00018 00019 #ifndef __CS_IENGINE_PORTAL_H__ 00020 #define __CS_IENGINE_PORTAL_H__ 00021 00029 #include "csutil/scf.h" 00030 00031 class csFlags; 00032 class csMatrix3; 00033 class csPlane3; 00034 class csReversibleTransform; 00035 class csTransform; 00036 class csVector3; 00037 class csSphere; 00038 00039 struct iFrustumView; 00040 struct iMeshWrapper; 00041 struct iMovable; 00042 struct iObject; 00043 struct iPortal; 00044 struct iSector; 00045 struct iTextureHandle; 00046 00047 00048 00054 #define CS_PORTAL_CLIPDEST 0x00000001 00055 00063 #define CS_PORTAL_CLIPSTRADDLING 0x00000002 00064 00073 #define CS_PORTAL_ZFILL 0x00000004 00074 00081 #define CS_PORTAL_WARP 0x00000008 00082 00088 #define CS_PORTAL_MIRROR 0x00000010 00089 00096 #define CS_PORTAL_STATICDEST 0x00000020 00097 00107 #define CS_PORTAL_FLOAT 0x00000040 00108 00112 #define CS_PORTAL_COLLDET 0x00000080 00113 00117 #define CS_PORTAL_VISCULL 0x00000100 00118 00119 00130 struct iPortalCallback : public virtual iBase 00131 { 00132 SCF_INTERFACE (iPortalCallback, 1, 0, 0); 00133 00138 virtual bool Traverse (iPortal* portal, iBase* context) = 0; 00139 }; 00140 00158 struct iPortal : public virtual iBase 00159 { 00160 SCF_INTERFACE(iPortal, 2,0,1); 00161 00163 virtual void SetName (const char* name) = 0; 00165 virtual const char* GetName () const = 0; 00166 00168 virtual iSector* GetSector () const = 0; 00169 00174 virtual const csVector3* GetVertices () const = 0; 00175 00180 virtual const csVector3* GetWorldVertices () = 0; 00181 00186 virtual int* GetVertexIndices () const = 0; 00187 00191 virtual int GetVertexIndicesCount () const = 0; 00192 00196 virtual const csPlane3& GetObjectPlane () = 0; 00197 00201 virtual const csPlane3& GetWorldPlane () = 0; 00202 00207 virtual const csSphere& GetObjectSphere () = 0; 00208 00213 virtual const csSphere& GetWorldSphere () = 0; 00214 00218 virtual void ComputeCameraPlane (const csReversibleTransform& t, 00219 csPlane3& camplane) = 0; 00220 00225 virtual bool PointOnPolygon (const csVector3& point) = 0; 00226 00231 virtual void SetSector (iSector* s) = 0; 00232 00234 virtual csFlags& GetFlags () = 0; 00235 00242 virtual void SetMaximumSectorVisit (int msv) = 0; 00244 virtual int GetMaximumSectorVisit () const = 0; 00245 00252 virtual void SetPortalCallback (iPortalCallback* cb) = 0; 00253 00257 virtual void RemovePortalCallback (iPortalCallback* cb) = 0; 00258 00260 virtual int GetPortalCallbackCount () const = 0; 00261 00263 virtual iPortalCallback* GetPortalCallback (int idx) const = 0; 00264 00271 virtual void SetMissingSectorCallback (iPortalCallback* cb) = 0; 00272 00276 virtual void RemoveMissingSectorCallback (iPortalCallback* cb) = 0; 00277 00279 virtual int GetMissingSectorCallbackCount () const = 0; 00280 00282 virtual iPortalCallback* GetMissingSectorCallback (int idx) const = 0; 00283 00285 virtual void SetFilter (iTextureHandle* ft) = 0; 00287 virtual iTextureHandle* GetTextureFilter () const = 0; 00288 00290 virtual void SetFilter (float r, float g, float b) = 0; 00292 virtual void GetColorFilter (float &r, float &g, float &b) const = 0; 00293 00294 //---- space warping ------------------------------------------------------ 00295 00300 virtual void SetWarp (const csMatrix3 &m_w, const csVector3 &v_w_before, 00301 const csVector3 &v_w_after) = 0; 00306 virtual void SetWarp (const csTransform& t) = 0; 00307 00309 virtual void SetMirror (const csPlane3& plane) = 0; 00310 00312 virtual const csReversibleTransform &GetWarp () const = 0; 00313 00315 virtual void HardTransform (const csReversibleTransform& t) = 0; 00316 00321 virtual void ObjectToWorld (const csReversibleTransform& t, 00322 csReversibleTransform& warp_wor) const = 0; 00323 00328 virtual csVector3 Warp (const csReversibleTransform& t, 00329 const csVector3& pos) const = 0; 00330 00342 virtual void WarpSpace (const csReversibleTransform& warp_wor, 00343 csReversibleTransform& t, bool& mirror) const = 0; 00344 00345 //------------------------------------------------------------------------- 00346 00352 virtual bool CompleteSector (iBase* context) = 0; 00353 00360 virtual void CheckFrustum (iFrustumView* lview, 00361 const csReversibleTransform& t, int alpha) = 0; 00362 00372 virtual iMeshWrapper* HitBeamPortals (const csReversibleTransform& t, 00373 const csVector3& start, const csVector3& end, 00374 csVector3& isect, int* polygon_idx, iSector** final_sector = 0) = 0; 00375 00379 virtual size_t GetVerticesCount () const = 0; 00380 00381 }; 00382 00385 #endif // __CS_IENGINE_PORTAL_H__ 00386
Generated for Crystal Space 1.4.0 by doxygen 1.5.8