OP/OP_Input.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:
 *      Side Effects Software Inc.
 *      477 Richmond St. West
 *      Toronto, Ontario,  M5V 3E7
 *      Canada
 *      416-504-9876
 *
 * NAME:        OP_Input.h (C++)
 *
 * COMMENTS:
 *
 */

#ifndef _OP_Input_h_
#define _OP_Input_h_

#include "OP_API.h"
#include <UT/UT_Defines.h>
#include <UT/UT_String.h>

class OP_Node;
class OP_Network;
class OP_InputIndirect;

class OP_API OP_Input
{
public:
             OP_Input(OP_Node *owner);
    virtual ~OP_Input();

    virtual int          save(ostream &os, int bin);
    virtual bool         load(UT_IStream &is, const char *path=0);

    // Convert our input string to an actual pointer again
    void                 resolveReference();

    const char *         getNodeReference() const { return myNodeReference; }

    //  Get the Node that this input refers to.  May return NULL
    OP_Node             *getNode();
    unsigned             getNodeOutputIndex();

    //  Check for a null input reference:
    int                  isNull() const;
    int                  isIndirect() const  { return myIndirectFlag; }
    OP_InputIndirect    *getIndirect();

    virtual int64        getMemUsage(UT_Bool onlythis) const;

protected:

    //  Wire the input
    void                 setInput(OP_Node *myNode, unsigned outputIdx);
    void                 setInputReference(const char *label,
                                           unsigned outputIdx);

    //  Take care of the input's forward link when attaching inputs
    virtual void         setMyNode(OP_Node *input_node, unsigned outputIdx);

    OP_Node             *myNode;
    OP_Node             *myOwner;
    unsigned             myNodeOutputIdx;

    //  Friends
    friend class        OP_Node;

    friend ostream      &operator<<(ostream &os, OP_Input &d)
                        {
                            d.save(os, 0);
                            return os;
                        }
private:
    void                 setIndirectInput(OP_InputIndirect *input);

    OP_InputIndirect    *myIndirectInput;
    char                *myNodeReference;

    unsigned             myIndirectFlag:1,
                         extra:31;              // unused, should sum to 32
};

#endif

---