Public API Reference

propclass/defcam.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2001-2005 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CEL_PF_DEFAULT_CAMERA__
#define __CEL_PF_DEFAULT_CAMERA__

#include "propclass/camera.h"

struct iCelEntity;

SCF_VERSION (iPcDefaultCamera, 0, 0, 3);

struct iPcDefaultCamera : public iPcCamera
{
public:
  enum CameraMode
  {
    freelook = 0,
    firstperson,
    thirdperson,
    m64_thirdperson,
    lara_thirdperson,

    actual_data,        // The actual camera data
    last_actual,        // Keep reference to the actual data last frame
    transition,
    camerror,           // Error between actual camera pos and ideal.

    CameraMode_count
  };

  virtual void SetFollowEntity (iCelEntity* entity) = 0;

  virtual bool SetMode (CameraMode m, bool use_cd = true) = 0;

  virtual CameraMode GetMode () const = 0;

  virtual bool SetModeName (const char* m, bool use_cd = true) = 0;

  virtual const char* GetModeName () const = 0;

  virtual CameraMode GetNextMode () const = 0;

  virtual bool PointCamera (const char* start) = 0;

  virtual void SetSpringParameters (float springCoef,
        float intertialDampeningCoef, float springLength) = 0;

  virtual void SetMinMaxCameraDistance (float minDistance,
        float maxDistance) = 0;

  virtual void SetTurnSpeed (float turnSpeed) = 0;

  virtual void SetSwingCoef (float swingCoef) = 0;

  virtual void SetFirstPersonOffset (const csVector3& offset) = 0;

  virtual void SetThirdPersonOffset (const csVector3& offset) = 0;

  virtual void CenterCamera () = 0;

  virtual void SetPitch (float pitch) = 0;

  virtual float GetPitch () const = 0;

  virtual void SetPitchVelocity (float pitchVel) = 0;

  virtual float GetPitchVelocity () const = 0;

  virtual void MovePitch (float deltaPitch, int mode = -1) = 0;

  virtual void SetYaw (float yaw, int mode = -1) = 0;

  virtual void MoveYaw (float deltaYaw, int mode = -1) = 0;

  virtual float GetYaw (int mode = -1) const = 0;

  virtual void SetYawVelocity (float yawVel) = 0;

  virtual float GetYawVelocity () const = 0;

  virtual void SetDistance (float distance, int mode=-1) = 0;

  virtual float GetDistance (int mode=-1) = 0;

  virtual void SetDistanceVelocity (float distanceVel) = 0;

  virtual float GetDistanceVelocity () const = 0;

};

#endif // __CEL_PF_DEFAULT_CAMERA_FACTORY__

---