CEL

Public API Reference

Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members

defcam.h

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001-2005 by Jorrit Tyberghein
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_DEFAULT_CAMERA__
00021 #define __CEL_PF_DEFAULT_CAMERA__
00022 
00023 #include "propclass/camera.h"
00024 
00025 SCF_VERSION (iPcDefaultCamera, 0, 0, 3);
00026 
00044 class iPcDefaultCamera : public iPcCamera
00045 {
00046 public:
00050   enum CameraMode
00051   {
00052     freelook = 0,
00053     firstperson,
00054     thirdperson,
00055     m64_thirdperson,
00056     lara_thirdperson,
00057 
00058     actual_data,        // The actual camera data
00059     last_actual,        // Keep reference to the actual data last frame
00060     transition,
00061     camerror,           // Error between actual camera pos and ideal.
00062 
00063     CameraMode_count
00064   };
00065 
00069   virtual bool SetMode (CameraMode m, bool use_cd = true) = 0;
00070 
00074   virtual CameraMode GetMode () const = 0;
00075 
00079   virtual bool SetModeName (const char* m, bool use_cd = true) = 0;
00080 
00084   virtual const char* GetModeName () const = 0;
00085 
00090   virtual CameraMode GetNextMode () const = 0;
00091 
00095   virtual void SetSpringParameters (float springCoef,
00096         float intertialDampeningCoef, float springLength) = 0;
00097 
00103   virtual void SetMinMaxCameraDistance (float minDistance,
00104         float maxDistance) = 0;
00105 
00110   virtual void SetTurnSpeed (float turnSpeed) = 0;
00111 
00115   virtual void SetSwingCoef (float swingCoef) = 0;
00116 
00121   virtual void SetFirstPersonOffset (const csVector3& offset) = 0;
00122 
00127   virtual void SetThirdPersonOffset (const csVector3& offset) = 0;
00128 
00133   virtual void CenterCamera () = 0;
00134 
00138   virtual void SetPitch (float pitch) = 0;
00139 
00143   virtual float GetPitch () const = 0;
00144 
00149   virtual void SetPitchVelocity (float pitchVel) = 0;
00150 
00154   virtual float GetPitchVelocity () const = 0;
00155 
00162   virtual void MovePitch (float deltaPitch, int mode = -1) = 0;
00163 
00170   virtual void SetYaw (float yaw, int mode = -1) = 0;
00171 
00178   virtual void MoveYaw (float deltaYaw, int mode = -1) = 0;
00179 
00186   virtual float GetYaw (int mode = -1) const = 0;
00187 
00192   virtual void SetYawVelocity (float yawVel) = 0;
00193 
00198   virtual float GetYawVelocity () const = 0;
00199 
00205   virtual void SetDistance (float distance, int mode=-1) = 0;
00206 };
00207 
00208 #endif // __CEL_PF_DEFAULT_CAMERA_FACTORY__
00209 

Generated for CEL: Crystal Entity Layer by doxygen 1.4.4