LOP_LayerCheckpoints.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:        LOP_LayerCheckpoints.h (LOP Library, C++)
 *
 * COMMENTS:    Data structure for managing checkpoints in LOP cooks.
 */

#ifndef __LOP_LayerCheckpoints_h__
#define __LOP_LayerCheckpoints_h__

#include "LOP_API.h"
#include <HUSD/HUSD_DataHandle.h>
#include <HUSD/HUSD_LayerCheckpoint.h>
#include <DEP/DEP_MicroNode.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_UniquePtr.h>

class OP_Context;
class LOP_Node;
class LOP_LayerCheckpoints;

class LOP_API LOP_CheckpointMicroNode : public DEP_MicroNode
{
public:
                         LOP_CheckpointMicroNode(LOP_LayerCheckpoints &owner);
                        ~LOP_CheckpointMicroNode() override;

    void                 becameDirty(DEP_MicroNode &src,
                                const DEP_PropagateData &propdata) override;

private:
    LOP_LayerCheckpoints &myOwner;
};

class LOP_API LOP_LayerCheckpoints
{
public:
                         LOP_LayerCheckpoints(LOP_Node &owner);
                        ~LOP_LayerCheckpoints();

    void                 ownerInputRewired();
    void                 clearIfUpdateRequired(const OP_Context &context);
    void                 setClearCheckpointsOnInputChange(bool clear);

    void                 createCheckpoint(const HUSD_AutoAnyLock &lock,
                                const UT_StringHolder &id);
    void                 removeCheckpoint(const UT_StringRef &id);
    void                 clear();

    void                 getAvailableCheckpoints(UT_StringArray &ids) const;
    bool                 restoreCheckpoint(const HUSD_AutoLayerLock &layerlock,
                                const UT_StringRef &id) const;

private:
    void                 addInterestInInputDataChange();
    void                 removeInterestInInputDataChange();

    typedef UT_StringMap<HUSD_LayerCheckpoint> CheckpointMap;

    UT_UniquePtr<CheckpointMap>      myCheckpoints;
    LOP_Node                        &myOwner;
    LOP_CheckpointMicroNode          myMicroNode;
    bool                             myClearCheckpointsOnInputDataChange;
};

#endif