OP/OP_PropagateData.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:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        OP_PropagateData.h (OP Library, C++)
 *
 * COMMENTS:    Helper class for OP_Node::propagateModification()
 */

#ifndef __OP_PROPAGATEDATA_H__
#define __OP_PROPAGATEDATA_H__

#include "OP_API.h"
#include "OP_Value.h"
#include <UT/UT_Algorithm.h>
#include <UT/UT_Pair.h>

// This helper struct is needed for propagateModification(). It must be
// initialized first with beginPropagateModification().
class OP_API OP_PropagateData
{
public:
    OP_PropagateData(OP_EventType reason)
        : myCounter(0)
        , myParmCycle()
    {
        myExprChange = isExprChangeEvent(reason);
    }

    void    setCounter(int counter)
                { myCounter = counter; }
    int     getCounter() const
                { return myCounter; }

    bool    detectParmCycle(int node_id, int parm_idx)
                { return myParmCycle.detect(UT_IntPair(node_id, parm_idx)); }
    void    resetParmCycle()
                { myParmCycle.reset(); }

    void    setExprChange(bool expr_change)
                { myExprChange = expr_change; }
    bool    isExprChange() const
                { return myExprChange; }

    static bool isExprChangeEvent(OP_EventType reason)
                {
                    return (reason == OP_PARM_ANIMATED
                            || reason == OP_PARM_CHANNELS);
                }

private:    // non-implemented methods
    OP_PropagateData();
    OP_PropagateData(const OP_PropagateData &);
    OP_PropagateData &operator =(const OP_PropagateData &);

private:    // data
    long                        myCounter;      // modification counter
    UT_CycleDetect<UT_IntPair>  myParmCycle;    // parm recursion check
    bool                        myExprChange:1; // a parm expr modification?
};

#endif // __OP_PROPAGATEDATA_H__

---