HOM/HOM_NodeType.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
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_NodeType_h__
#define __HOM_NodeType_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_EnumValue.h"
#include "HOM_Module.h"
#include "HOM_ParmTemplate.h"
#include "HOM_PtrOrNull.h"
#include <string>

class HOM_HDADefinition;
class HOM_HDAModule;
class HOM_NodeTypeCategory;
class HOM_ParmTemplateGroup;

SWIGOUT(%rename(NodeType) HOM_NodeType;)

class HOM_API HOM_NodeType
{
public:
    HOM_NodeType()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_NodeType(const HOM_NodeType &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_NodeType()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual bool operator==(HOM_PtrOrNull<HOM_NodeType> node_type) = 0;
    virtual bool operator!=(HOM_PtrOrNull<HOM_NodeType> node_type) = 0;

    virtual int __hash__() throw(HOM_Error) = 0;

    virtual std::string __repr__() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual HOM_NodeTypeCategory &category()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string name()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string description()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string nameWithCategory()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual HOM_EnumValue &source()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string sourcePath()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject sourceNetwork;)
    virtual HOM_Node *sourceNetwork()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject definition;)
    virtual HOM_HDADefinition *definition()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<HOM_ElemPtr<HOM_HDADefinition> >
        allInstalledDefinitions() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string icon()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual int minNumInputs()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual int maxNumInputs()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual int maxNumOutputs()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    // generatorFlag() is deprecated in favour of isGenerator().
    virtual bool isGenerator()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    bool generatorFlag()
        throw(HOM_ObjectWasDeleted, HOM_Error)
    { return isGenerator(); }

    // managerFlag() is deprecated in favour of isManager().
    virtual bool isManager()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    bool managerFlag()
        throw(HOM_ObjectWasDeleted, HOM_Error)
    { return isManager(); }

    // unorderedInputsFlag() is deprecated in favour of hasUnorderedInputs().
    virtual bool hasUnorderedInputs()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    bool unorderedInputsFlag()
        throw(HOM_ObjectWasDeleted, HOM_Error)
    { return hasUnorderedInputs(); }

    virtual std::vector<std::string> aliases()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void addAlias(const char *alias)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
    virtual void removeAlias(const char *alias)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    virtual bool hidden()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setHidden(bool hidden)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<HOM_ElemPtr<HOM_Node> > instances()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<HOM_ElemPtr<HOM_ParmTemplate> > parmTemplates()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject parmTemplateGroup;)
    virtual HOM_ParmTemplateGroup *parmTemplateGroup()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void uninstallFromPath(const char *path)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

    SWIGOUT(%newobject hdaModule;)
    virtual HOM_HDAModule *hdaModule()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool hasPermanentUserDefaults()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void *_asVoidPointer()
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 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

---