CEL

Public API Reference

propclass/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 struct iCelEntity;
00026 
00057 struct iPcDefaultCamera : public virtual iPcCamera
00058 {
00059   SCF_INTERFACE (iPcDefaultCamera, 0, 0, 3);
00060 
00064   enum CameraMode
00065   {
00066     freelook = 0,
00067     firstperson,
00068     thirdperson,
00069     m64_thirdperson,
00070     lara_thirdperson,
00071 
00072     actual_data,        // The actual camera data
00073     last_actual,        // Keep reference to the actual data last frame
00074     transition,
00075     camerror,           // Error between actual camera pos and ideal.
00076 
00077     CameraMode_count
00078   };
00079 
00085   virtual void SetFollowEntity (iCelEntity* entity) = 0;
00086 
00090   virtual bool SetMode (CameraMode m, bool use_cd = true) = 0;
00091 
00095   virtual CameraMode GetMode () const = 0;
00096 
00100   virtual bool SetModeName (const char* m, bool use_cd = true) = 0;
00101 
00105   virtual const char* GetModeName () const = 0;
00106 
00111   virtual CameraMode GetNextMode () const = 0;
00112 
00117   virtual bool PointCamera (const char* start) = 0;
00118 
00122   virtual void SetSpringParameters (float springCoef,
00123         float intertialDampeningCoef, float springLength) = 0;
00124 
00130   virtual void SetMinMaxCameraDistance (float minDistance,
00131         float maxDistance) = 0;
00132 
00137   virtual void SetTurnSpeed (float turnSpeed) = 0;
00138 
00142   virtual void SetSwingCoef (float swingCoef) = 0;
00143 
00148   virtual void SetFirstPersonOffset (const csVector3& offset) = 0;
00149 
00154   virtual void SetThirdPersonOffset (const csVector3& offset) = 0;
00155 
00160   virtual void CenterCamera () = 0;
00161 
00165   virtual void SetPitch (float pitch) = 0;
00166 
00170   virtual float GetPitch () const = 0;
00171 
00176   virtual void SetPitchVelocity (float pitchVel) = 0;
00177 
00181   virtual float GetPitchVelocity () const = 0;
00182 
00189   virtual void MovePitch (float deltaPitch, int mode = -1) = 0;
00190 
00197   virtual void SetYaw (float yaw, int mode = -1) = 0;
00198 
00205   virtual void MoveYaw (float deltaYaw, int mode = -1) = 0;
00206 
00213   virtual float GetYaw (int mode = -1) const = 0;
00214 
00219   virtual void SetYawVelocity (float yawVel) = 0;
00220 
00225   virtual float GetYawVelocity () const = 0;
00226 
00232   virtual void SetDistance (float distance, int mode=-1) = 0;
00233 
00239   virtual float GetDistance (int mode=-1) = 0;
00240 
00245   virtual void SetDistanceVelocity (float distanceVel) = 0;
00246 
00251   virtual float GetDistanceVelocity () const = 0;
00252 
00253 };
00254 
00255 #endif // __CEL_PF_DEFAULT_CAMERA_FACTORY__
00256 

Generated for CEL: Crystal Entity Layer 1.2 by doxygen 1.4.7