// $Id: SolarSystem.h 2492 2011-06-27 06:33:04Z matevz $

// Copyright (C) 1999-2008, Matevz Tadel. All rights reserved.
// This file is part of GLED, released under GNU General Public License version 2.
// For the licensing terms see $GLEDSYS/LICENSE or http://www.gnu.org/.

#ifndef Var1_SolarSystem_H
#define Var1_SolarSystem_H

#include <Glasses/ZNode.h>
#include <Glasses/ZVector.h>
#include <Glasses/ODECrawler.h>

#include <Stones/TimeMakerClient.h>
#include <Stones/ZColor.h>

#include <Gled/GCondition.h>

#include <TRandom.h>

class CosmicBall;

class SolarSystem : public ZNode,
		    public ODECrawlerMaster,
                    public TimeMakerClient
{
  MAC_RNR_FRIENDS(SolarSystem);

private:
  Bool_t             hWarnTimeOutOfRange; //!
  Double_t           hStepIntegratorDt;   //!

  void _init();

public:
  enum CrawlMode_e { CM_ChunkedStorage, CM_DirectStep };

protected:
  ZLink<ZVector>     mBalls;      // X{GS} L{a} RnrBits{0,0,0,0, 0,0,0,5}
  ZLink<ODECrawler>  mODECrawler; // X{GS} L{a}

  CrawlMode_e        mCrawlMode;  // X{G}    7 PhonyEnum(-const=>1)

  Double_t           mTime;       // X{G}    7 Value(-range=>[0,1e9,  1,100])
  Double_t           mTimeFac;    // X{GS}   7 Value(-range=>[0,1000, 1,10])

  Int_t              mBallHistorySize; // X{GE} 7 Value(-range=>[0,4096, 1])

  ZColor             mColor;      // X{PRGS} 7 ColorButt()
  Double_t           mStarMass;   // X{GS}   7 Value()
  Double_t           mBallKappa;  // X{GS}   7 Value()

  // Planetoid creation parameters

  TRandom            mPlanetRnd;
  Double_t           mPlanetMinR; // X{GS}   7 Value(-range=>[1,100, 1,100], -join=>1)
  Double_t           mPlanetMaxR; // X{GS}   7 Value(-range=>[1,100, 1,100])
  Double_t           mOrbitMinR;  // X{GS}   7 Value(-range=>[1,10000, 1,10], -join=>1)
  Double_t           mOrbitMaxR;  // X{GS}   7 Value(-range=>[1,10000, 1,10])
  Double_t           mMaxTheta;   // X{GS}   7 Value(-range=>[0,90,    1,100])
  Double_t           mMaxEcc;     // X{GS}   7 Value(-range=>[0,1,     1,1000])
  ZColor             mPlanetColor;// X{PRGS} 7 ColorButt()

  // Chunked-storage stuff.

  class Storage : public ODEStorageD
  {
    Int_t mId;
    Int_t mRefCnt;

  public:

    Storage(Int_t order, Int_t capacity=128) :
      ODEStorageD(order, capacity), mId(0), mRefCnt(0)
    {}

    Storage(const Storage& s) :
      ODEStorageD(s.Order(), 12*s.Size()/10), mId(s.mId + 1), mRefCnt(0)
    {}

    Int_t GetId() const { return mId; }

    // RefCnt -- always call under storage-lock!
    void IncRefCnt() { ++mRefCnt; }
    void DecRefCnt() { if(--mRefCnt <= 0) delete this; }
  };

  typedef map<Double_t, Storage*>           mTime2pStorage_t;
  typedef map<Double_t, Storage*>::iterator mTime2pStorage_i;

  mTime2pStorage_t   mStorageMap;     //!
  mTime2pStorage_i   mCurrentStorage; //!

  Double_t           mTimePerChunk;   // X{GS} 7 Value(-range=>[100,1e4, 1,100])
  Double_t           mKeepPast;       // X{GS} 7 Value(-range=>[100,1e6, 1])
  Double_t           mCalcFuture;     // X{GS} 7 Value(-range=>[100,1e6, 1])

  void             clear_storage();

  mTime2pStorage_i find_storage_from_time(Double_t t);
  Storage*         set_current_storage_from_time(Double_t t);
  Double_t         set_time(Double_t t, Bool_t from_timetick);

  // Direct-step stuff

  GMutex             mBallSwitchMutex;  //!
  list<CosmicBall*>  mBallsToAdd;       //!
  list<CosmicBall*>  mBallsToRemove;    //!

  // Common integrator thread stuff.

  GThread           *mIntegratorThread; //!
  GCondition         mStorageCond;      //!

  static void* tl_IntegratorThread(SolarSystem* ss);
  void         ChunkIntegratorThread();
  void         StepIntegratorThread();

  // Hack for orbit switching - in direct-step mode only.
  Bool_t             bDesiredRHack;   // X{GS}   7 Bool();
  Double_t           mDesiredRHackT0; // X{GS}   7 Value(-range=>[0,20, 1,100])

  void hack_desired_r(Double_t dt);

public:
  SolarSystem(const Text_t* n="SolarSystem", const Text_t* t=0);
  virtual ~SolarSystem();

  virtual void AdEnlightenment();
  // ?? Do i need this one?
  // virtual void AdUnfoldment();  // called by Queen after comet unpacking

  // ODE virtuals
  virtual Int_t  ODEOrder();
  virtual void   ODEStart(Double_t y[], Double_t& x1, Double_t& x2);
  virtual void   ODEDerivatives(Double_t x, const Double_t y[], Double_t d[]);

  void CalculateEnergy(Double_t x, const Double_t y[], Double_t& kinetic, Double_t& potential);

  // TimeMakerClient
  virtual void TimeTick(Double_t t, Double_t dt);

  // Propagator for ChunkedStorage mode.
  void StartChunkIntegratorThread(); // X{E} 7 MCWButt()
  void StartStepIntegratorThread();  // X{E} 7 MCWButt()
  void StopIntegratorThread();       // X{E} 7 MCWButt()

  // Visualization
  void SetTime(Double_t t);     // X{E} 7 MCWButt()

  void SetBallHistorySize(Int_t history_size);

  // Builders
  virtual CosmicBall* RandomPlanetoid(const TString& name);

  virtual void MakeStar();      // X{E} 7 MCWButt()
  virtual void MakePlanetoid(); // X{E} 7 MCWButt()

  virtual void AddPlanetoid(CosmicBall* cb);
  virtual void RemovePlanetoid(CosmicBall* cb);

  // Plotters
  void PlotEnergy(); //! X{Ed} 7 MCWButt()

#include "SolarSystem.h7"
  ClassDef(SolarSystem, 1);
}; // endclass SolarSystem

#endif