OP/OP_DopeBuffer.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.
 *
 * Produced by:
 *      Robert Pringle
 *      Side Effects Software Inc.
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada  M5v 3E7
 *      416-504-9876
 *
 * NAME:        OP_DopeBuffer.h (C++)
 *
 */

#ifndef __OP_DopeBuffer_h__
#define __OP_DopeBuffer_h__

#include "OP_API.h"
#include <UT/UT_String.h>
#include "OP_Channels.h"
#include "OP_MultiChannel.h"

// forward declaration
template<typename T> class UT_RefArray;


class OP_API OP_DopeBuffer
{
public:
    OP_DopeBuffer();
    virtual ~OP_DopeBuffer();

    void        clearAndDestroy();

    // frame_mask - parameter that masks which keys are copied from the rows
    //   If it is NULL, all keys are copied. If it is not NULL, this
    //   method copies only these keys from rows whose frame is specified
    //   in an int array (in frame_masks) corresponding to a given row.
    // PRE:
    //   This parameter should contain arrays sorted in ascending order. 
    //   All entries should have values no less than x1 and no greater than x2
    void        copyKeys(const OP_MultiChannelRefArray &rows, 
                         int x1, int y1, int x2, int y2, int forceKeys = 0,
                         const UT_RefArray<UT_IntArray> *row_frame_masks =NULL,
                         int *row_offset = NULL);
    void        cutKeys(const OP_MultiChannelRefArray &rows, 
                        int x1, int y1, int x2, int y2, int forceKeys = 0);
    static void deleteKeys(const OP_MultiChannelRefArray &rows, 
                        int x1, int y1, int x2, int y2);
    void        replaceKeys(const OP_MultiChannelRefArray &rows, 
                            int x1, int y1, int x2, int y2);

    void        pasteKeys(const OP_MultiChannelRefArray &rows, 
                          int x1, int y1 ) const;

    void        print();
    int         save();
    int         load();

    const OP_MultiChannelRefArray & getRows() const         { return myRows; }

    void            getChannelList( CH_ChannelList &channels ) const;

    void            getDimensions(int &x1, int &x2, int &numRows);
    void            getMaxDimensions(int &x1, int &x2, int &numRows);
    void            duplicate(OP_DopeBuffer &copy);

    // set the "window" of keyframes that we are interested in
    void            setStartEnd(int start, int end)
                    { myStartFrame = start, myEndFrame = end; }
    int             getStart() const    { return myStartFrame; }
    int             getEnd() const      { return myEndFrame; }

    CH_Channel *    dupChannel(const CH_Channel &from);

    void            setTargetChannel( const CH_Channel *target ) const;

private:
    // load and save the copy buffer. 
    int                 save(const char *filename);
    int                 load(const char *filename);

    void                pasteChannelKeys( CH_Channel *from_chp,
                                          CH_Channel *to_chp, int x1) const;

    OP_DopeBuffer( const OP_DopeBuffer &copy );          // not implemented
    OP_DopeBuffer &operator=(const OP_DopeBuffer &copy );// not implemented

private:
    OP_MultiChannelRefArray     myRows;

    OP_Channels                 myCollection;
    int                         myStartFrame;
    int                         myEndFrame;     
};

#endif

---