time-grid.hpp

Go to the documentation of this file.

/*
  TIME-GRID.hpp  -  reference scale for quantised time
 
   Copyright (C)
     2010,            Hermann Vosseler <Ichthyostega@web.de>
 
 **Lumiera** 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. See the file COPYING for further details.
 
*/
 
 
#ifndef ASSET_META_TIME_GRID_H
#define ASSET_META_TIME_GRID_H
 
#include "steam/asset/meta.hpp"
#include "lib/idi/entry-id.hpp"
#include "lib/time/grid.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/symbol.hpp"
 
 
 
namespace steam {
namespace asset {
namespace meta {
  
  using lib::Symbol;
  using lib::time::Time;
  using lib::time::TimeVar;
  using lib::time::TimeValue;
  using lib::time::FrameRate;
  using lib::time::FSecs;
  
  
  class TimeGrid;
  using PGrid = lib::P<TimeGrid>;
  using GridID = lib::idi::EntryID<TimeGrid>;
  
  
  class TimeGrid
    : public Meta
    , public virtual lib::time::Grid
    {
    public:
      /* === shortcut builder functions === */
      static PGrid build (FrameRate frames_per_second);
      static PGrid build (Symbol gridID, FrameRate frames_per_second);
      static PGrid build (Symbol gridID, FrameRate frames_per_second, Time origin);
      
    protected:
      TimeGrid (GridID const&);
    };
  
  
  
  
  template<>
  struct Builder<TimeGrid>
    {
      string id;
      
      FrameRate fps;
      TimeVar origin;
      
      lib::P<TimeGrid> predecessor;
      
      Builder(string const& nameID  ="")
        : id {nameID}
        , fps{1}
        , origin{TimeValue(0)}
        , predecessor{}
        { }
      
      lib::P<TimeGrid> commit();
      
    };
  
}}} // namespace steam::asset::meta
#endif