CHOP/CHOP_OutputClipManager.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:
 *      Ondrej Kos
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        CHOP_OutputClipManager.h ( Channel Operator Library, C++)
 *
 * COMMENTS:
 */

#ifndef __CHOP_OutputClipManager__
#define __CHOP_OutputClipManager__

#include "CHOP_API.h"
#include <UT/UT_SymbolTable.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_String.h>

class CHOP_API CHOP_CacheEntry
{
public:
    CHOP_CacheEntry()
    {
        myRefCount = 1;
        myCacheIndex = -1;
        myRealtimeIndex = -1;
        myLocalIndex = -1;
        myInitialOutput = 0;
        myUseCount = 0;
    }

    int          myRefCount;
    int          myUseCount;

    int          myCacheIndex;
    int          myRealtimeIndex;
    int          myLocalIndex;

    int          myInitialOutput;
    UT_String    myName;
};

class CHOP_API CHOP_OutputClipManager
{
public:
    CHOP_OutputClipManager();
    ~CHOP_OutputClipManager();

    void                        addReference(const char *name, 
                                             int realtime = 0);
    int                         isReferenced(const char *name);

    // Methods to query the various indices
    int                         getCacheIndex(const char *name) const;
    int                         getRealtimeIndex(const char *name) const;
    int                         getLocalIndex(const char *name) const;

    // These methods depend on existing entries
    int                         getOutput(const char *name) const;
    void                        setOutput(const char *name) const;

    int                         useInput(const char *name) const;
    int                         canClearClip(const char *name) const;

    void                        needLocal(const char *name);

    unsigned int                getCacheCount() const { return myCacheCount; }
    unsigned int                getRealtimeCount() const 
                                    { return myRealtimeCount; }
    unsigned int                getLocalCount() const { return myLocalCount; }
    UT_PtrArray<CHOP_CacheEntry *> &getCacheList() { return myCacheList; }

    unsigned int                getMaxInputs() const { return myMaxInputs; }
    void                        updateMaxInputs(unsigned int n)
                                {
                                    if (n > myMaxInputs)
                                        myMaxInputs = n;
                                }
    void                        addParam(const char *name);
    int                         getNumParams() const 
                                { return myCacheParamList.entries(); }
    CHOP_CacheEntry             *getParam(int idx) const
                                { return myCacheParamList(idx); }
    
private:
    UT_SymbolTable                      myRefTable;
    unsigned int                        myCacheCount;
    unsigned int                        myRealtimeCount;
    unsigned int                        myLocalCount;
    UT_PtrArray<CHOP_CacheEntry *>      myCacheList;
    UT_PtrArray<CHOP_CacheEntry *>      myCacheParamList;
    unsigned int                        myMaxInputs;
};

#endif

---