CH_BatchModifyScope.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:        CH_BatchModifyScope.h (CH Library, C++)
 *
 * COMMENTS:    Scoped batch modification of a CH_Channel.
 */

#ifndef __CH_BatchModifyScope_h__
#define __CH_BatchModifyScope_h__

#include "CH_API.h"
#include "CH_EventManager.h"

#include <UT/UT_Array.h>
#include <UT/UT_Assert.h>
#include <UT/UT_NonCopyable.h>

#include <SYS/SYS_Types.h>

#include <tuple>

class CH_Channel;

class CH_API CH_BatchModifyScope
{
public:
    CH_BatchModifyScope(
            CH_Channel *chp,
            CH_CHANGE_TYPE notify_type,
            bool verify_tied_values = true);

    ~CH_BatchModifyScope()
    {
        finish();
    }

    UT_NON_COPYABLE(CH_BatchModifyScope)

    // If you call setChannelStart(), then it needs to adjust everything,
    // so the adjust range will be ignored.
    void setChannelStart(fpreal new_global_start)
    {
        myChannelStart = new_global_start;
        myChannelStartChanged = true;
    }
    // Only used if setChannelStart() has not been called
    void setAdjustRange(int beg, int end)
    {
        myAdjustBeg = beg;
        myAdjustEnd = end;
    }

    void deferredSmoothAutoSlopes(
            fpreal global_time, fpreal delta, bool value_changed)
    {
        mySmoothAutoSlopes.emplace_back(global_time, delta, value_changed);
    }

    void finish();

private:
    // Do all pending smooth auto slopes. This is a modified version of
    // CH_Channel::smoothAutoSlopes(fpreal, fpreal, bool) which does the
    // same thing for one key.
    void smoothAutoSlopes();

    CH_Channel *    myCh;
    CH_CHANGE_TYPE  myNotifyType;
    UT_Array<std::tuple<fpreal, fpreal, bool>> mySmoothAutoSlopes;
    int             myAdjustBeg;
    int             myAdjustEnd;
    fpreal          myChannelStart;
    bool            myChannelStartChanged;
#if (UT_ASSERT_LEVEL >= UT_ASSERT_LEVEL_PARANOID)
    bool            myVerifyTiedValues;
#endif
};

#endif