UT_Playback.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_Playback.h ( UT Library, C++)
 *
 * COMMENTS:
 *
 *      This class is used to store framebar info for
 *      classes above the SI library. 
 *      
 */

#ifndef __UT_Playback__
#define __UT_Playback__

#include "UT_API.h"
#include "UT_ValArray.h"
#include <SYS/SYS_StaticInit.h>
#include <SYS/SYS_Types.h>

#include <iosfwd>
#include <utility>

class ut_PlayCB;

// cbdata, UT_PlaybackMode, oldframe, newframe
typedef void (*UT_PlayCallback)(void *, int, fpreal, fpreal);
typedef bool (*UT_PlayAdvanceCB)(void *);

class UT_API UT_Playback 
{
public:

     UT_Playback();

    enum UT_PlaybackMode {
        REVERSE,
        STOPPED,
        FORWARD,
        SCRUB,
        RESET,

        FLIPBOOKING
    };

    void                setPlaybackMode(UT_PlaybackMode mode);

    UT_PlaybackMode     getPlaybackMode() const
                        { return myPlayback; }

    int                 getStopCount() const
                        { return myStopCount; }

    void                setRealtimeMode(bool mode)
                        { myRealtimeMode = mode; }

    bool                getRealtimeMode() const
                        { return myRealtimeMode; }

    void                setPlaybackRange(fpreal start,fpreal end)
                        { myStartRange = start; myEndRange = end; }

    void                getPlaybackRange(fpreal &start, fpreal &end) const
                        { start = myStartRange; end = myEndRange; }

    bool                isPlaybackReset();
    bool                isPlaying() const { return (myPlayback == FORWARD ||
                                                    myPlayback == REVERSE); }
    bool                isScrubbing() const { return myPlayback == SCRUB; }

    void                setCurrentFrame(fpreal frame);
    fpreal              getCurrentFrame() { return myCurrentFrame; }

    void                resetAbsoluteFrame(); 
    unsigned long       getAbsoluteFrame() { return myAbsoluteFrame; }

    // tells SI_Playback to stop.
    void                stopPlayback();
    void                setStopCallback(void (*cb)(void *), void *data);

    void                setInterceptMode(int mode) { myInterceptMode = mode; }
    int                 getInterceptMode() const   { return myInterceptMode; }

    void                setEvalStartTime(fpreal eval_start_time) { myEvalStartTime = eval_start_time; }
    fpreal              getEvalStartTime() const { return myEvalStartTime; }

    // Callbacks are passed the UT_PlaybackMode and 'data'.
    void                addPlayCallback(UT_PlayCallback cb, void *cbdata);
    void                removePlayCallback(UT_PlayCallback cb, void *cbdata);

    void                addPlayAdvanceCB(UT_PlayAdvanceCB, void *cbdata);
    void                removePlayAdvanceCB(UT_PlayAdvanceCB, void *cbdata);
    bool                canAdvancePlay();
   
    static UT_Playback *getPlayback();
    
private:

    using CallbackPair = std::pair<UT_PlayAdvanceCB, void *>;

    UT_PlaybackMode                              myPlayback;
    fpreal                                       myStartRange;
    fpreal                                       myEndRange;
    fpreal                                       myCurrentFrame;
    unsigned long                                myAbsoluteFrame;
    bool                                         myRealtimeMode;
    bool                                         myResetFlag;
    int                                          myInterceptMode;
    fpreal                                       myEvalStartTime;
    UT_ValArray<ut_PlayCB *>                     myPlayCallbacks;
    UT_Array<CallbackPair>                       myPlayAdvanceCBs;

    int                                          myStopCount;
};

SYSdeclareStaticObject(UT_API, UTplaybackObject);

#endif