OP_SubnetIndirectInput.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_SubnetIndirectInput.h (C++)
 *
 * COMMENTS: OP_SubnetIndirectInput is used to maintain an indirect input
 *      for a sub-network. The input is a reference to one
 *      of the inputs to the owner of this node. The owner will be
 *      the sub-net.
 */

#ifndef _OP_SubnetIndirectInput_h_
#define _OP_SubnetIndirectInput_h_

#include "OP_API.h"
#include "OP_IndirectInput.h"
#include <iosfwd>

class OP_API OP_SubnetIndirectInput : public OP_IndirectInput
{
public:
    OP_ItemType          getItemType() const override
                         { return OP_ITEMTYPE_INDIRECT; }
    fpreal               getW() const override
                         { return 0.8; }
    fpreal               getH() const override
                         { return 0.3; }
    const UT_String     &getItemName() const override;
    bool                 setItemName(const UT_String &name) override;

    OP_NetworkBoxItem   *getInputItem() const override;
    int                  getInputItemOutputIndex() const override;

    int                  getInputIndex() const
                         { return myInputIndex; }

    // Functions to get hip-file-unique ids for any item type.
    static OP_SubnetIndirectInput *lookupSubnetIndirectInput(int64 unique_id);
    int64                getUniqueId() const;
    int64                getItemUniqueId() const override
                         { return getUniqueId(); } 

    // Return the amount of memory owned by this OP_SubnetIndirectInput
    int64                getMemoryUsage(bool inclusive) const
    {
        int64 mem = inclusive ? sizeof(*this) : 0;
        mem += OP_IndirectInput::getMemoryUsage(false);
        return mem;
    }

private:
                         OP_SubnetIndirectInput(OP_Network &owner,
                                 int input_index);
                        ~OP_SubnetIndirectInput() override;

    void                 initFromSubnetIndirect(
                                const OP_SubnetIndirectInput &src);
    int                  save(std::ostream &os) const;
    bool                 load(UT_IStream &is);

    short                myInputIndex;
    UT_String            myName;

    friend class         OP_Network;
};

#endif