COP_SlapcompRegistry.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.
 *
 * COMMENTS:    Global registry of the last slapcomps.
 *
 */

#pragma once

#include "COP_API.h"

#include "COP_Signature.h"

#include <IMX/IMX_Layer.h>
#include <UT/UT_Lock.h>

class cop_RegistryHolder;

///
/// Stores slap comp layers for other nodes to possibly retrieve
/// Currently only one path, ideally will allow multiple viewport
/// simultaneously.
///
class COP_API COP_SlapcompRegistry
{
private:
    struct PrivateConstructorKey {};
    friend class cop_RegistryHolder;

public:
    class                       AovInfo
    {
    public:
        UT_StringHolder         name;
        COP_Type                type = COP_TYPE_UNDEF;
    };

    static IMX_LayerConstPtr    fetchLayer(const char *aov);
    static void                 stashLayer(const UT_StringHolder &aov,
                                           IMX_LayerConstPtr layer);

    static void                 registerNode(const OP_Node *node,
                                             const UT_StringSet &aovs);
    static void                 deregisterNode(const OP_Node *node);
    static void                 notifyNodes();

    static void                 registerViewerAOVs(const UT_Array<AovInfo> &aovs);

    /// Populate aovs with all aovs requested by any live
    /// import.
    static void                 activeAOVs(UT_StringSet &aovs);

    /// List of AOVs last submitted by a viewer
    /// import.
    static void                 viewerAOVs(UT_Array<AovInfo> &aovs);

    static void                 clear();

    COP_SlapcompRegistry(PrivateConstructorKey);

protected:
    static COP_SlapcompRegistry *getRegistry();

    IMX_LayerConstPtr            _fetchLayer(const char *aov);
    void                         _stashLayer(const UT_StringHolder &aov,
                                             IMX_LayerConstPtr layer);
    void                         _clear();
    void                         _registerNode(const OP_Node *node,
                                               const UT_StringSet &aovs);
    void                         _deregisterNode(const OP_Node *node);
    void                         _notifyNodes();

    void                         _registerViewerAOVs(const UT_Array<AovInfo> &aovs);
    void                         _activeAOVs(UT_StringSet &aovs);
    void                         _viewerAOVs(UT_Array<AovInfo> &aovs);

    UT_Lock                     myLock;
    UT_Map<int, UT_SharedPtr<UT_StringSet>> myOpNodes;
    UT_StringMap<IMX_LayerConstPtr>     myLayers;
    UT_Array<AovInfo>           myViewerAOVs;
    exint                       myVersion = 0;
    exint                       myNotifyVersion = 0;
};