CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iengine/camera.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 1998-2001 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_CAMERA_H__
00020 #define __CS_IENGINE_CAMERA_H__
00021 
00029 #include "csutil/scf.h"
00030 #include "csgeom/transfrm.h"
00031 
00032 #define CS_VEC_FORWARD   csVector3(0,0,1)
00033 #define CS_VEC_BACKWARD  csVector3(0,0,-1)
00034 #define CS_VEC_RIGHT     csVector3(1,0,0)
00035 #define CS_VEC_LEFT      csVector3(-1,0,0)
00036 #define CS_VEC_UP        csVector3(0,1,0)
00037 #define CS_VEC_DOWN      csVector3(0,-1,0)
00038 
00039 #define CS_VEC_ROT_RIGHT  csVector3(0,1,0)
00040 #define CS_VEC_ROT_LEFT   csVector3(0,-1,0)
00041 #define CS_VEC_TILT_RIGHT (-csVector3(0,0,1))
00042 #define CS_VEC_TILT_LEFT  (-csVector3(0,0,-1))
00043 #define CS_VEC_TILT_UP    (-csVector3(1,0,0))
00044 #define CS_VEC_TILT_DOWN  (-csVector3(-1,0,0))
00045 
00046 class csCamera;
00047 class csVector3;
00048 class csVector2;
00049 struct iSector;
00050 struct iMeshWrapper;
00051 
00052 SCF_VERSION (iCamera, 0, 2, 0);
00053 
00090 struct iCamera : public iBase
00091 {
00093   virtual iCamera *Clone () const = 0;
00094 
00096   virtual int GetFOV () const = 0;
00098   virtual float GetInvFOV () const = 0;
00100   virtual float GetFOVAngle () const = 0;
00101 
00106   virtual void SetFOV (int fov, int width) = 0;
00111   virtual void SetFOVAngle (float fov, int width) = 0;
00112 
00117   virtual float GetShiftX () const = 0;
00122   virtual float GetShiftY () const = 0;
00127   virtual void SetPerspectiveCenter (float x, float y) = 0;
00128 
00137   virtual csOrthoTransform& GetTransform () = 0;
00138 
00140   virtual const csOrthoTransform& GetTransform () const = 0;
00141 
00146   virtual void SetTransform (const csOrthoTransform& tr) = 0;
00147 
00154   virtual void MoveWorld (const csVector3& v, bool cd = true) = 0;
00158   virtual void Move (const csVector3& v, bool cd = true) = 0;
00166   virtual void MoveWorldUnrestricted (const csVector3& v) = 0;
00174   virtual void MoveUnrestricted (const csVector3& v) = 0;
00175 
00177   virtual iSector* GetSector () const = 0;
00179   virtual void SetSector (iSector*) = 0;
00180 
00185   virtual void Correct (int n) = 0;
00186 
00188   virtual bool IsMirrored () const = 0;
00190   virtual void SetMirrored (bool m) = 0;
00191 
00198   virtual csPlane3* GetFarPlane () const = 0;
00199 
00208   virtual void SetFarPlane (csPlane3* fp) = 0;
00209 
00216   virtual long GetCameraNumber () const = 0;
00217 
00219   virtual void Perspective (const csVector3& v, csVector2& p) const = 0;
00221   virtual void InvPerspective (const csVector2& p, float z,
00222         csVector3& v) const = 0;
00223 
00231   virtual void OnlyPortals (bool hop) = 0;
00232 
00234   virtual bool GetOnlyPortals () = 0;
00235 };
00236 
00239 #endif // __CS_IENGINE_CAMERA_H__
00240 

Generated for Crystal Space by doxygen 1.2.18