/*
  BINDING.hpp  -  link to use a sequence within the session

  Copyright (C)         Lumiera.org
    2009,               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 PROC_MOBJECT_SESSION_BINDING_H
#define PROC_MOBJECT_SESSION_BINDING_H

#include "proc/mobject/session/meta.hpp"
#include "proc/mobject/builder/buildertool.hpp"


namespace proc {
namespace asset { 
  class Sequence;
  
  typedef lib::P<Sequence> PSequence;

}

namespace mobject {
namespace session {
  
    using asset::PSequence;
    
    /**
     * Explicit link to bind a Sequence (container) to be used within the Session,
     * either as contents of a top level Timeline, or as embedded MetaClip.
     * Usually, the Placement holding such a Binding also constitutes a scope
     * on its own, containing other nested objects.
     */
    class Binding : public Meta
      {
        PSequence boundSequence_;
        
        string
        initShortID()  const
          {
            return buildShortID("Binding");
          }
        
        bool isValid()  const;
        
      public:
        Binding (PSequence const& sequence_to_bind);
          
        DEFINE_PROCESSABLE_BY (builder::BuilderTool);

      };
    
  } // namespace mobject::session
  
  /** Placement<Binding> defined to be subclass of Placement<Meta> */
  template class Placement<session::Binding, session::Meta>;
  typedef Placement<session::Binding, session::Meta> PBinding;
  
}} // namespace proc::mobject
#endif
