/*  Starshatter OpenSource Distribution
    Copyright (c) 1997-2004, Destroyer Studios LLC.
    All Rights Reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name "Destroyer Studios" nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    SUBSYSTEM:    Stars.exe
    FILE:         CameraDirector.h
    AUTHOR:       John DiCamillo


    OVERVIEW
    ========
    Camera Director singleton manages the main view camera based on the current ship
*/

#ifndef CameraDirector_h
#define CameraDirector_h

#include "Types.h"
#include "Camera.h"
#include "SimObject.h"
#include "List.h"

// +--------------------------------------------------------------------+

class HUDView;
class Orbital;
class Ship;
class Sim;

// +--------------------------------------------------------------------+

class CameraDirector : public SimObserver
{
public:
    static const char* TYPENAME() { return "CameraDirector"; }

    enum CAM_MODE  {
        MODE_NONE,

        MODE_COCKPIT,
        MODE_CHASE,
        MODE_TARGET,
        MODE_THREAT,
        MODE_ORBIT,
        MODE_VIRTUAL,
        MODE_TRANSLATE,
        MODE_ZOOM,
        MODE_DOCKING,
        MODE_DROP,

        MODE_LAST
    };

    // CONSTRUCTORS:
    CameraDirector();
    virtual ~CameraDirector();

    int operator == (const CameraDirector& that) const { return this == &that; }

    static CameraDirector* GetInstance();

    // CAMERA:
    static  int       GetCameraMode();
    static  void      SetCameraMode(int m, double trans_time=1);
    static  const char* GetModeName();

    static  double    GetRangeLimit();
    static  void      SetRangeLimit(double r);
    static  void      SetRangeLimits(double min, double max);

    virtual void      Reset();
    virtual void      SetMode(int m, double trans_time=1);
    virtual int       GetMode() const            { return requested_mode > MODE_NONE ? requested_mode : mode; }
    virtual Camera*   GetCamera()                { return &camera; }
    virtual Ship*     GetShip()                  { return ship;    }
    virtual void      SetShip(Ship* s);

    virtual void      VirtualHead(double az, double el);
    virtual void      VirtualHeadOffset(double x, double y, double z);
    virtual void      VirtualAzimuth(double delta);
    virtual void      VirtualElevation(double delta);
    virtual void      ExternalAzimuth(double delta);
    virtual void      ExternalElevation(double delta);
    virtual void      ExternalRange(double delta);
    virtual void      SetOrbitPoint(double az, double el, double range);
    virtual void      SetOrbitRates(double az_rate, double el_rate, double r_rate);

    static  bool      IsViewCentered();

    virtual void      CycleViewObject();

    virtual Orbital*  GetViewOrbital() const { return external_body; }
    virtual Ship*     GetViewObject()  const { return external_ship; }

    virtual void      SetViewOrbital(Orbital* orb);
    virtual void      SetViewObject(Ship* obj,                 bool quick=false);
    virtual void      SetViewObjectGroup(ListIter<Ship> group, bool quick=false);
    virtual void      ClearGroup();

    // BEHAVIORS:
    virtual void      ExecFrame(double s);
    virtual void      Transition(double s);

    // SimObserver:
    virtual bool         Update(SimObject* obj);
    virtual const char*  GetObserverName() const;

protected:
    virtual void      Cockpit(double s);
    virtual void      Chase(double s);
    virtual void      Target(double s);
    virtual void      Threat(double s);
    virtual void      Virtual(double s);
    virtual void      Orbit(double s);
    virtual void      Docking(double s);
    virtual void      Drop(double s);

    int               mode;
    int               requested_mode;
    int               old_mode;
    Camera            camera;

    Ship*             ship;

    SimRegion*        region;
    Orbital*          external_body;
    Ship*             external_ship;
    List<Ship>        external_group;
    Point             external_point;

    Point             base_loc;

    double            virt_az;
    double            virt_el;
    double            virt_x;
    double            virt_y;
    double            virt_z;
    double            azimuth;
    double            elevation;
    double            az_rate;
    double            el_rate;
    double            range_rate;
    double            range;
    double            range_min;
    double            range_max;
    double            base_range;
    double            transition;

    Sim*              sim;
    HUDView*          hud;

    static CameraDirector* instance;
};

#endif  // CameraDirector_h