OP_GeometryChannels.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:        OP_GeometryChannels.h (C++)
 *
 * COMMENTS:    OP_GeometryChannels is a channel collection used to
 *              store external channels collections which were created
 *              from geometry channels (channel primitives).
 *              This is used in order to scope geometry channels
 *              so that they appear in the global channel list, and can
 *              be modified in the animation editor, main playbar, etc.
 *              Geometry channel collections:
 *              - do not have a unique id: getUniqueId() returns -1
 *              - are always flagged as external
 *              - never have an owner node
 *                 - relations between geometry channels and nodes are
 *                   instead handled by the MOT_GeometryChannelsManager
 */

#ifndef __OP_GeometryChannels__
#define __OP_GeometryChannels__

#include "OP_API.h"
#include "OP_Channels.h"
#include "OP_Types.h"

#include <CH/CH_ChannelRef.h>

#include <UT/UT_Map.h>
#include <UT/UT_Function.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_Set.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>

class CH_Channel;
class CH_LocalVariable;
class CH_Manager;
class PRM_ParmList;
class PRM_PresetInfo;
class PRM_Template;
class PRM_Name;
class UT_String;

class OP_API OP_GeometryChannels : public OP_Channels
{
public:
             OP_GeometryChannels(const UT_StringHolder &name, CH_Manager *chman,
                         CH_LocalVariable *vars);

             ~OP_GeometryChannels() override;

             UT_NON_COPYABLE(OP_GeometryChannels);

    int64                getMemoryUsage(bool inclusive) const override;

    /// Returns the name of this collection. OP_GeometryChannels stores
    /// its own name, which is returned here. This overrides the behaviour
    /// of OP_Channels, where the name of the collection is the name of the
    /// associated node.
    const UT_String     &getName() const override { return myName; }
    UT_StringHolder      getFullPath() const override { return myName; }

    OP_Channels         *castToOPChannels() override { return static_cast<OP_Channels *>(this); }
    const OP_Channels   *castToOPChannels() const override { return static_cast<const OP_Channels *>(this); }

    int addChannelsChangedCallback(OP_GeometryChannelsChangedCallback callback);
    void removeChannelsChangedCallback(int id);

    void setChanged(CH_CHANGE_TYPE how, void *data = nullptr) override;

    void notifyActiveChannelChanges();
    void notifyFinishedChannelChanges();

    void createParmList(void (*handler)(void *, CH_CHANGE_TYPE, int));
    void destroyParmList();
    PRM_ParmList *getParmList() const { return myParmList.get(); }

    void saveKeyFrameForUndo(CH_Channel *chp, fpreal gtime) override;
    void saveForUndo(CH_Channel *chp);

    static void clearAllPendingUndoFlags();

    void clearCallbacks() { myCallbacks.clear(); }

private:
    void handleChannelChanged(CH_Channel *channel);

    static int theNextChannelsChangedCallbackId;
    static UT_StringArray theUndoPendingQueue;

    UT_Set<CH_ChannelRef> myChangedChannels;
    UT_Set<CH_Channel *> myActiveChangedChannels;

    UT_String myName;

    UT_Map<int, OP_GeometryChannelsChangedCallback> myCallbacks;

    UT_Array<PRM_Template> myParmTemplates;
    UT_Array<PRM_Name> myParmNames;
    UT_UniquePtr<PRM_PresetInfo> myPresetInfo;
    UT_UniquePtr<PRM_ParmList> myParmList;
};

#endif