HOM_OpNodeType.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.
 *
 * COMMENTS:
 */

#ifndef __HOM_OpNodeType_h__
#define __HOM_OpNodeType_h__

#include "HOM_API.h"
#include "HOM_NodeType.h"

SWIGOUT(%rename(OpNodeType) HOM_OpNodeType;)

class HOM_API HOM_OpNodeType : public HOM_NodeType
{
public:
    HOM_OpNodeType()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_OpNodeType(const HOM_OpNodeType &type)
        : HOM_NodeType(type)
    { HOM_CONSTRUCT_OBJECT(this) }
    ~HOM_OpNodeType() override
    { HOM_DESTRUCT_OBJECT(this) }

    int __hash__() override = 0;
    std::string __repr__() override = 0;

    virtual std::string sectionData(const char *name) = 0;
    virtual HOM_BinaryString binarySectionData(const char *name) = 0;
    virtual bool hasSectionData(const char *name) = 0;

    virtual HOM_EnumValue &source() = 0;
    virtual std::string sourcePath() = 0;

    SWIGOUT(%newobject sourceNetwork;)
    virtual HOM_Node *sourceNetwork() = 0;

    SWIGOUT(%newobject definition;)
    virtual HOM_HDADefinition *definition() = 0;

    virtual std::vector<HOM_ElemPtr<HOM_HDADefinition> >
        allInstalledDefinitions() = 0;

    virtual void uninstallFromPath(const char *path) = 0;

    SWIGOUT(%newobject hdaModule;)
    virtual HOM_HDAModule *hdaModule() = 0;
    SWIGOUT(%newobject hdaViewerStateModule;)
    virtual HOM_HDAViewerStateModule *hdaViewerStateModule() = 0;
    SWIGOUT(%newobject hdaViewerHandleModule;)
    virtual HOM_HDAViewerHandleModule *hdaViewerHandleModule() = 0;

    virtual std::vector<std::string> aliases() = 0;
    virtual void addAlias(const char *alias) = 0;
    virtual void removeAlias(const char *alias) = 0;
    virtual bool hidden() = 0;
    virtual void setHidden(bool hidden) = 0;
    virtual bool deprecated() = 0;
    virtual std::map<std::string, hboost::any> deprecationInfo() = 0;

    virtual std::vector<HOM_ElemPtr<HOM_Node> > instances() = 0;

    // This method was implemented for the experimental edit optype parms
    // workflow that is currently disabled.
    SWIGOUT(%ignore reloadParmTemplates;)
    virtual void reloadParmTemplates() = 0;

    // This method was implemented for the experimental edit optype parms
    // workflow that is currently disabled.
    SWIGOUT(%ignore baseParmTemplateGroup;)
    SWIGOUT(%newobject baseParmTemplateGroup;)
    virtual HOM_ParmTemplateGroup *baseParmTemplateGroup() = 0;

    // Return the name of the default viewer state for this node type.
    virtual std::string defaultState() = 0;

    // generatorFlag() is deprecated in favour of isGenerator().
    bool generatorFlag()
    { return isGenerator(); }
    // managerFlag() is deprecated in favour of isManager().
    SWIGOUT(%kwargs isManager);
    bool managerFlag()
    { return isManager(); }
    // unorderedInputsFlag() is deprecated in favour of hasUnorderedInputs().
    bool unorderedInputsFlag()
    { return hasUnorderedInputs(); }

    virtual void *_asVoidPointer() = 0;

    // We need a quick way to get the OP_OpTypeId from C++ code so we know
    // which subclass of HOM_NodeType we should cast to, so that's why
    // opTypeIdAsInt() exists.
    SWIGOUT(%ignore opTypeIdAsInt;)
    virtual int opTypeIdAsInt() = 0;
};

#endif