PRM_ParmMicroNode.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:        PRM_ParmMicroNode.h (PRM Library, C++)
 *
 * COMMENTS:    DEP_MicroNode subclass representing a PRM_Parm component
 */

#ifndef __PRM_PARMMICRONODE_H_INCLUDED__
#define __PRM_PARMMICRONODE_H_INCLUDED__

#include "PRM_API.h"
#include <DEP/DEP_MicroNode.h>
#include <UT/UT_ValArray.h>
#include <SYS/SYS_Types.h>
#include <stddef.h>

class PRM_Parm;
class PRM_ParmMicroNode;


typedef UT_ValArray<PRM_ParmMicroNode *> PRM_ParmMicroNodeList;

class PRM_ParmMicroNode;

// PRM_ConstMicroNode is a simple micro node that is implicitly
// connected to a PRM_ParmMicroNode.
// It doesn't inherrit the time dependency from myParent because
// it's an implicit dependency.
class PRM_API PRM_ConstMicroNode : public DEP_MicroNode
{
public:
    PRM_ConstMicroNode(PRM_ParmMicroNode* p=nullptr)
        : myParent(p)
    {}

    const char *            className() const override
                                { return "PRM_ConstMicroNode"; }

    // Set the parent and adjust its myConstMicroNode to this.
    void init(PRM_ParmMicroNode* p);

    // Overloaded to return myParent.
    void getInputs(DEP_MicroNodeList &inputs) const override;

    int64   getMemoryUsage(bool inclusive) const override;
private:
    PRM_ParmMicroNode* myParent;
};

class PRM_API PRM_ParmMicroNode : public DEP_MicroNode
{
public:
                            PRM_ParmMicroNode()
                                : myParm(NULL)
                                , mySubIndex(-1)
                                , myConstMicroNode(nullptr)
                            {
                            }

                            PRM_ParmMicroNode(PRM_Parm &parm, int sub_index)
                            : myConstMicroNode(nullptr)
                            {
                                init(parm, sub_index);
                            }

    void                    init(PRM_Parm &parm, int sub_index);

    void                    clearInputs() override;

    const char *            className() const override
                                { return "PRM_ParmMicroNode"; }

    int64                   getMemoryUsage(bool inclusive) const override;

    void                    dump(
                                std::ostream &os,
                                const char *prefix = 0,
                                int indent_level = 0) const override;

    const PRM_Parm &        ownerParm() const
                                { return *myParm; }
    PRM_Parm &              ownerParm()
                                { return *myParm; }

    int                     parmIndex() const;
    int                     subIndex() const
                                { return mySubIndex; }

    // Overloaded to return myConstMicroNode implicitly.
    void                getOutputs(DEP_MicroNodeList &outputs) const override;

private:
    friend class PRM_ConstMicroNode;

    PRM_Parm *              myParm;
    int                     mySubIndex;

    // Optional const micronode not owned but this.
    // PRM_Instance creates the micronodes and updates this.
    PRM_ConstMicroNode      *myConstMicroNode;
};


#endif // __PRM_PARMMICRONODE_H_INCLUDED__