CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

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 
00031 #define CS_VEC_FORWARD   csVector3(0,0,1)
00032 #define CS_VEC_BACKWARD  csVector3(0,0,-1)
00033 #define CS_VEC_RIGHT     csVector3(1,0,0)
00034 #define CS_VEC_LEFT      csVector3(-1,0,0)
00035 #define CS_VEC_UP        csVector3(0,1,0)
00036 #define CS_VEC_DOWN      csVector3(0,-1,0)
00037 
00038 #define CS_VEC_ROT_RIGHT  csVector3(0,1,0)
00039 #define CS_VEC_ROT_LEFT   csVector3(0,-1,0)
00040 #define CS_VEC_TILT_RIGHT (-csVector3(0,0,1))
00041 #define CS_VEC_TILT_LEFT  (-csVector3(0,0,-1))
00042 #define CS_VEC_TILT_UP    (-csVector3(1,0,0))
00043 #define CS_VEC_TILT_DOWN  (-csVector3(-1,0,0))
00044 
00045 class csOrthoTransform;
00046 class csPlane3;
00047 class csVector2;
00048 class csVector3;
00049 
00050 struct iSector;
00051 struct iCamera;
00052 
00053 SCF_VERSION (iCameraSectorListener, 0, 0, 1);
00054 
00059 struct iCameraSectorListener : public iBase
00060 {
00062   virtual void NewSector (iCamera* camera, iSector* sector) = 0;
00063 };
00064 
00065 SCF_VERSION (iCamera, 0, 2, 0);
00066 
00103 struct iCamera : public iBase
00104 {
00109   virtual iCamera *Clone () const = 0;
00110 
00112   virtual int GetFOV () const = 0;
00114   virtual float GetInvFOV () const = 0;
00116   virtual float GetFOVAngle () const = 0;
00117 
00122   virtual void SetFOV (int fov, int width) = 0;
00127   virtual void SetFOVAngle (float fov, int width) = 0;
00128 
00133   virtual float GetShiftX () const = 0;
00138   virtual float GetShiftY () const = 0;
00143   virtual void SetPerspectiveCenter (float x, float y) = 0;
00144 
00153   virtual csOrthoTransform& GetTransform () = 0;
00154 
00156   virtual const csOrthoTransform& GetTransform () const = 0;
00157 
00162   virtual void SetTransform (const csOrthoTransform& tr) = 0;
00163 
00170   virtual void MoveWorld (const csVector3& v, bool cd = true) = 0;
00174   virtual void Move (const csVector3& v, bool cd = true) = 0;
00182   virtual void MoveWorldUnrestricted (const csVector3& v) = 0;
00190   virtual void MoveUnrestricted (const csVector3& v) = 0;
00191 
00193   virtual iSector* GetSector () const = 0;
00195   virtual void SetSector (iSector*) = 0;
00196 
00201   virtual void Correct (int n) = 0;
00202 
00204   virtual bool IsMirrored () const = 0;
00206   virtual void SetMirrored (bool m) = 0;
00207 
00214   virtual csPlane3* GetFarPlane () const = 0;
00215 
00224   virtual void SetFarPlane (csPlane3* fp) = 0;
00225 
00232   virtual long GetCameraNumber () const = 0;
00233 
00238   CS_DEPRECATED_METHOD virtual void Perspective (const csVector3& v,
00239         csVector2& p) const = 0;
00244   CS_DEPRECATED_METHOD virtual void InvPerspective (const csVector2& p, float z,
00245         csVector3& v) const = 0;
00247   virtual csVector2 Perspective (const csVector3& v) const = 0;
00249   virtual csVector3 InvPerspective (const csVector2& p, float z) const = 0;
00250 
00258   virtual void OnlyPortals (bool hop) = 0;
00259 
00261   virtual bool GetOnlyPortals () = 0;
00262 
00264   virtual void AddCameraSectorListener (iCameraSectorListener* listener) = 0;
00266   virtual void RemoveCameraSectorListener (iCameraSectorListener* listener) = 0;
00267 };
00268 
00271 #endif // __CS_IENGINE_CAMERA_H__
00272 

Generated for Crystal Space by doxygen 1.4.4