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

#ifndef __HOM_NodeType_h__
#define __HOM_NodeType_h__

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

class HOM_HDADefinition;
class HOM_HDAModule;
class HOM_HDAViewerHandleModule;
class HOM_HDAViewerStateModule;
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__() = 0;
    virtual std::string __repr__() = 0;

    virtual HOM_NodeTypeCategory &category() = 0;

    virtual std::string name() = 0;
    virtual std::vector<std::string> nameComponents() = 0;
    virtual std::string description() = 0;
    virtual std::string nameWithCategory() = 0;
    virtual std::vector<std::string> namespaceOrder() = 0;

    virtual std::string icon() = 0;
    virtual int minNumInputs() = 0;
    virtual int maxNumInputs() = 0;
    virtual int maxNumOutputs() = 0;

    virtual bool isGenerator() = 0;
    virtual bool isManager(bool include_management_types=true) = 0;
    virtual bool hasUnorderedInputs() = 0;
    virtual bool hasEditableInputData() = 0;

    virtual std::vector<HOM_ElemPtr<HOM_ParmTemplate> > parmTemplates() = 0;
    SWIGOUT(%newobject parmTemplateGroup;)
    virtual HOM_ParmTemplateGroup *parmTemplateGroup() = 0;

    virtual bool hasPermanentUserDefaults() = 0;

    virtual bool isReadable() = 0;
    virtual bool isWritable() = 0;
    virtual bool areContentsViewable() = 0;
    
    virtual std::vector<std::string> containedNodeTypes() = 0;
    virtual HOM_NodeTypeCategory *childTypeCategory() = 0;

    virtual std::string helpUrl() = 0;
    virtual std::string defaultHelpUrl() = 0;
    virtual std::string embeddedHelp() = 0;

    virtual std::string defaultShape() = 0;
    virtual void setDefaultShape(const char *shape) = 0;
    virtual HOM_Color defaultColor() = 0;
    virtual void setDefaultColor(HOM_Color *color) = 0;
};

#endif