session.hpp

Go to the documentation of this file.

/*
  SESSION.hpp  -  holds the complete session to be edited by the user

  Copyright (C)         Lumiera.org
    2008,               Hermann Vosseler <Ichthyostega@web.de>

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

  This program 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 General Public License for more details.

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

*/


#ifndef MOBJECT_SESSION_H
#define MOBJECT_SESSION_H

#include "steam/mobject/placement.hpp"
#include "steam/mobject/mobject-ref.hpp"
#include "common/query/defs-manager.hpp"               
#include "lib/ref-array.hpp"
#include "lib/depend.hpp"
#include "lib/symbol.hpp"
#include "lib/p.hpp"

#include <memory>



namespace steam {
namespace asset {
  class Timeline;    typedef lib::P<Timeline> PTimeline;
  class Sequence;    typedef lib::P<Sequence> PSequence;
}
namespace fixture {
    class Fixture;
    using PFixture = std::shared_ptr<Fixture>;
}

namespace mobject {
  
  namespace session { 
    class SessManager;
    class ElementQuery;
  }
  
  typedef session::SessManager& PSess;  

  
  class Session 
    : util::NonCopyable
    {
    protected:
      typedef lumiera::query::DefsManager&     DefaultsAccess;
      typedef session::ElementQuery&           ElementsAccess;
      typedef lib::RefArray<asset::PTimeline>& TimelineAccess;
      typedef lib::RefArray<asset::PSequence>& SequenceAccess;
      
      
      Session (DefaultsAccess,
               ElementsAccess,
               TimelineAccess,
               SequenceAccess) noexcept;
      virtual ~Session ();
      
      
    public:
      static bool initFlag;                     
      
      static session::SessManager& current;     
      
      DefaultsAccess defaults;                  
      ElementsAccess elements;
      TimelineAccess timelines;                 
      SequenceAccess sequences;                 
      
      virtual bool isValid ()                          = 0;
      virtual MObjectRef attach (PMO const& placement) = 0;
      virtual bool       detach (PMO const& placement) = 0;
      
      virtual MObjectRef getRoot()                     = 0;
      
      virtual fixture::PFixture& getFixture ()         = 0;
      virtual void rebuildFixture ()                   = 0;
      
    };
  
  
  extern const char* ON_SESSION_START;  
  extern const char* ON_SESSION_INIT;   
  extern const char* ON_SESSION_READY;  
  extern const char* ON_SESSION_CLOSE;  
  extern const char* ON_SESSION_END;    
  
  
  namespace session {

    class SessManager
      : util::NonCopyable
      {
      public:
        virtual bool isUp ()  =0;
        
        virtual void clear () =0;
        
        virtual void close () =0;
        
        virtual void reset () =0;
        
        virtual void load ()  =0;

        virtual void save (string snapshotID)  =0;
        
        virtual Session* operator-> ()  noexcept =0;
        
        virtual ~SessManager();
      };

      
      LUMIERA_ERROR_DECLARE (CREATE_SESSION);  


  } // namespace mobject::session

}} // namespace steam::mobject
#endif