TuttleOFX  1
TuttleOFX/libraries/tuttle/src/tuttle/host/ofx/OfxhTimeline.hpp
Go to the documentation of this file.
00001 /*
00002  * Software License :
00003  *
00004  * Copyright (c) 2007-2009, The Open Effects Association Ltd.  All Rights Reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions are met:
00008  *
00009  * Redistributions of source code must retain the above copyright notice,
00010  *    this list of conditions and the following disclaimer.
00011  * Redistributions in binary form must reproduce the above copyright notice,
00012  *    this list of conditions and the following disclaimer in the documentation
00013  *    and/or other materials provided with the distribution.
00014  * Neither the name The Open Effects Association Ltd, nor the names of its
00015  *    contributors may be used to endorse or promote products derived from this
00016  *    software without specific prior written permission.
00017  *
00018  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00019  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00020  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00021  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
00022  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00023  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00024  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00025  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00026  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00027  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef _OfxhTimeline_h_
00031 #define _OfxhTimeline_h_
00032 
00033 #include "OfxhIObject.hpp"
00034 #include <ofxTimeLine.h>
00035 
00036 namespace tuttle {
00037 namespace host {
00038 namespace ofx {
00039 
00040 /**
00041  * Things that implement timeline controls derive from this ABC and implement the following
00042  * functions.
00043  */
00044 class OfxhITimeline : virtual public OfxhIObject
00045 {
00046 public:
00047         virtual ~OfxhITimeline() {}
00048 
00049         /// get the current time on the timeline. This is not necessarily the same
00050         /// time as being passed to an action (eg render)
00051         virtual double timelineGetTime() = 0;
00052 
00053         /// set the timeline to a specific time
00054         virtual void timelineGotoTime( double t ) = 0;
00055 
00056         /// get the first and last times available on the effect's timeline
00057         virtual void timelineGetBounds( double& t1, double& t2 ) = 0;
00058 };
00059 
00060 }
00061 }
00062 }
00063 
00064 #endif
00065