HOM/HOM_NodeTypeCategory.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_NodeTypeCategory_h__
#define __HOM_NodeTypeCategory_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_EnumValue.h"
#include "HOM_ElemPtr.h"
#include <map>

class HOM_NodeType;
class HOM_ViewerState;

SWIGOUT(%rename(NodeTypeCategory) HOM_NodeTypeCategory;)

class HOM_API HOM_NodeTypeCategory
{
public:
    virtual ~HOM_NodeTypeCategory()
    {}

    // Because the only instances of NodeTypeCategory objects are the ones
    // created by the HOM_Module::*NodeTypeCategory() methods, the comparison
    // operators can just compare pointers.
    bool operator==(HOM_NodeTypeCategory &category)
    { return this == &category; }

    bool operator!=(HOM_NodeTypeCategory &category)
    { return this != &category; }


    virtual int __hash__() throw(HOM_Error) = 0;
    virtual std::string __repr__() throw(HOM_Error) = 0;

    virtual std::string name()
        throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "nodeTypes(self) -> dict of strings to NodeTypes") nodeTypes;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_NodeType> > nodeTypes()
        throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "viewerStates(self, viewer_type) -> tuple of ViewerStates")
        viewerStates;)
    virtual std::vector<HOM_ElemPtr<HOM_ViewerState> > viewerStates(
                                                HOM_EnumValue &viewer_type)
        throw(HOM_TypeError, HOM_Error) = 0;

    virtual void loadDSO(const char *dso_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;
};

#endif

---