OP_Channels.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_Channels.h (C++)
 *
 * COMMENTS:    OP_Channels is a channel collection used by an OP_Node
 *              object. This class implements the pure virtuals defined
 *              in CH_Collection to access local variables and the channel
 *              collection hierarchy.
 *
 *              there are two uses of this class
 *              1: as a channel holder for each OP_Node
 *              2: as a channel holder to do copying and pasting
 *
 *              appropriate methods/variables are marked accordingly
 *              this should be two or three classes maybe, but there is no
 *              reason to do this now.
 *
 */

#ifndef __OP_Channels__
#define __OP_Channels__

#include "OP_API.h"
#include <CH/CH_Collection.h>
#include <CH/CH_EventManager.h>
#include <CH/CH_Types.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>


class OP_Node;
class CH_Channel;
class CH_LocalVariable;
class CH_Manager;
class UT_String;
class UT_XformOrder;


class OP_API OP_Channels : public CH_Collection
{
public:
             OP_Channels(OP_Node *owner, CH_Manager *chman,
                         CH_LocalVariable *vars);
            ~OP_Channels() override;

    int64                getMemoryUsage(bool inclusive) const override;

    // PATH/ID RELATED (1)
    // these functions rely on the one-to-one mapping between
    // OP_Node and OP_Channels
    const UT_String     &getName() const override;

    int                  getUniqueId() const override;
    CH_Collection *      lookupCollection(int id) const override;

    const CH_Collection *getParent() const override;
          CH_Collection *getParent() override;
    const CH_Collection *getChild(const char *name) const override;
          CH_Collection *getChild(const char *name) override;
    const void          *getOwner() const override;
    void                *getOwner() override;

    int                  getChildren(CH_NameList &names) const override;
    int                  getChildren(CH_CollectionList &grps) const override;

    UT_StringHolder      getFullPath() const override;
    CH_Collection       *findCollection(const char *name) const override;

    // EVENTS (1)
    virtual void         setChanged(CH_CHANGE_TYPE how, void *data=0) override;

    // CHANNEL EVALUATION (1 & 2)
    OP_Node             *getNode() const { return myOwner; }
    void                 setNode(OP_Node *new_owner);

    bool                 getVariableValue(fpreal &val, int table, int index,
                                          int thread) override;
    bool                 getVariableValue(UT_String &str, int table, int index,
                                          int thread) override;

    enum { OP_VARIABLE_TABLE_INDEX = 4 };

    const CH_LocalVariable *resolveVariable(const char *name,
                                            int &tab) override;
    const CH_LocalVariable *resolveExtraVariableForSyntaxHighlight(
                                                            const char *name);

    void                 getXformOrder(UT_XformOrder &xord,
                                       const CH_Channel *chp) const override;

    // CHANNEL BUFFER STUFF (2)
    // this sets the node so that contained channels can evaluate channel
    // references as if they are in the same node as target
    void                 setTargetChannel( const CH_Channel *target ) const;

    // UTILITIES (1)
    int                  canAccess(unsigned mask) const override;
    int                  canAccessChannel(uint mask,
                                          const CH_Channel *chp) const override;
    void                 saveKeyFrameForUndo(CH_Channel *chp,
                                             fpreal gtime) override;
    void                 saveChannelForUndo(CH_Channel *chp) override;

    void                 addLocalVarDependency(int table, int index,
                                               void *ref_id) override;

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

protected:

    void                 notifyChannelRenameDependents(
                                const char *old_name,
                                const char *new_name) override;

private:
    OP_Node                     *myOwner;       // (1 & 2)
};

#endif