GT_MaterialNode.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:        GT_MaterialNode.h ( GT Library, C++)
 *
 * COMMENTS:
 */
#ifndef __GT_MaterialNode__
#define __GT_MaterialNode__

#include "GT_API.h"

#include <UT/UT_IntrusivePtr.h>
#include <UT/UT_Options.h>
#include <UT/UT_Set.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_VectorTypes.h>

class UT_TokenString;

class GT_MaterialNode;
typedef UT_IntrusivePtr<GT_MaterialNode> GT_MaterialNodePtr;

/// An shallow abstraction of a shader node network
class GT_API GT_MaterialNode : public UT_IntrusiveRefCounter<GT_MaterialNode>
{
public:
    GT_MaterialNode() { }
    GT_MaterialNode(const UT_StringRef &nodetype, int64 index);
    GT_MaterialNode(const GT_MaterialNode &src)
        : UT_IntrusiveRefCounter<GT_MaterialNode>() { *this = src; }
    GT_MaterialNode &operator=(const GT_MaterialNode &src);

    // Actual name of the node
    void setName(const UT_StringRef &name) { myName = name; }
    // Simple name (n#) for shader references
    void setTokenName(const UT_StringRef &name) { myToken = name; }

    void addInput(const UT_StringRef &input_name,
                  const UT_StringRef &output_name,
                  const GT_MaterialNodePtr &node);
    void addOutputVar(const UT_StringRef &output, const UT_StringRef &varname);
    void clearOutputVars();

    void copyParms(const GT_MaterialNodePtr &mat_node,
                   UT_Set<int> &visited);

    const UT_StringRef    &name() const  { return myName; }
    const UT_StringRef    &token() const { return myToken; }
    const UT_StringHolder &type() const  { return myTypeName; }
    UT_Options            &parms()       { return myParms; }
    const UT_Options      &parms() const { return myParms; }
    
    const UT_StringMap<std::pair<GT_MaterialNodePtr, UT_StringHolder> > &
                          inputs() const { return myInputs; }
    
    GT_MaterialNodePtr  getInput(const UT_StringRef &name) const;
    const UT_StringRef &getInputOutputName(const UT_StringRef &name) const;
    int                 getInputOutputType(const UT_StringRef &name) const;
    int                 getInputOutputIndex(const UT_StringRef &name) const;
    const UT_StringRef &getOutputVar(const UT_StringRef &output) const;

    bool                isTimeDependent(bool inputs_too = true) const;
    void                setTimeDependent(bool time_dep) { myTimeDep = time_dep; }
    
    static void addNodeDefaults(const UT_StringRef &nodetype_name,
                                const UT_Options &parm_defaults,
                                const UT_StringMap<UT_Vector2i> &outputs,
                                const UT_StringArray &textures);
    static bool addExtraParms(const UT_StringRef &nodetype_name,
                              const UT_Options &extra_parms);

    static bool nodeTypeExists(const UT_StringRef &nodetype_name);

    static const UT_StringMap<UT_Vector2i> &
                                 getNodeOutputs(const UT_StringRef &nodetype);
    static const UT_StringArray &getNodeTextures(const UT_StringRef &nodetype);

    // Returns true if the network structure is the same as the network with
    // root 'node'
    bool        networkMatch(const GT_MaterialNode *node,
                             UT_Set<int> &visited) const;
    void        copyNameToken(const GT_MaterialNode *node,
                              UT_Set<int> &visited);

    int64       index() const { return myIndex; }
    int64       uniqueId() const { return myID; }

    void createUniqueString(UT_TokenString &ts, UT_Set<int> &visited) const;

    void print();
    
private:
    void internalPrint(UT_Set<int64> &visited);
    
    UT_StringMap<std::pair<GT_MaterialNodePtr, UT_StringHolder> > myInputs;
    UT_StringMap<UT_StringHolder> myOutputVars;
    UT_Options myParms;
    UT_StringHolder myTypeName;
    UT_StringHolder myName;
    UT_StringHolder myToken;
    int64           myID;
    int64           myIndex = 0;
    bool            myTimeDep  = false;
};


#endif